From 7407fa0620bb81aa01b3895325de93c56de39eec Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Tue, 27 Jun 2023 08:05:27 +0200
Subject: [PATCH] Add the location of the octopus configure script in lmod file

MPSD_OCTOPUS_CONFIGURE
---
 README.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.rst b/README.rst
index 7a2383a..5b9be9b 100644
--- a/README.rst
+++ b/README.rst
@@ -177,6 +177,24 @@ Requirements for particular toolchains and package sets
 - ``foss*-mpi`` currently needs linux header files installed (to compile the ``knem`` package)
 - ``foss*-cuda-mpi`` (proably as `*-mpi, needs testing TODO`)
 
+Finding the Octopus configure script
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For each toolchain, there is a Octopus configure script available. Once the
+toolchain is loaded, the variable ``$MPSD_OCTOPUS_CONFIGURE`` contains that
+path. The path can also be seen using the ``module show TOOLCHAINNAME`` command. For example::
+
+  $ mpsd-software install dev-23a foss2022a-mpi
+  $ module use /home/fangohr/mpsd-software-manager/dev-23a/cascadelake/lmod/Core
+  $ module show toolchains/foss2022a-mpi
+  ...
+  depends_on("cgal/5.0.3")
+  depends_on("hdf5/1.12.2")
+  setenv("MPSD_OCTOPUS_CONFIGURE","/home/fangohr/mpsd-software/dev-23a/spack-environments/octopus/foss2022a-mpi-config.sh")
+  $ module load toolchains/foss2022a-mpi
+  $ echo $MPSD_OCTOPUS_CONFIGURE
+  /home/fangohr/mpsd-software/dev-23a/spack-environments/octopus/foss2022a-mpi-config.sh
+
 
 Working example
 ~~~~~~~~~~~~~~~
-- 
GitLab