minor revision of roadmap, include links where useful

.github/workflows/script_module_list.yml

@@ -34,12 +34,6 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
-      - name: Make EESSI available
-        uses: eessi/github-action-eessi@v3
-      - name: Set up Python
-        uses: eessi/github-action-eessi@v3
-        with:
-          python-version: '3.7'
       - name: Install dependencies
         run: |
           python -m venv venv

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
         check_filenames: true
         # MarkDown files in docs/available_software/detail are skipped because they are auto-generated
         skip: '*.pdf,.git,*.json,./docs/available_software/detail/*.md'
-        ignore_words_list: Fram,fram,ND,nd
+        ignore_words_list: Fram,fram,ND,nd,Linz
 
     # - name: Markdown Linting Action
     #   uses: avto-dev/markdown-lint@v1.2.0

.github/workflows/test_overview_available_software.yml

@@ -23,6 +23,24 @@ jobs:
           # install required Python packages in virtual environment
           python -m venv venv
           . venv/bin/activate
-          pip install -r mkdocs-ldjson-plugin/requirements.txt
+          pip install -r scripts/available_software/requirements.txt
 
-          python .github/workflows/scripts/test_overview_available_software.py
+          # download https://eessi.io/api_data/data/eessi_api_metadata_software.json
+          # to where it's expected by docs/available_software/macros.py and scripts/available_software/available_software.py
+          data_dir="docs/available_software/data"
+          mkdir -p ${data_dir}
+          cd ${data_dir}
+          curl -OL https://eessi.io/api_data/data/eessi_api_metadata_software.json
+          cd -
+
+          python scripts/available_software/available_software.py
+          ./scripts/update_generated_time.sh mkdocs.yml
+
+          # determine whether pull request would need to be opened:
+          # if detailed software pages in docs/available_software/detail have been updated, then a PR should be opened
+          if [[ $(git status --porcelain ./docs/available_software/detail) ]]; then
+            echo "Software pages have been changed, PR should be opened"
+            git diff ./docs/available_software/detail
+          else
+            echo "Software pages have not been changed, no need to open PR"
+          fi

.github/workflows/update_available_software.yml

@@ -17,11 +17,6 @@ jobs:
           python-version: '3.10'
           architecture: x64
 
-      - name: Mount EESSI
-        uses: eessi/github-action-eessi@e1f8f20638ea417a18d23ab29443ee34794ff900 # v3.1.0
-        with:
-          eessi_stack_version: '2023.06'
-
       - name: update overview of available software
         id: update_available_software
         run: |
@@ -30,30 +25,31 @@ jobs:
           . venv/bin/activate
           pip install -r scripts/available_software/requirements.txt
 
-          # copy current JSON data, so we can compare after updating it
-          cp docs/available_software/data/json_data.json docs/available_software/data/json_data.json.orig
-          cp docs/available_software/data/json_data_detail.json docs/available_software/data/json_data_detail.json.orig
+          # download https://eessi.io/api_data/data/eessi_api_metadata_software.json
+          # to where it's expected by docs/available_software/macros.py and scripts/available_software/available_software.py
+          data_dir="docs/available_software/data"
+          mkdir -p ${data_dir}
+          cd ${data_dir}
+          curl -OL https://eessi.io/api_data/data/eessi_api_metadata_software.json
+          cd -
 
-          export TIME_GENERATED_TEMPLATE="{{ generated_time }}"
           python scripts/available_software/available_software.py
           ./scripts/update_generated_time.sh mkdocs.yml
-          
+
           git status
 
           # determine whether pull request should be opened:
-          # if JSON files in docs/available_software/data have been updated, then a PR should be opened
-          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)
-          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)
-          if [[ ${json_data_changed} == "no changes" ]] && [[ ${json_data_detail_changed} == "no changes" ]]; then
-            echo "JSON files in docs/available_software/data have not been changed, no need to open PR"
-            echo "json_data_changed=no" >> $GITHUB_OUTPUT
-          else
-            echo "JSON files in docs/available_software/data have been changed, PR should be opened"
+          # if detailed software pages in docs/available_software/detail have been updated, then a PR should be opened
+          if [[ $(git status --porcelain ./docs/available_software/detail) ]]; then
+            echo "Software pages have been changed, PR should be opened"
             echo "json_data_changed=yes" >> $GITHUB_OUTPUT
+          else
+            echo "Software pages have not been changed, no need to open PR"
+            echo "json_data_changed=no" >> $GITHUB_OUTPUT
           fi
 
