From 8b3b6223642d897af6b9d4a058f7740e6d397ee5 Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Fri, 16 Jun 2023 11:17:37 +0200
Subject: [PATCH] update API and repo name
---
README.rst | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/README.rst b/README.rst
index e49f4dc..e71474a 100644
--- a/README.rst
+++ b/README.rst
@@ -3,7 +3,7 @@ MPSD Software installation
.. contents::
-This repository provides the `mpsd-software` tool which is used to install
+This repository provides the ``mpsd-software`` tool which is used to install
package sets and toolchains on the `MPSD HPC cluster
<https://computational-science.mpsd.mpg.de/docs/mpsd-hpc.html>`__.
@@ -22,15 +22,15 @@ To install, for example, the ``foss2022a-serial`` toolchain:
1. Clone this repository to the place where you want to install the software environment::
- git clone https://gitlab.gwdg.de/mpsd-cs/mpsd-software-environments.git
+ git clone https://gitlab.gwdg.de/mpsd-cs/mpsd-software.git
-2. ``cd mpsd-software-environments``
+2. ``cd mpsd-software``
3. Execute the script to install the toolchain::
- $> ./mpsd-software.py install dev-23a --toolchain foss2022a-serial
+ $> ./mpsd-software.py install dev-23a foss2022a-serial
- This will take some time.
+ 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
to activate the created modules, try the ``status`` command::
@@ -48,12 +48,14 @@ To install, for example, the ``foss2022a-serial`` toolchain:
Documentation
-------------
+More detailed documentation that goes beyond the `Quick Start`_ section.
+
Package sets and toolchains
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Package sets are a combination of particular versions of multiple software
packages (such as anaconda3, or gcc and fftw). In the way the SSU
- Computational Science provides software on the MPSD HPC cluster and for the
+ Computational Science provides software on the MPSD HPC cluster, and for the
Octopus continuous integration services, these package sets are compiled
together (using Spack).
--
GitLab