Welcome to Darshan’s Documentation

NOTE: please check with your facility for site-specific documentation first if you are using a version of Darshan provided by your organization.

The primary Darshan documentation is divided into three parts:

  • darshan-runtime: The portion of Darshan that is used to instrument applications.

  • PyDarshan: A Python package that provides APIs and command-line tools for analyzing Darshan logs.

  • darshan-util: The underlying C library and command-line tools for managing Darshan logs.

While both PyDarshan and darshan-util provide analysis capabilities, we strongly recommend that you use PyDarshan for the most up to date features and functionality.

In addition, Modularized I/O characterization using Darshan 3.x is a reference for developers who wish to better understand the Darshan architecture or develop new instrumentation modules.

Indices and tables