From b25df04f941ffcd3ec908ecbd8bbba01d12cca80 Mon Sep 17 00:00:00 2001
From: iamashwin99 <ashwin-kumar.karnad@mpsd.mpg.de>
Date: Tue, 27 Jun 2023 18:16:36 +0200
Subject: [PATCH] add the information about `init` in the quickstart
---
README.rst | 31 ++++++++++++++-----------------
1 file changed, 14 insertions(+), 17 deletions(-)
diff --git a/README.rst b/README.rst
index e40c5d7..180fafa 100644
--- a/README.rst
+++ b/README.rst
@@ -33,18 +33,27 @@ To install, for example, the ``foss2022a-serial`` toolchain:
$ cd /home/user/mpsd-software
- Future calls of the `mpsd-software` command need to be executed from this
- "mpsd-software-root" directory.
+3. Initiate the installation at this location using::
-3. From the same directory, run the command to install the ``foss2022a-serial``
+ $ mpsd-software init
+
+ Future calls of the `mpsd-software` command need to be executed from this
+ "mpsd-software-root" directory or in one of its subdirectories.
+
+ (The above command creates a hidden file ``.mpsd-software-root`` to tag the location for
+ as the root of the installation. All compiled files, logs etc are written in
+ or below this subdirectory.)
+
+
+4. From the same directory, run the command to install the ``foss2022a-serial``
toolchain::
$ mpsd-software install dev-23a foss2022a-serial
This will take some time (up to several hours depending on hardware).
-4. To see the installation status, and the required ``module use`` command line
+5. To see the installation status, and the required ``module use`` command line
to activate the created modules, try the ``status`` command::
$ mpsd-software status dev-23a
@@ -55,7 +64,7 @@ To install, for example, the ``foss2022a-serial`` toolchain:
foss2022a-serial
[module use /home/user/mpsd-software/dev-23a/cascadelake/lmod/Core]
-5. To compile Octopus, source the provided configure script, for example ``foss2022a-serial-config.sh``, as
+6. To compile Octopus, source the provided configure script, for example ``foss2022a-serial-config.sh``, as
`explained here <https://computational-science.mpsd.mpg.de/docs/mpsd-hpc.html#loading-a-toolchain-to-compile-octopus>`__).
The configure scripts are located in ``dev-23a/spack-environments/octopus``::
@@ -265,15 +274,3 @@ Frequently asked questions
Development
-----------
Developers documentation is available at development.rst.
-
-
-.. comment:
- Draft for additional steps for 'quickstart' once/if we have the the `init` command added.
-
- 3. Initiate the installation at this location using::
-
- $ mpsd-software init
-
- (This creates a hidden file ``.mpsd-software-root`` to tag the location for
- as the root of the installation. All compiled files, logs etc are written in
- or below this subdirectory.)
--
GitLab