Skip to content

Commit

Permalink
Merge pull request #998 from darshan-hpc/snyder/pydarshan-report-in-docs
Browse files Browse the repository at this point in the history
DOC: add link to an example PyDarshan report in docs
  • Loading branch information
carns committed Jul 17, 2024
2 parents 478bf5b + c6085e3 commit 109749b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions darshan-util/pydarshan/RELEASE-CHECKLIST-PyDarshan.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Notes on how to release a new version of PyDarshan
- make docs
- upload docs/build/html contents to CELS server @ /nfs/pub_html/gce/projects/darshan/docs/pydarshan
- (might eventually connect this with readthedocs to have this automatically uploaded)
- determine whether new job summary tool features warrant generating a new summary report to include in docs
(stored @ /nfs/pub_html/gce/projects/darshan/docs/example_report.html)

- Submit to PyPI using cibuildwheel/twine:
- pipx run build --sdist
Expand Down
4 changes: 3 additions & 1 deletion darshan-util/pydarshan/docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Darshan job summary tool
------------------------

As a starting point, users can use PyDarshan to generate detailed
summary HTML reports of I/O activity for a given Darshan log.
summary HTML reports of I/O activity for a given Darshan log. An
example job summary report can be viewed `HERE <https://www.mcs.anl.gov/research/projects/darshan/docs/example_report.html>`_.

Usage of this job summary tool is described below. ::

usage: darshan summary [-h] [--output OUTPUT] [--enable_dxt_heatmap] log_path
Expand Down

0 comments on commit 109749b

Please sign in to comment.