Skip to content

Commit ea897bc

Browse files
committed
Expand the tutorial and begin filling the gaps
1 parent 0391884 commit ea897bc

11 files changed

Lines changed: 425 additions & 0 deletions

docs/advanced-topics.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Customisation of EESSI
2+
3+
## GPU drivers
4+
5+
## MPI runtimes
6+
7+
# Other software installation tools on top of EESSI
8+
9+
## Spack

docs/building-on-top.md

Lines changed: 358 additions & 0 deletions
Large diffs are not rendered by default.

docs/eessi-getting-access.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Getting Access to EESSI
22

3+
!!! Note "Learning Objectives"
4+
5+
* Learn how to check if EESSI is available
6+
* Learn how to install EESSI locally if you have administrator permissions
7+
* Learn how to start EESSI inside a container
8+
39
To get access to EESSI, it suffices to have [CernVM-FS](https://cernvm.cern.ch/fs/) installed, and make it aware
410
of the EESSI repository.
511

docs/eessi-in-ci.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# EESSI for Continuous Integration (CI)
2+
3+
!!! Note "Learning Objectives"
4+
5+
* Integrate CI based on EESSI into our software project
6+
* Navigate the CI interface of GitHub
7+
* Consider the benefits of CI integration
8+
9+
## What is Continuous Integration (CI)?
10+
11+
## How can EESSI help with CI?
12+
13+
14+
### EESSI GitHub Action
15+
16+
!!! Note "I use GitLab not GitHub"
17+
18+
The [EESSI GitLab Component]() also exists, and this allows you to follow a very similar approach to that described
19+
here for GitHub. At the end of the episode we will provide the equivalent file needed to enable GitLab CI.
20+
21+
It is possible to use the [EESSI GitLab Component]() in a private GitLab instance, documentation on how to do this
22+
is available at <>.
23+
24+
## Adding CI based on EESSI to our software project
25+
26+
### Where to find help?
27+
28+
### What happens when CI fails?
29+
30+
## Benefits of CI

docs/eessi-introduction.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Introduction to EESSI
22

3+
!!! Note "Learning Objectives"
4+
5+
* Learn the basic layered architecture of EESSI
6+
* Understand what open source software delivers each layer
7+
* Explore some of the history of EESSI
8+
39
<p align="center"><a href="https://eessi.github.io/docs"><img src="img/EESSI_logo_horizontal_transparant.png" alt="EESSI logo" width="450px"/></a></p>
410

511
## What is EESSI?

docs/eessi-usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Using EESSI
22

3+
!!! Note "Learning Objectives"
4+
5+
* Configure EESSI in your environment
6+
* Explore the software that EESSI has to offer
7+
* Run examples for some software packages included in EESSI
8+
39
If the EESSI repository is available, all you need to do is set up your shell environment,
410
and you can start using the software installations that EESSI provides.
511

docs/eessi-use-cases.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Use Cases for EESSI
22

3+
!!! Note "Learning Objectives"
4+
5+
* Identify use cases for a fully reproducible environment like EESSI
6+
37
EESSI enables a variety of use cases, including:
48

59
* A uniform, extensible software stack across HPC clusters, clouds, servers, and laptops

docs/img/GitHubRepo.png

94.9 KB
Loading

docs/img/GitHubTemplate.png

66 KB
Loading

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ EESSI provides a shared, portable, and optimized software stack for scientific c
1616
2. [Introduction to EESSI](eessi-introduction.md)
1717
3. [Using EESSI](eessi-usage.md)
1818
4. [EESSI Use Cases](eessi-use-cases.md)
19+
5. [Building on top of EESSI](building-on-top.md)
20+
6. [Using EESSI in CI](eessi-in-ci.md)
21+
7. [Advanced topics](advanced-topics.md)
1922

2023
## Learning Objectives
2124

0 commit comments

Comments
 (0)