Skip to content

Commit 8545fdd

Browse files
committed
adding more verbository about installing module software
Signed-off-by: vsoch <[email protected]>
1 parent 4c01a65 commit 8545fdd

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,14 @@ And container technologies:
1616
- [Podman](https://podman.io)
1717
- [Docker](https://docker.io)
1818

19-
Coming soon:
20-
21-
- [Shifter](https://github.com/NERSC/shifter)
2219

2320
You can use shpc if you are:
2421

2522
1. a linux administrator wanting to manage containers as modules for your cluster
2623
2. a cluster user that wants to maintain your own folder of custom modules
2724
3. a cluster user that simply wants to pull Singularity images as GitHub packages.
2825

29-
These use cases will be better flushed out and documented as the library is developed.
26+
A module technology is required in all cases.
3027

3128
📖️ Read the [documentation](https://singularity-hpc.readthedocs.io/en/latest/) 📖️
3229
⭐️ Browse the [container module collection](https://singularityhub.github.io/singularity-hpc/) ⭐️

docs/getting_started/installation.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44
Installation
55
============
66

7-
Singularity Registry HPC (shpc) can be installed from pypi, or from source. For either, it's
8-
recommended that you create a virtual environment, if you have not already
7+
Singularity Registry HPC (shpc) can be installed from pypi, or from source.
8+
In all cases, a module technology is required such as `lmod (install intstructions) <https://lmod.readthedocs.io/en/latest/030_installing.html>`_
9+
or `environment modules (install instructions) <https://modules.readthedocs.io/en/latest/INSTALL.html>`_.
10+
Having module software installed means that the ``module`` command should be on your path.
11+
Once you are ready to install shpc along your module software, it's recommended that you create a virtual environment, if you have not already
912
done so.
1013

1114

0 commit comments

Comments
 (0)