[Darshan-commits] [Git][darshan/darshan][master] 2 commits: brief documentation for spack packages

[Philip Carns]

Philip Carns pushed to branch master at darshan / darshan


Commits:
1e44c0ae by Phil Carns at 2021-03-10T16:51:38-05:00
brief documentation for spack packages

- - - - -
8de30ada by Philip Carns at 2021-03-10T15:52:51-06:00
Merge branch 'carns/darshan-runtim-doc-spack' into 'master'

brief documentation for spack packages

Closes #308

See merge request darshan/darshan!81
- - - - -


1 changed file:

- darshan-runtime/doc/darshan-runtime.txt


Changes:

=====================================
darshan-runtime/doc/darshan-runtime.txt
=====================================
@@ -51,7 +51,9 @@ http://www.mcs.anl.gov/darshan[Darshan web site].
 * C compiler (preferably GCC-compatible)
 * zlib development headers and library
 
-== Compilation
+== Conventional installation
+
+=== Compilation
 
 .Configure and build example (with MPI support)
 ----
@@ -115,7 +117,7 @@ group read access.
 * `--disable-lustre-mod`: disables compilation and use of Darshan's Lustre module (default=enabled)
 * `--disable-mdhim-mod`: disables compilation and use of Darshan's MDHIM module (default=disabled)
 
-== Environment preparation
+=== Environment preparation
 
 Once darshan-runtime has been installed, you must prepare a location
 in which to store the Darshan log files and configure an instrumentation method.
@@ -164,6 +166,56 @@ administrators group
 * recursively set the setgid bit on the log directories
 ====
 
+== Spack installation
+
+You can also install Darshan via https://spack.io/[Spack] as an alternative
+to manual download, compilation, and installation.  This may be
+especially convenient for single-user installs.  Darshan is divided
+into two separate packages for the command line utilities and runtime
+instrumentation.  You can install either or both as follows:
+
+----
+spack install darshan-util
+spack install darshan-runtime
+----
+
+[NOTE]
+====
+Darshan will generally compile and install fine using a variety of
+compilers, but we advise using a gcc compiler in Spack to compile Darshan
+(regardless of what compiler you will use for your applications) to
+ensure maximum runtime compatibility.
+====
+
+You can use the `spack info darshan-runtime` query to view the full list of
+variants available for the darshan-runtime Spack package.  For example, adding a `+slurm` to
+the command line (`spack install darshan-runtime+slurm`) will cause Darshan
+to be compiled with support for gathering job ID information from the Slurm
+scheduler.
+
+The following commands will load the Darshan packages once they have been
+installed:
+
+----
+spack load -r darshan-util
+spack load -r darshan-runtime
+----
+
+Note that the spack install of darshan-runtime will use an environment
+variable named `$DARSHAN_LOG_DIR_PATH` to indicate where it should store log
+files.  This variable is set to the user's home directory by default when
+the package is loaded, but it may be overridden.
+
+On Cray systems, you can also perform an additional step to load a
+Cray-specific module file. This will make a module called `darshan`
+available as described later in this document in the Cray platform recipe.
+It enables automatic instrumentation when using the standard Cray compiler
+wrappers.
+
+----
+module use `spack location -i darshan-runtime`/share/craype-2.x/modulefiles
+----
+
 == Instrumenting applications
 
 [NOTE]



View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/-/compare/649e3d35eeac81ae6273add1951aa338cf20334f...8de30ada258afda6bab37120bfcb21f8e63ca6c6

-- 
View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/-/compare/649e3d35eeac81ae6273add1951aa338cf20334f...8de30ada258afda6bab37120bfcb21f8e63ca6c6
You're receiving this email because of your account on xgitlab.cels.anl.gov.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/darshan-commits/attachments/20210310/b86aa83b/attachment-0001.html>