Skip to content

Commit 44ff52f

Browse files
committed
Convert ROCm snippet to macro and fix Apptainer references
Make rocmcontainers a reusable macro-based snippet with {CLUSTER}/{cluster} placeholders, replace remaining Singularity wording with Apptainer, correct the biocontainers detailed-guide link to apptainer.org, and update the FAQ cache path to .apptainer.
1 parent a4dde78 commit 44ff52f

5 files changed

Lines changed: 13 additions & 6 deletions

File tree

docs/snippets/examples/apps/biocontainers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The BioContainers project came from the idea of using the containers-based techn
99

1010
Users can download bioinformatic containers from the [BioContainers.pro](https://biocontainers.pro) and run them directly using Apptainer instructions from the corresponding container’s catalog page.
1111

12-
Brief Apptainer guide and examples are available at the [{CLUSTER} Apptainer user guide](apptainer.md) page. Detailed Apptainer user guide is available at: [sylabs.io/guides/3.8/user-guide](https://sylabs.io/guides/3.8/user-guide/)
12+
Brief Apptainer guide and examples are available at the [{CLUSTER} Apptainer user guide](apptainer.md) page. Detailed Apptainer user guide is available at: [apptainer.org/docs/user/main](https://apptainer.org/docs/user/main/)
1313

1414
In addition, a subset of pre-downloaded biocontainers wrapped into convenient software modules are provided. These modules wrap underlying complexity and provide the same commands that are expected from non-containerized versions of each application.
1515

docs/snippets/examples/apps/rocmcontainers.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1+
<!-- Template snippet: {CLUSTER} = title-case cluster name (e.g. "{CLUSTER}"), {cluster} = lowercase (e.g. "{cluster}"). Replaced at build time by `rocmcontainers_snippet` in main.py. -->
12
# ROCm Containers Collection
23

34
## What is ROCm Containers?
45

5-
The AMD Infinity Hub contains a collection of advanced AMD GPU software containers and deployment guides for HPC, AI & Machine Learning applications, enabling researchers to speed up their time to science. Containerized applications run quickly and reliably in the high performance computing environment with full support of AMD GPUs. A collection of Infinity Hub tools were deployed to extend cluster capabilities and to enable powerful software and deliver the fastest results. By utilizing Singularity and Infinity Hub ROCm-enabled containers, users can focus on building lean models, producing optimal solutions and gathering faster insights. For more information, please visit [AMD Infinity Hub](https://web.archive.org/web/20230902021513/https://www.amd.com/en/technologies/infinity-hub/).
6+
The AMD Infinity Hub contains a collection of advanced AMD GPU software containers and deployment guides for HPC, AI & Machine Learning applications, enabling researchers to speed up their time to science. Containerized applications run quickly and reliably in the high performance computing environment with full support of AMD GPUs. A collection of Infinity Hub tools were deployed to extend cluster capabilities and to enable powerful software and deliver the fastest results. By utilizing Apptainer and Infinity Hub ROCm-enabled containers, users can focus on building lean models, producing optimal solutions and gathering faster insights. For more information, please visit [AMD Infinity Hub](https://web.archive.org/web/20230902021513/https://www.amd.com/en/technologies/infinity-hub/).
67

78
## Getting Started
89

9-
Users can download ROCm containers from the [AMD Infinity Hub](https://web.archive.org/web/20230902021513/https://www.amd.com/en/technologies/infinity-hub/) and run them directly using Singularity instructions from the corresponding container’s catalog page.
10+
Users can download ROCm containers from the [AMD Infinity Hub](https://web.archive.org/web/20230902021513/https://www.amd.com/en/technologies/infinity-hub/) and run them directly using Apptainer instructions from the corresponding container’s catalog page.
1011

1112
In addition, a subset of pre-downloaded ROCm containers wrapped into convenient software modules are provided. These modules wrap underlying complexity and provide the same commands that are expected from non-containerized versions of each application.
1213

13-
On Bell, type the command below to see the lists of ROCm containers we deployed.
14+
On {CLUSTER}, type the command below to see the lists of ROCm containers we deployed.
1415

1516
```
1617

docs/userguides/bell/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ There are several common locations that tend to grow large over time and are mer
7777
/home/myusername/.local/share/Trash
7878
/home/myusername/.cache/pip
7979
/home/myusername/.conda/pkgs
80-
/home/myusername/.singularity/cache
80+
/home/myusername/.apptainer/cache
8181
```
8282

8383
### My SSH connection hangs

docs/userguides/bell/run/examples/apps/rocmcontainers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ search:
88
boost: 2
99
---
1010

11-
--8<-- "docs/snippets/examples/apps/rocmcontainers.md"
11+
{{ rocmcontainers_snippet(resource) }}
1212

1313
[**Back to the Specific Applications section**](../apps.md)

main.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -709,6 +709,12 @@ def biocontainers_snippet(resource):
709709
content = f.read()
710710
return content.replace("{CLUSTER}", resource.title()).replace("{cluster}", resource.lower())
711711

712+
@env.macro
713+
def rocmcontainers_snippet(resource):
714+
with open("docs/snippets/examples/apps/rocmcontainers.md", "r") as f:
715+
content = f.read()
716+
return content.replace("{CLUSTER}", resource.title()).replace("{cluster}", resource.lower())
717+
712718
@env.macro
713719
def resource_use(resource):
714720
with open("docs/snippets/resourceuse.md", "r") as f:

0 commit comments

Comments
 (0)