Python tools to interact with darshan log records of HPC applications.
Project description
Python utilities to interact with Darshan log records of HPC applications. PyDarshan requires darshan-utils version 3.3 or higher to be installed.
Features
Darshan Report Object for common interactive analysis tasks
Low-level CFFI bindings for efficient access to darshan log files
Common plots typically found in the darshan reports (matplotlib)
Bundled with darshan-utils while allowing site’s darshan-utils to take precedence
Usage
For examples and Jupyter notebooks to get started with pydarshan make sure to check out the examples subdirectory.
A brief examples showing some of the basic functionality is the following:
import darshan # Open darshan log report = darshan.DarshanReport('example.darshan', read_all=False) # Load some report data report.mod_read_all_records('POSIX') report.mod_read_all_records('MPI-IO') # or fetch all report.read_all_generic_records() # ... # Generate summaries for currently loaded data # Note: aggregations are still experimental and have to be activated: darshan.enable_experimental() report.summarize()
Installation
To install in most cases the following will work:
pip install --user darshan
For alternative installation instructions and installation from source refer to <docs/install.rst>
Testing
Targets for various tests are included in the makefile. To run the normal test suite use:
make test
Or to test against different version of Python using Tox:
make test-all
Coverage tests can be performed using:
make coverage
Conformance to PEPs can be tested using flake8 via:
make lint
Documentation
Documentation for the python bindings is generated seperatedly from the darshan-utils C library in the interest of using Sphinx. After installing the developement requirements using pip install -r requirements_dev.txt the documentation can be build using make as follows:
pip install -r requirements_dev.txt make docs
File List
- darshan::
core darshan python module code
- devel::
scripts for building python wheel
- docs::
markdown documentation used by sphinx to auto-generate HTML RTD style doc
- examples::
Jupyter notebooks showing pydarshan usage with log files
- tests::
pydarshan specific test cases
- requirements.txt::
pip requirement file for minimum set of depednencies
- requirements_dev.txt::
pip requirement file for depednencies needed to run development tools
- setup.py::
python file for building/generating pydarshan package
- setup.cfg::
input for setup.py
- MANIFEST.in::
input files for setup.py package
- tox.ini::
input for tox which runs the automated testing
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for darshan-0.0.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 933cc4a6cacb56aeba083afab5f17ff1a0db69f3e5639f6d3061782f6a0cbcc9 |
|
MD5 | 0c6a59228e182ca5c0de4a2a6120f263 |
|
BLAKE2b-256 | 00fb2fe083fe19a44eceb2843a0e50d23036f6218df6001dbf039eac4b8444b4 |
Hashes for darshan-0.0.8-cp39-cp39-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b31b2da33e8d7891dc650f5c981e9a20c2943551500e776ef00833a4295dc020 |
|
MD5 | 31a1e7b6b0fb7f618a33d83142684d5b |
|
BLAKE2b-256 | 571671d28ff988d1e11714948b14fe8772d8ba444997272b323277e0a9b8258e |
Hashes for darshan-0.0.8-cp39-cp39-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1599cb737826faf9bb6820680acebd46996734a6c1e2a8e3aa4716fe4aeef68e |
|
MD5 | 99229fb2524a1547dee33b2d0e1ed7c2 |
|
BLAKE2b-256 | 6d8e6b96531694af7ed3a3fbb8af9db2ddd909e3ccbbcecf29d14176a4e5319b |
Hashes for darshan-0.0.8-cp39-cp39-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8be5cb53def42d353c416a1bfab28922fd6178efca9506563393ea4f5ff55010 |
|
MD5 | 09319900ae9c8250cb52f368c40d2a91 |
|
BLAKE2b-256 | ef95f7c2f92e8385626de0096ba3cdc2ef378d8894da4df8c163e8040df897f0 |
Hashes for darshan-0.0.8-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 517ba4372ba0111dad77d851e1d7fc9dfe95a45e71cbf10aecc04285fa278b9c |
|
MD5 | 99ec242dec43e026f936e1611b0b91e7 |
|
BLAKE2b-256 | e630d3286f6ec542d12b872330430fe649c32e8f064c1f363736bcddf6d0a48b |
Hashes for darshan-0.0.8-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f572a25aede4df431bb2a41fb2091cffbf2e344875f8f014dc23a22a61220255 |
|
MD5 | ba344b153c1adbefe2edf9761fd49d9f |
|
BLAKE2b-256 | c6cfb57ada6689151044b6df55b52523492c0623f2138b345a8e68f8bb7c7e6c |
Hashes for darshan-0.0.8-cp38-cp38-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 819901c8804620c170bf56b391f2fca4fb08c3da8470c0631ac2a9f6632973db |
|
MD5 | cb1aaab2253013f79f7e27241df89a62 |
|
BLAKE2b-256 | 7df004b8548a609e47d0e348efe5343240c8aa5ac5ba157003005bc345a12672 |
Hashes for darshan-0.0.8-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c6e0f2ea258f011614032f1156ac5c8c3eb1cd81618c16c46e45136ba97c95f |
|
MD5 | a8e74fe8c8106515f68598f5055629c5 |
|
BLAKE2b-256 | 64acd47729a59ed03fa304f25b8e95034ad5ecc1dbe4e83ffda7ad7b0458d3b8 |
Hashes for darshan-0.0.8-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 513cf2cb7b5fee8fb49f33571da05182e8130a7ca8d67fcf4bc3897fd8a43569 |
|
MD5 | 80800dae08d5b126e7887ff43d872b5f |
|
BLAKE2b-256 | fb74cde81cd6f1937967640423270d36cf6138ec49a69eb5b03425170e4dcf36 |
Hashes for darshan-0.0.8-cp37-cp37m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28eac69b78a1aa0cfdd360a7e676e8379021ff92925910173acb50be1b82e455 |
|
MD5 | 169616e9fca28a2d3f19e29e9ad77252 |
|
BLAKE2b-256 | d7520161b9d44878da721309b3b6fc9dbf12f6f5e20935a92062b05703af7008 |
Hashes for darshan-0.0.8-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 861d011904a381c34d96595c1711f6a44c8f9179ed5b3c5ecd6ef433fe978bc4 |
|
MD5 | 672b15970a9b6f86d1b460c55faa11ff |
|
BLAKE2b-256 | 857f8c9c35f791c3a4d111f6255595b34d942f2e91246208c1c81172d94a77b5 |
Hashes for darshan-0.0.8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 127e79cd33cc6171b54137b14e1d13bfdb759f253ff9390ee23cf5da597bb7ed |
|
MD5 | 6a8bd7aa230056c2c36e22a3da81f17d |
|
BLAKE2b-256 | a7246a9d0d1c89c552b50db8e9b7927389749aed03a7a0f0c4acd78f94d55d59 |
Hashes for darshan-0.0.8-cp36-cp36m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 488115587600dd68d5aa5b0edc2de2f681b6f8b8d29779d413a4b9f1bd56c143 |
|
MD5 | 45d2203c60ba0a023f0a59a2e2c0d2fb |
|
BLAKE2b-256 | 34144a071c4a7aed319bdf2368dfad7ca34961a1d5b1f9ef55575a3016f0f16c |