Skip to content

Commit 4e5a423

Browse files
committed
Add cvmfsexec and tidy up
1 parent db8cca4 commit 4e5a423

6 files changed

Lines changed: 55 additions & 17 deletions

File tree

docs/getting-access.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ of the EESSI repository.
1212
## Is EESSI accessible?
1313

1414
EESSI can be accessed via [a native (CernVM-FS) installation](#native-installation),
15-
or via [a container that includes CernVM-FS](#eessi-via-a-container).
15+
via [a container that includes CernVM-FS](#eessi-via-a-container), or via a dedicated user-space tool called
16+
[`cvmfsexec`](#eessi-via-cvmfsexec).
1617

17-
Before you look into these options, check if EESSI is already accessible on your system.
18+
Before you look into other options, check if EESSI is already accessible on your system.
1819

1920
Run the following command:
2021
``` { .bash .copy }
@@ -41,23 +42,20 @@ ls: /cvmfs/software.eessi.io: No such file or directory
4142
```
4243
No worries, you don't need to be a :mage: to get access to EESSI.
4344

44-
Continue reading about the [Native installation](#native-installation) of EESSI,
45-
or accessing [EESSI via a container](#eessi-via-a-container).
45+
Continue reading about the [Native installation](#native-installation) of EESSI, or
46+
accessing EESSI via a [container](#eessi-via-a-container) or via [`cvmfsexec`](#eessi-via-cvmfsexec).
4647

4748
## Native installation
4849

4950
Setting up native access to EESSI, that is a system-wide deployment that does not require workarounds like
5051
[using a container](#eessi-via-a-container), requires the installation and configuration of [CernVM-FS](https://cernvm.cern.ch/fs).
5152

52-
This requires **admin privileges**, since you need to install CernVM-FS as an OS package.
53+
This requires **administrator privileges**, since you need to install CernVM-FS as an OS package.
5354

5455
The following actions must be taken for a (basic) native installation of EESSI:
5556

5657
* Installing CernVM-FS itself, ideally using the OS packages provided by the CernVM-FS project
5758
(although installing from source is also possible);
58-
* Installing the EESSI configuration for CernVM-FS, which can be done by installing the ``cvmfs-config-eessi``
59-
package that we provide for the most popular Linux distributions
60-
(more information available [here](https://github.com/EESSI/filesystem-layer/));
6159
* Creating a small client configuration file for CernVM-FS (``/etc/cvmfs/default.local``);
6260
see also the [CernVM-FS documentation](https://cvmfs.readthedocs.io/en/stable/cpt-quickstart.html#create-default-local).
6361

@@ -180,6 +178,32 @@ In this environment, you should be able to access the EESSI `software.eessi.io`
180178
ls /cvmfs/software.eessi.io
181179
```
182180

181+
## EESSI via `cvmfsexec`
182+
183+
When you do not have administrator rights, nor access to `singularity`/`apptainer`, there is still another option that
184+
may work for you: [`cvmfsexec`](https://github.com/cvmfs/cvmfsexec) allows you to mount cvmfs repositories
185+
as an unprivileged user.
186+
187+
Whether this approach will work is very dependent on the specific system you have access to. If this approach is your
188+
only option, the best way to check if it will work is to try it out and see if you run into problems.
189+
190+
The first thing you need to do is clone the `cvmfsexec` repository, and enter the directory
191+
``` { .bash .copy }
192+
git clone https://github.com/cvmfs/cvmfsexec.git
193+
cd cvmfsexec
194+
```
195+
Once inside this directory, `cvmfsexec` does still require an internet connection and some tools from your system that
196+
may not be available by default (but are quite common): `curl`, `rpm2cpio`, and `cpio`. If those are available then the
197+
see if the steps below work for you:
198+
199+
``` { .bash .copy }
200+
# First we gather the files that cvmfsexec requires (this will also tell you if your OS is supported)
201+
./makedist default
202+
203+
# Then we try to start cvmfsexec and see what happens
204+
./cvmfsexec cvmfs-config.cern.ch software.eessi.io -- bash
205+
```
206+
183207
---
184208

185209
To start using EESSI, see [Using EESSI](usage.md).

docs/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ EESSI provides a shared, portable, and optimized software stack for scientific c
1212

1313
## Tutorial Contents
1414

15-
For those attending the live tutorial at ISC26, there is a [prepared environment](prepared-environment.md) available.
15+
For those attending the live tutorial at ISC 2026, there is a [prepared environment](prepared-environment.md) available.
1616

1717
1. [Introduction to EESSI](introduction.md)
1818
2. [Getting Access to EESSI](getting-access.md)
1919
3. [Using EESSI](usage.md)
2020
4. [EESSI Use Cases](use-cases.md)
2121
5. [Installing on top of EESSI](installing-on-top.md)
2222
6. [Using EESSI in CI](ci.md)
23-
7. [Advanced topics](advanced-topics.md)
2423

2524
## Learning Objectives
2625

docs/introduction.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ We use custom architecture detection scripts
109109
to automatically select the best suited installations from the software stack for
110110
a particular host, based on its system architecture.
111111

112-
The software layer is maintained through our [https://github.com/EESSI/software-layer](https://github.com/EESSI/software-layer) GitHub repository.
112+
The software layer is maintained through our [https://github.com/EESSI/software-layer-scripts](https://github.com/EESSI/software-layer) and [https://github.com/EESSI/software-layer](https://github.com/EESSI/software-layer-scripts) GitHub repositories.
113113

114114
## Current status
115115

@@ -135,4 +135,10 @@ and hence the [MultiXscale](https://www.multixscale.eu/) EuroHPC Centre-of-Excel
135135
project (2023-2026) that is a collaboration between EESSI and [CECAM](https://www.cecam.org/), with goals
136136
that include making EESSI ready for production, and supporting community contributions.
137137

138+
In 2024, EESSI won the HPCwire Reader's Choice Award at SC24.
139+
140+
EESSI is also a critical component of the
141+
[EuroHPC Federation Platform (EFP)](https://my-eurohpc.eu/), underpinning the Federated Software Catalogue. The first
142+
release of EFP took place in April 2026.
143+
138144
[*(back to overview page)*](index.md)

docs/prepared-environment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Follow the instructions below to get access to a temporary virtual machine
44
that you can use for the hands-on exercises during this tutorial.
55

66

7-
!!! note "Only available during EESSI tutorial at ISC'26"
7+
!!! note "Only available during EESSI tutorial at ISC 2026"
88

9-
This environment is only available during the EESSI tutorial at [ISC'26](https://isc-hpc.com),
9+
This environment is only available during the EESSI tutorial at [ISC 2026](https://isc-hpc.com),
1010
on Monday 22 June 2026.
1111

1212
Alternatively, you can use a system where EESSI is already available, see [here](https://eessi.io/docs/systems).
@@ -20,7 +20,7 @@ that you can use for the hands-on exercises during this tutorial.
2020

2121
!!! tip "Do not hesitate to ask for help!"
2222

23-
During the ISC'26 tutorial, raise your hand to ask a question or get help.
23+
During the ISC 2026 tutorial, raise your hand to ask a question or get help.
2424

2525
Afterwards, join the EESSI Slack via the "Slack channel" link on the EESSI website
2626
[https://eessi.io](https://eessi.io), and ask your question there.
@@ -49,7 +49,7 @@ ssh tutorial.eessi.science
4949

5050
Browse to https://tutorial.eessi.science
5151

52-
- Make sure to change default Time to 4 hours
52+
- Make sure to change default "Time" to 4 hours
5353
- Take 4 cores
5454

5555
Alternative, use the login node for hands-on, 16 cores so should be fine to share for a small group.

docs/usage.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* Explore the software that EESSI has to offer
77
* Run examples for some software packages included in EESSI
88

9-
If the EESSI repository is available, all you need to do is set up your shell environment,
9+
If the EESSI repository is available, all you need to do is set up your shell environment
1010
and you can start using the software installations that EESSI provides.
1111

1212
## Setting up your environment
@@ -17,6 +17,16 @@ To set up the EESSI environment, run the command:
1717
source /cvmfs/software.eessi.io/versions/2025.06/init/lmod/bash
1818
```
1919

20+
!!! note "What if I want a different EESSI version?"
21+
22+
Indeed there are a few different EESSI versions (`2023.06` and `2025.06`) and this list will grow! You can
23+
always select a different EESSI after initialising by loading the appropriate module. For example, for
24+
`EESSI/2023.06` I can use the initialisation as above with the version changed, or I can use the same
25+
initialisation and switch the `EESSI` module afterwards:
26+
``` { .bash .copy }
27+
module load EESSI/2023.06
28+
```
29+
2030
This may take a while as data is downloaded from a Stratum 1 server which is
2131
part of the CernVM-FS infrastructure to distribute files. You should see the
2232
following output:

zensical.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ nav = [
5353
{ "Use cases for EESSI" = "use-cases.md" },
5454
{ "Installing on top of EESSI" = "installing-on-top.md" },
5555
{ "Using EESSI in CI" = "ci.md" },
56-
{ "Advanced topics" = "advanced-topics.md" },
5756
]
5857

5958
# With the "extra_css" option you can add your own CSS styling to customize

0 commit comments

Comments
 (0)