From 0119beca5518ced72ef748df5066a53b34500e31 Mon Sep 17 00:00:00 2001
From: Martin Lang <martin.lang@mpsd.mpg.de>
Date: Tue, 27 Jun 2023 10:12:33 +0000
Subject: [PATCH 1/2] Fix mistakes and typos in README
---
README.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.rst b/README.rst
index d142b63..d87e2f6 100644
--- a/README.rst
+++ b/README.rst
@@ -22,7 +22,7 @@ To install, for example, the ``foss2022a-serial`` toolchain:
1. Install this mpsd-software-manager Python package. The recommended way is to
use ``pipx`` to that this tool is available independent from the use of any
- other python environments::
+ other Python environments::
$ pipx install git+https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager
@@ -100,7 +100,7 @@ Package sets and toolchains
- openblas@0.3.20
- in addition to the Easybuild-driven choice of packages, there are
- additional packages included in each package which support the build of
+ additional packages included in each toolchain which support the build of
Octopus within these toolchains. For ``foss2022a-serial`` these packages
include::
@@ -151,7 +151,7 @@ Prerequisites
What needs to be installed for the installation to succeed?
-The ``mpsd-software-manager`` python package.
+The ``mpsd-software-manager`` Python package.
- This needs a recent Python (3.9 or later).
- Install via pip or pipx.
@@ -180,7 +180,7 @@ Requirements for particular toolchains and package sets
Finding the Octopus configure wrapper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For each Octopus toolchain, there is a Octopus configure wrapper available.
+For each Octopus toolchain, there is an Octopus configure wrapper available.
The wrapper essentially calls the configure script with the right parameters,
and library locations for the current toolchain. Once the
toolchain is loaded, the variable ``$MPSD_OCTOPUS_CONFIGURE`` contains that
@@ -211,17 +211,17 @@ Octopus) using the ``foss2022a-serial`` toolchain.
Frequently asked questions
--------------------------
-- Can I install the ``mpsd-software-manager`` package in a python virtual environment?
+- Can I install the ``mpsd-software-manager`` package in a Python virtual environment?
Yes. ``pipx`` is probably more convenient, but you can create your own Pyton
virtual environment and install the ``mpsd-software-manager`` in that as a
- regular python package::
+ regular Python package::
python3 -m venv venv
. venv/bin/activate
pip install git+https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager
- You just need to activate that python virtual environment before being able to
+ You just need to activate that Python virtual environment before being able to
use the tool.
- Does the command write anything outside the mpsd-software-root directory?
@@ -239,7 +239,7 @@ Frequently asked questions
- How long does the compilation take?
This depends on the hardware. A few hours are typical per toolchain. If a
- second toolchain is compiled in the same MPSD software instance is likely to
+ second toolchain is compiled in the same MPSD software instance it is likely to
be faster, in particular if the same compiler is used (and thus the compiler
does not need to be re-compiled for the second toolchain).
--
GitLab
From 1e6964335fd8a79f44c271cb22ee4d541bd2cbdf Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Tue, 27 Jun 2023 12:23:27 +0200
Subject: [PATCH 2/2] add 'same release'
as suggested in
https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager/-/merge_requests/87/diffs
---
README.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.rst b/README.rst
index d87e2f6..e40c5d7 100644
--- a/README.rst
+++ b/README.rst
@@ -239,9 +239,10 @@ Frequently asked questions
- How long does the compilation take?
This depends on the hardware. A few hours are typical per toolchain. If a
- second toolchain is compiled in the same MPSD software instance it is likely to
- be faster, in particular if the same compiler is used (and thus the compiler
- does not need to be re-compiled for the second toolchain).
+ second toolchain is compiled in the same MPSD software instance and the same
+ MPSD release it is likely to be faster, in particular if the same compiler is
+ used (and thus the compiler does not need to be re-compiled for the second
+ toolchain).
- How much disk storage do I need?
--
GitLab