An open API service indexing awesome lists of open source software.

https://github.com/mbdevpl/hpctoolkit_dataframe

Operate on HPCtoolkit XML database files as pandas DataFrames.
https://github.com/mbdevpl/hpctoolkit_dataframe

high-performance-computing hpc performance profiling

Last synced: 8 months ago
JSON representation

Operate on HPCtoolkit XML database files as pandas DataFrames.

Awesome Lists containing this project

README

          

.. 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/main/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: 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 ``_ 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 ``_.

Building and running tests additionally requires packages listed in ``_.

Tested on Linux, macOS and Windows.

Links
=====

- HPCtoolkit: http://hpctoolkit.org/

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