Skip to content

Commit ff7baef

Browse files
authored
Merge pull request #12 from boegel/ci_readme
update README + remove CI workflow for verying that README mentions correct EESSI version
2 parents 6706b58 + 1b6f949 commit ff7baef

File tree

2 files changed

+5
-63
lines changed

2 files changed

+5
-63
lines changed

.github/workflows/tests_readme.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,17 @@
1-
# Software layer
1+
# Software layer scripts
22

3-
The software layer of the EESSI project uses [EasyBuild](https://docs.easybuild.io), [Lmod](https://lmod.readthedocs.io) and [archspec](https://archspec.readthedocs.io).
3+
Scripts for building the EESSI software layer.
44

55
See also https://www.eessi.io/docs/software_layer .
66

7-
## Pilot software stack
8-
9-
You can set up your environment by sourcing the init script:
10-
11-
```
12-
$ source /cvmfs/software.eessi.io/versions/2023.06/init/bash
13-
Found EESSI repo @ /cvmfs/software.eessi.io/versions/2023.06!
14-
Derived subdirectory for software layer: x86_64/intel/haswell
15-
Using x86_64/intel/haswell subdirectory for software layer
16-
Initializing Lmod...
17-
Prepending /cvmfs/software.eessi.io/versions/2023.06/software/x86_64/intel/haswell/modules/all to $MODULEPATH...
18-
Environment set up to use EESSI (2023.06), have fun!
19-
[EESSI 2023.06] $
20-
```
21-
22-
### Accessing EESSI via a container
23-
24-
You need Singularity version 3.7 or newer. Then, simply run
25-
26-
```
27-
$ ./eessi_container.sh
28-
```
29-
Once you get presented the prompt `Singularity>` run the above `source` command.
30-
31-
If you want to build a package for the software repository, simply add the arguments `--access rw`, e.g., full command would be
32-
33-
```
34-
$ ./eessi_container.sh --access rw
35-
```
36-
Note, not all features/arguments listed via `./eessi_container.sh --help` are implemented.
7+
Easystack files used for specifying which software installations are included in EESSI software layer are in
8+
[EESSI/software-layer](https://github.com/EESSI/software-layer) repository.
379

3810
# License
3911

4012
The software in this repository is distributed under the terms of the
4113
[GNU General Public License v2.0](https://opensource.org/licenses/GPL-2.0).
4214

43-
See [LICENSE](https://github.com/EESSI/software-layer/blob/main/LICENSE) for more information.
15+
See [LICENSE](https://github.com/EESSI/software-layer-scripts/blob/main/LICENSE) for more information.
4416

4517
SPDX-License-Identifier: GPL-2.0-only

0 commit comments

Comments
 (0)