-          # remove original JSON files, or they'll end up in the PR being opened
-          rm -f docs/available_software/data/json_data.json.orig  docs/available_software/data/json_data_detail.json.orig
+          # remove the JSON file in the data directory, or it'll end up in the PR being opened
+          rm -r ${data_dir}/*.json
 
       - name: create pull request
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8

docs/adding_software/opening_pr.md

@@ -18,7 +18,8 @@ To add software to EESSI, you should go through the semi-automatic software inst
 ### Preparation
 
 Before you can make a pull request to the [software-layer](https://github.com/EESSI/software-layer),
-you should [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository in your GitHub account.
+you should [fork](https://github.com/EESSI/software-layer/fork) the repository in your GitHub account.
+Please see [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for details. Once forked, you can proceed.
 
 For the remainder of these instructions, we assume that your GitHub account is `@koala` :koala:.
 

docs/available_software/css/software.css

@@ -0,0 +1,133 @@
+/*
+ * CSS stylesheet for software overview, see docs/available_software/
+ */
+
+.software-name {
+  font-size: 0.9rem;
+  font-weight: 700;
+  color: var(--md-primary-fg-color);
+}
+
+.software-versions {
+  font-size: 0.6rem;
+  font-style: italic;
+  margin-left: 0.2rem;
+}
+
+.software-link a {
+  font-size: 0.6rem;
+  color: var(--md-typeset-a-color);
+}
+
+.software-more-info a {
+  float: right;
+  font-size: 0.6rem;
+  font-style: italic;
+}
+
+.software-description {
+  font-size: 0.7rem;
+}
+
+.software-cpus {
+  font-size: 0.65rem;
+  font-style: italic;
+}
+
+.software-gpus {
+  font-size: 0.65rem;
+  font-style: italic;
+}
+
+.software-cpu-amd {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(0,0,0); /* https://www.brandcolorcode.com/advanced-micro-devices-amd */
+  color: var(--md-primary-bg-color);
+  margin-right: 0.3em;
+}
+
+.software-cpu-arm {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(0,145,189); /* https://www.brandcolorcode.com/arm-company */
+  color: var(--md-primary-bg-color);
+  margin-right: 0.3em;
+}
+
+.software-cpu-intel {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(0,199,253); /* https://www.brandcolorcode.com/intel */
+  color: rgb(0,0,0);
+  margin-right: 0.3em;
+}
+
+.software-cpu-riscv {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(253,181,21); /* https://riscv.org/about/brand-guidelines */
+  color: rgb(0,50,98);
+  margin-right: 0.3em;
+}
+
+.software-gpu-amd {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(0,0,0); /* https://www.brandcolorcode.com/advanced-micro-devices-amd */
+  color: var(--md-primary-bg-color);
+  margin-right: 0.3em;
+}
+
+.software-gpu-nvidia {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: rgb(118,185,0); /* https://www.brandcolorcode.com/nvidia */
+  color: rgb(0,0,0);
+  margin-right: 0.3em;
+}
+
+.software-eessi-versions {
+  font-size: 0.65rem;
+  font-style: italic;
+}
+
+.software-eessi-version-202306 {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: darkslateblue; /* https://www.w3schools.com/cssref/css_colors.php */
+  color: var(--md-primary-bg-color);
+  margin-right: 0.3em;
+}
+
+.software-eessi-version-202506 {
+  display: inline-block;
+  padding: 0.15em 0.5em;
+  border-radius: 0.8em;
+  font-size: 0.8em;
+  font-style: normal;
+  background-color: darkslategrey; /* https://www.w3schools.com/cssref/css_colors.php */
+  color: var(--md-primary-bg-color);
+  margin-right: 0.3em;
+}

docs/available_software/detail/AITW-microstructures.md

@@ -0,0 +1,87 @@
+---
+json_ld:
+  '@context': https://schema.org
+  '@type': SoftwareApplication
+  applicationCategory: DeveloperApplication
+  description: 'AI-TranspWood - Generate realistic microstructure models of wood (birch,
+    spruce, etc.) from a set of
+
+    given parameters. This is a port of the original MATLAB code to Python.
+
+    '
+  license: Not confirmed
+  name: AITW-microstructures
+  offers:
+    '@type': Offer
+    price: 0
+  operatingSystem: LINUX
+  review:
+    '@type': Review
+    author:
+      '@type': Organization
+      name: EESSI
+    reviewBody: Application has been successfully made available on all architectures
+      supported by EESSI
+    reviewRating:
+      '@type': Rating
+      ratingValue: 5
+  softwareRequirements: See https://www.eessi.io/docs/ for how to make EESSI available
+    on your system
+  softwareVersion: '[''1.0.0'']'
+  url: https://www.ai-transpwood-project.eu/
+---
+# AITW-microstructures
+
+
+AI-TranspWood - Generate realistic microstructure models of wood (birch, spruce, etc.) from a set of
+given parameters. This is a port of the original MATLAB code to Python.
+
+
+<small>homepage: </small><span class="software-link">[https://www.ai-transpwood-project.eu/](https://www.ai-transpwood-project.eu/)</span>
+
+## Available installations
+
+
+|AITW-microstructures version|Supported CPU targets|Supported GPU targets|EESSI version|Module|
+| --- | --- | --- | --- | --- |
+|1.0.0|`generic`: `aarch64`, `x86_64`<br/><span class="software-cpu-arm">Arm</span>: `a64fx`, `neoverse_n1`, `neoverse_v1`, `nvidia/grace`<br/><span class="software-cpu-amd">AMD</span>: `zen2`, `zen3`, `zen4`<br/><span class="software-cpu-intel">Intel</span>: `haswell`, `skylake_avx512`, `sapphirerapids`, `icelake`, `cascadelake`<br/>|*(none)*|<span class="software-eessi-version-202306">2023.06</span>|`AITW-microstructures/1.0.0-foss-2023a`|
+
+## Extensions
+
+Overview of extensions included in AITW-microstructures installations
+
+
+### AITW-microstructures
+
+
+|`AITW-microstructures` version|AITW-microstructures modules that include it|
+| --- | --- |
+|1.0.0|`AITW-microstructures/1.0.0-foss-2023a`|
+
+### nptyping
+
+
+|`nptyping` version|AITW-microstructures modules that include it|
+| --- | --- |
+|2.5.0|`AITW-microstructures/1.0.0-foss-2023a`|
+
+### pynrrd
+
+
+|`pynrrd` version|AITW-microstructures modules that include it|
+| --- | --- |
+|1.0.0|`AITW-microstructures/1.0.0-foss-2023a`|
+
+### textual
+
+
+|`textual` version|AITW-microstructures modules that include it|
+| --- | --- |
+|0.61.0|`AITW-microstructures/1.0.0-foss-2023a`|
+
+### trogon
+
+
+|`trogon` version|AITW-microstructures modules that include it|
+| --- | --- |
+|0.6.0|`AITW-microstructures/1.0.0-foss-2023a`|