Metadata-Version: 2.1
Name: hpctoolkit-dataframe
Version: 0.1.0
Summary: operate on HPCtoolkit XML database files as pandas DataFrames
Home-page: https://mbdevpl.github.io/
Author: Mateusz Bysiek
Author-email: mb@mbdev.pl
Maintainer: Mateusz Bysiek
Maintainer-email: mb@mbdev.pl
License: Apache License 2.0
Download-URL: https://github.com/mbdevpl/hpctoolkit_dataframe
Keywords: hpc,high-performance computing,performance,profiling
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: ordered-set
Requires-Dist: pandas
Requires-Dist: version-query

.. role:: bash(code)
    :language: bash

.. role:: python(code)
    :language: python


====================
HPCtoolkit DataFrame
====================

.. image:: https://img.shields.io/pypi/v/hpctoolkit_dataframe.svg
    :target: https://pypi.org/project/hpctoolkit_dataframe
    :alt: package version from PyPI

.. image:: https://travis-ci.com/mbdevpl/hpctoolkit_dataframe.svg?branch=master
    :target: https://travis-ci.com/mbdevpl/hpctoolkit_dataframe
    :alt: build status from Travis CI

.. image:: https://ci.appveyor.com/api/projects/status/github/mbdevpl/hpctoolkit_dataframe?svg=true
    :target: https://ci.appveyor.com/project/mbdevpl/hpctoolkit_dataframe
    :alt: build status from AppVeyor

.. image:: https://codecov.io/gh/mbdevpl/hpctoolkit_dataframe/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/mbdevpl/hpctoolkit_dataframe
    :alt: test coverage from Codecov

.. image:: https://img.shields.io/github/license/mbdevpl/hpctoolkit_dataframe.svg
    :target: https://github.com/mbdevpl/hpctoolkit_dataframe/blob/master/NOTICE
    :alt: license

Operate on HPCtoolkit XML database files as pandas DataFrames.

.. contents::
    :backlinks: none


Usage
=====

Please see `examples.ipynb <https://github.com/mbdevpl/hpctoolkit_dataframe/blob/v0.1.0/examples.ipynb>`_ for details.


Installation
============

For simplest installation use :bash:`pip`:

.. code:: bash

    pip3 install hpctoolkit_dataframe


Requirements
------------

Python version 3.6 or later.

Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/hpctoolkit_dataframe/blob/v0.1.0/requirements.txt>`_.

Building and running tests additionally requires packages listed in `test_requirements.txt <https://github.com/mbdevpl/hpctoolkit_dataframe/blob/v0.1.0/test_requirements.txt>`_.

Tested on Linux, OS X and Windows.


Links
=====

-   HPCtoolkit: http://hpctoolkit.org/

-   `pandas.DataFrame`: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html


