Metadata-Version: 2.1
Name: hpctoolkit_dataframe
Version: 0.3.0
Summary: Operate on HPCtoolkit XML database files as pandas DataFrames.
Home-page: https://github.com/mbdevpl/hpctoolkit_dataframe
Download-URL: 
Author: Mateusz Bysiek
Author-email: mateusz.bysiek@gmail.com
Maintainer: Mateusz Bysiek
Maintainer-email: mateusz.bysiek@gmail.com
License: Apache License 2.0
Keywords: hpc,high-performance computing,performance,profiling
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 :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE
License-File: NOTICE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: ordered-set
Requires-Dist: pandas
Requires-Dist: version-query ~=1.5

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

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

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

Operate on HPCtoolkit XML database files as pandas DataFrames.

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

.. image:: https://github.com/mbdevpl/hpctoolkit_dataframe/actions/workflows/python.yml/badge.svg?branch=main
    :target: https://github.com/mbdevpl/hpctoolkit_dataframe/actions
    :alt: build status from GitHub

.. 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://api.codacy.com/project/badge/Grade/fff0555067d34db08d22df30305dee1b
    :target: https://app.codacy.com/gh/mbdevpl/hpctoolkit_dataframe
    :alt: grade from Codacy

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

Database files generated by HPCtoolkit can be read by the GUI-based tools provided by developers of
HPCtoolkit. However, programmatic access and analysis of such files is troublesome.

This library provides an HPCtoolkitDataFrame object, which is essentially a pandas DataFrame
and can be queried and sliced as easily as any DataFrame. But it extends this functionality with
methods for analysis and visualisation of performance data.

.. contents::
    :backlinks: none

Usage
=====

Please see `<examples.ipynb>`_ for details.

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

For simplest installation use :bash:`pip`:

.. code:: bash

    pip3 install hpctoolkit_dataframe

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

Python version 3.8 or later.

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

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

Tested on Linux, macOS and Windows.

Links
=====

-   HPCtoolkit: http://hpctoolkit.org/

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