Skip to content
Snippets Groups Projects

Fix mistakes and typos in README

Merged Martin Lang requested to merge readme-fixes into main
1 file
+ 11
10
Compare changes
  • Side-by-side
  • Inline
+ 11
10
@@ -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,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 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?
Loading