Skip to content

Commit 722730e

Browse files
author
Phil Carns
committed
revise landing page
- reorder toc - add toc references in top bullet list - remove stale facility documentation and replace with a more general sugestion to refer to facility documentation first
1 parent f12dbeb commit 722730e

File tree

1 file changed

+28
-44
lines changed

1 file changed

+28
-44
lines changed

index.rst

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,24 @@
11
Welcome to Darshan's Documentation
22
===================================
33

4-
The Darshan source tree is divided into two parts:
5-
6-
* ``darshan-runtime``: to be installed on systems where you intend to
7-
instrument MPI applications.
8-
* ``darshan-util``: to be installed on systems where you intend to analyze log
9-
files produced by darshan-runtime.
10-
11-
+ ``darshan-util/pydarshan``: a Python package providing interfaces to
12-
Darshan log file.
13-
14-
:ref:`Modularized I/O characterization using Darshan 3.x <TOC Modularization>`
15-
gives details on the design of the new modularized version of Darshan (3.x)
16-
and how new instrumentation modules may be developed within Darshan.
17-
18-
Site-specific documentation for facilities that deploy Darshan in production:
19-
20-
* Argonne Leadership Computing Facility (ALCF):
21-
`Theta <https://www.alcf.anl.gov/support-center/theta/darshan-theta>`_,
22-
`Cooley <https://www.alcf.anl.gov/support-center/cooley/darshan-cooley>`_.
23-
* National Energy Research Scientific Computing Center
24-
(`NERSC <https://docs.nersc.gov/environment/#darshan-and-altd>`_)
25-
* National Center for Supercomputing Applications
26-
(`NCSA <https://bluewaters.ncsa.illinois.edu/darshan>`_)
27-
* Oak Ridge Leadership Computing Facility (OLCF):
28-
`darshan-runtime <https://www.olcf.ornl.gov/software_package/darshan-runtime/>`_,
29-
`darshan-util <https://www.olcf.ornl.gov/software_package/darshan-util/>`_.
30-
* King Abdullah University of Science and Technology
31-
(`KAUST <https://www.hpc.kaust.edu.sa/sites/default/files/files/public/Parallel_IO_bh.pdf>`_)
32-
* European Centre for Medium-Range Weather Forecasts
33-
(`ECMWF <https://software.ecmwf.int/wiki/display/UDOC/How+to+use+Darshan+to+profile+IO>`_)
34-
* Ohio Supercomputer Center
35-
(`OSC <https://www.osc.edu/resources/available_software/software_list/darshan>`_)
36-
* Julich Supercomputing Centre
37-
(`JSC <https://apps.fz-juelich.de/unite/files/DebugAndPerformanceTools-latest.pdf>`_)
4+
**NOTE: please check with your facility for site-specific documentation first if you are using a version of Darshan provided by your organization.**
5+
6+
The primary Darshan documentation is divided into three parts:
7+
8+
* :ref:`darshan-runtime <TOC Darshan Runtime>`: The portion of Darshan that
9+
is used to instrument applications.
10+
* :ref:`PyDarshan <pydarshantoc>`: A Python package that provides APIs and
11+
command-line tools for analyzing Darshan logs.
12+
* :ref:`darshan-util <TOC Darshan Utilities>`: The underlying C
13+
library and command-line tools for managing Darshan logs.
14+
15+
While both PyDarshan and darshan-util provide analysis capabilities, we
16+
strongly recommend that you use PyDarshan for the most up to date features
17+
and functionality.
18+
19+
In addition, :ref:`Modularized I/O characterization using Darshan 3.x <TOC
20+
Modularization>` is a reference for developers who wish to better understand
21+
the Darshan architecture or develop new instrumentation modules.
3822

3923
.. toctree::
4024
:maxdepth: 2
@@ -43,6 +27,16 @@ Site-specific documentation for facilities that deploy Darshan in production:
4327

4428
darshan-runtime/doc/darshan-runtime
4529

30+
.. toctree::
31+
:maxdepth: 2
32+
:caption: PyDarshan
33+
:name: pydarshantoc
34+
35+
darshan-util/pydarshan/docs/readme
36+
darshan-util/pydarshan/docs/install
37+
darshan-util/pydarshan/docs/usage
38+
darshan-util/pydarshan/docs/api/pydarshan/modules
39+
4640
.. toctree::
4741
:maxdepth: 2
4842
:caption: Darshan Utilities
@@ -57,16 +51,6 @@ Site-specific documentation for facilities that deploy Darshan in production:
5751

5852
doc/darshan-modularization.rst
5953

60-
.. toctree::
61-
:maxdepth: 2
62-
:caption: PyDarshan
63-
:name: pydarshantoc
64-
65-
darshan-util/pydarshan/docs/readme
66-
darshan-util/pydarshan/docs/install
67-
darshan-util/pydarshan/docs/usage
68-
darshan-util/pydarshan/docs/api/pydarshan/modules
69-
7054
Indices and tables
7155
==================
7256

0 commit comments

Comments
 (0)