Skip to content

Commit 6744b6d

Browse files
authored
Merge pull request #1 from boegel/roadmap_2026q1
minor revision of roadmap, include links where useful
2 parents 3221077 + a7654b9 commit 6744b6d

854 files changed

Lines changed: 56466 additions & 16750 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/script_module_list.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ jobs:
3434
runs-on: ubuntu-22.04
3535
steps:
3636
- uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
37-
- name: Make EESSI available
38-
uses: eessi/github-action-eessi@v3
39-
- name: Set up Python
40-
uses: eessi/github-action-eessi@v3
41-
with:
42-
python-version: '3.7'
4337
- name: Install dependencies
4438
run: |
4539
python -m venv venv

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
check_filenames: true
2222
# MarkDown files in docs/available_software/detail are skipped because they are auto-generated
2323
skip: '*.pdf,.git,*.json,./docs/available_software/detail/*.md'
24-
ignore_words_list: Fram,fram,ND,nd
24+
ignore_words_list: Fram,fram,ND,nd,Linz
2525

2626
# - name: Markdown Linting Action
2727
# uses: avto-dev/markdown-lint@v1.2.0

.github/workflows/test_overview_available_software.yml

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,24 @@ jobs:
2323
# install required Python packages in virtual environment
2424
python -m venv venv
2525
. venv/bin/activate
26-
pip install -r mkdocs-ldjson-plugin/requirements.txt
26+
pip install -r scripts/available_software/requirements.txt
2727
28-
python .github/workflows/scripts/test_overview_available_software.py
28+
# download https://eessi.io/api_data/data/eessi_api_metadata_software.json
29+
# to where it's expected by docs/available_software/macros.py and scripts/available_software/available_software.py
30+
data_dir="docs/available_software/data"
31+
mkdir -p ${data_dir}
32+
cd ${data_dir}
33+
curl -OL https://eessi.io/api_data/data/eessi_api_metadata_software.json
34+
cd -
35+
36+
python scripts/available_software/available_software.py
37+
./scripts/update_generated_time.sh mkdocs.yml
38+
39+
# determine whether pull request would need to be opened:
40+
# if detailed software pages in docs/available_software/detail have been updated, then a PR should be opened
41+
if [[ $(git status --porcelain ./docs/available_software/detail) ]]; then
42+
echo "Software pages have been changed, PR should be opened"
43+
git diff ./docs/available_software/detail
44+
else
45+
echo "Software pages have not been changed, no need to open PR"
46+
fi

.github/workflows/update_available_software.yml

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ jobs:
1717
python-version: '3.10'
1818
architecture: x64
1919

