From 0a95a11e39972701011d98a2471365763400d88e Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Sun, 15 Jun 2025 09:34:42 +0200 Subject: [PATCH 1/2] remove CI workflow for verying that README mentions correct EESSI version (only makes sense for EESSI/software-layer repository) --- .github/workflows/tests_readme.yml | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 .github/workflows/tests_readme.yml diff --git a/.github/workflows/tests_readme.yml b/.github/workflows/tests_readme.yml deleted file mode 100644 index 1a838e06..00000000 --- a/.github/workflows/tests_readme.yml +++ /dev/null @@ -1,30 +0,0 @@ -# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions -name: Tests for consistency of README.md -on: - push: - paths: - - README.md - - init/eessi_defaults - - pull_request: - paths: - - README.md - - init/eessi_defaults -permissions: - contents: read # to fetch code (actions/checkout) -jobs: - build: - runs-on: ubuntu-24.04 - steps: - - name: Check out software-layer repository - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - - - name: verify if README.md is consistent with EESSI_VERSION from init/eessi_defaults - run: | - source init/eessi_defaults - grep "${EESSI_VERSION}" README.md - - - name: verify if README.md is consistent with EESSI_CVMFS_REPO from init/eessi_defaults - run: | - source init/eessi_defaults - grep "${EESSI_CVMFS_REPO}" README.md From 1b6f9494af66ec970e7d03fe2fa8034584a88844 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Sun, 15 Jun 2025 09:37:29 +0200 Subject: [PATCH 2/2] update README --- README.md | 38 +++++--------------------------------- 1 file changed, 5 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index ab73ad75..f0d5101b 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,17 @@ -# Software layer +# Software layer scripts -The software layer of the EESSI project uses [EasyBuild](https://docs.easybuild.io), [Lmod](https://lmod.readthedocs.io) and [archspec](https://archspec.readthedocs.io). +Scripts for building the EESSI software layer. See also https://www.eessi.io/docs/software_layer . -## Pilot software stack - -You can set up your environment by sourcing the init script: - -``` -$ source /cvmfs/software.eessi.io/versions/2023.06/init/bash -Found EESSI repo @ /cvmfs/software.eessi.io/versions/2023.06! -Derived subdirectory for software layer: x86_64/intel/haswell -Using x86_64/intel/haswell subdirectory for software layer -Initializing Lmod... -Prepending /cvmfs/software.eessi.io/versions/2023.06/software/x86_64/intel/haswell/modules/all to $MODULEPATH... -Environment set up to use EESSI (2023.06), have fun! -[EESSI 2023.06] $ -``` - -### Accessing EESSI via a container - -You need Singularity version 3.7 or newer. Then, simply run - -``` -$ ./eessi_container.sh -``` -Once you get presented the prompt `Singularity>` run the above `source` command. - -If you want to build a package for the software repository, simply add the arguments `--access rw`, e.g., full command would be - -``` -$ ./eessi_container.sh --access rw -``` -Note, not all features/arguments listed via `./eessi_container.sh --help` are implemented. +Easystack files used for specifying which software installations are included in EESSI software layer are in +[EESSI/software-layer](https://github.com/EESSI/software-layer) repository. # License The software in this repository is distributed under the terms of the [GNU General Public License v2.0](https://opensource.org/licenses/GPL-2.0). -See [LICENSE](https://github.com/EESSI/software-layer/blob/main/LICENSE) for more information. +See [LICENSE](https://github.com/EESSI/software-layer-scripts/blob/main/LICENSE) for more information. SPDX-License-Identifier: GPL-2.0-only