20-
- name: Mount EESSI
21-
uses: eessi/github-action-eessi@e1f8f20638ea417a18d23ab29443ee34794ff900 # v3.1.0
22-
with:
23-
eessi_stack_version: '2023.06'
24-
2520
- name: update overview of available software
2621
id: update_available_software
2722
run: |
@@ -30,30 +25,31 @@ jobs:
3025
. venv/bin/activate
3126
pip install -r scripts/available_software/requirements.txt
3227
33-
# copy current JSON data, so we can compare after updating it
34-
cp docs/available_software/data/json_data.json docs/available_software/data/json_data.json.orig
35-
cp docs/available_software/data/json_data_detail.json docs/available_software/data/json_data_detail.json.orig
28+
# download https://eessi.io/api_data/data/eessi_api_metadata_software.json
29+
# to where it's expected by docs/available_software/macros.py and scripts/available_software/available_software.py
30+
data_dir="docs/available_software/data"
31+
mkdir -p ${data_dir}
32+
cd ${data_dir}
33+
curl -OL https://eessi.io/api_data/data/eessi_api_metadata_software.json
34+
cd -
3635
37-
export TIME_GENERATED_TEMPLATE="{{ generated_time }}"
3836
python scripts/available_software/available_software.py
3937
./scripts/update_generated_time.sh mkdocs.yml
40-
38+
4139
git status
4240
4341
# determine whether pull request should be opened:
44-
# if JSON files in docs/available_software/data have been updated, then a PR should be opened
45-
json_data_changed=$(python scripts/available_software/check_json_updates.py docs/available_software/data/json_data.json.orig docs/available_software/data/json_data.json)
46-
json_data_detail_changed=$(python scripts/available_software/check_json_updates.py docs/available_software/data/json_data_detail.json.orig docs/available_software/data/json_data_detail.json)
47-
if [[ ${json_data_changed} == "no changes" ]] && [[ ${json_data_detail_changed} == "no changes" ]]; then
48-
echo "JSON files in docs/available_software/data have not been changed, no need to open PR"
49-
echo "json_data_changed=no" >> $GITHUB_OUTPUT
50-
else
51-
echo "JSON files in docs/available_software/data have been changed, PR should be opened"
42+
# if detailed software pages in docs/available_software/detail have been updated, then a PR should be opened
43+
if [[ $(git status --porcelain ./docs/available_software/detail) ]]; then
44+
echo "Software pages have been changed, PR should be opened"
5245
echo "json_data_changed=yes" >> $GITHUB_OUTPUT
46+
else
47+
echo "Software pages have not been changed, no need to open PR"
48+
echo "json_data_changed=no" >> $GITHUB_OUTPUT
5349
fi
5450
55-
# remove original JSON files, or they'll end up in the PR being opened
56-
rm -f docs/available_software/data/json_data.json.orig docs/available_software/data/json_data_detail.json.orig
51+
# remove the JSON file in the data directory, or it'll end up in the PR being opened
52+
rm -r ${data_dir}/*.json
5753
5854
- name: create pull request
5955
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8

docs/adding_software/opening_pr.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ To add software to EESSI, you should go through the semi-automatic software inst
1818
### Preparation
1919

2020
Before you can make a pull request to the [software-layer](https://github.com/EESSI/software-layer),
21-
you should [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository in your GitHub account.
21+
you should [fork](https://github.com/EESSI/software-layer/fork) the repository in your GitHub account.
22+
Please see [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for details. Once forked, you can proceed.
2223

2324
For the remainder of these instructions, we assume that your GitHub account is `@koala` :koala:.
2425

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
/*
2+
* CSS stylesheet for software overview, see docs/available_software/
3+
*/
4+
5+
.software-name {
6+
font-size: 0.9rem;
7+
font-weight: 700;
8+
color: var(--md-primary-fg-color);
9+
}
10+
11+
.software-versions {
12+
font-size: 0.6rem;
13+
font-style: italic;
14+
margin-left: 0.2rem;
15+
}
16+
17+
.software-link a {
18+
font-size: 0.6rem;
19+
color: var(--md-typeset-a-color);
20+
}
21+
22+
.software-more-info a {
23+
float: right;
24+
font-size: 0.6rem;
25+
font-style: italic;
26+
}
27+
28+
.software-description {
29+
font-size: 0.7rem;
30+
}
31+
32+
.software-cpus {
33+
font-size: 0.65rem;
34+
font-style: italic;
35+
}
36+
37+
.software-gpus {
38+
font-size: 0.65rem;
39+
font-style: italic;
40+
}
41+
42+
.software-cpu-amd {
43+
display: inline-block;
44+
padding: 0.15em 0.5em;
45+
border-radius: 0.8em;
46+
font-size: 0.8em;
47+
font-style: normal;
48+
background-color: rgb(0,0,0); /* https://www.brandcolorcode.com/advanced-micro-devices-amd */
49+
color: var(--md-primary-bg-color);
50+
margin-right: 0.3em;
51+
}
52+
53+
.software-cpu-arm {
54+
display: inline-block;
55+
padding: 0.15em 0.5em;
56+
border-radius: 0.8em;
57+
font-size: 0.8em;
58+
font-style: normal;
59+
background-color: rgb(0,145,189); /* https://www.brandcolorcode.com/arm-company */
60+
color: var(--md-primary-bg-color);
61+
margin-right: 0.3em;
62+
}
63+
64+
.software-cpu-intel {
65+
display: inline-block;
66+
padding: 0.15em 0.5em;
67+
border-radius: 0.8em;
68+
font-size: 0.8em;
69+
font-style: normal;
70+
background-color: rgb(0,199,253); /* https://www.brandcolorcode.com/intel */
71+
color: rgb(0,0,0);
72+
margin-right: 0.3em;
73+
}
74+
75+
.software-cpu-riscv {
76+
display: inline-block;
77+
padding: 0.15em 0.5em;
78+
border-radius: 0.8em;
79+
font-size: 0.8em;
80+
font-style: normal;
81+
background-color: rgb(253,181,21); /* https://riscv.org/about/brand-guidelines */
82+
color: rgb(0,50,98);
83+
margin-right: 0.3em;
84+
}
85+
86+
.software-gpu-amd {
87+
display: inline-block;
88+
padding: 0.15em 0.5em;
89+
border-radius: 0.8em;
90+
font-size: 0.8em;
91+
font-style: normal;
92+
background-color: rgb(0,0,0); /* https://www.brandcolorcode.com/advanced-micro-devices-amd */
93+
color: var(--md-primary-bg-color);
94+
margin-right: 0.3em;
95+
}
96+
97+
.software-gpu-nvidia {
98+
display: inline-block;
99+
padding: 0.15em 0.5em;
100+
border-radius: 0.8em;
101+
font-size: 0.8em;
102+
font-style: normal;
103+
background-color: rgb(118,185,0); /* https://www.brandcolorcode.com/nvidia */
104+
color: rgb(0,0,0);
105+
margin-right: 0.3em;
106+
}
107+
108+
.software-eessi-versions {
109+
font-size: 0.65rem;
110+
font-style: italic;
111+
}
112+
113+
.software-eessi-version-202306 {
114+
display: inline-block;
115+
padding: 0.15em 0.5em;
116+
border-radius: 0.8em;
117+
font-size: 0.8em;
118+
font-style: normal;
119+
background-color: darkslateblue; /* https://www.w3schools.com/cssref/css_colors.php */
120+
color: var(--md-primary-bg-color);
121+
margin-right: 0.3em;
122+
}
123+
124+
.software-eessi-version-202506 {
125+
display: inline-block;
126+
padding: 0.15em 0.5em;
127+
border-radius: 0.8em;
128+
font-size: 0.8em;
129+
font-style: normal;
130+
background-color: darkslategrey; /* https://www.w3schools.com/cssref/css_colors.php */
131+
color: var(--md-primary-bg-color);
132+
margin-right: 0.3em;
133+
}

docs/available_software/css/style_table.css

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

docs/available_software/data/.gitkeep

Whitespace-only changes.

docs/available_software/data/json_data.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/available_software/data/json_data_detail.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)