Skip to content

Commit a4dde78

Browse files
committed
Modify biocontainer snippet.
1 parent 3243b18 commit a4dde78

4 files changed

Lines changed: 13 additions & 6 deletions

File tree

docs/snippets/examples/apps/apptainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Template snippet: {cluster} = lowercase cluster name (e.g. "{cluster}"). Replaced at build time by `apptainer` in main.py. -->
1+
<!-- Template snippet: {CLUSTER} = title-case cluster name (e.g. "{CLUSTER}"), {cluster} = lowercase (e.g. "{cluster}"). Replaced at build time by `apptainer_snippet` in main.py. -->
22
# Apptainer
33

44
!!! note

docs/snippets/examples/apps/biocontainers.md

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

34
## What is BioContainers?
@@ -6,13 +7,13 @@ The BioContainers project came from the idea of using the containers-based techn
67

78
## Getting Started
89

9-
Users can download bioinformatic containers from the [BioContainers.pro](https://biocontainers.pro) and run them directly using Singularity instructions from the corresponding container’s catalog page.
10+
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.
1011

11-
Brief Singularity guide and examples are available at the [Bell Singularity user guide](singularity.md) page. Detailed Singularity 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: [sylabs.io/guides/3.8/user-guide](https://sylabs.io/guides/3.8/user-guide/)
1213

1314
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.
1415

15-
On Bell, type the command below to see the lists of biocontainers we deployed.
16+
On {CLUSTER}, type the command below to see the lists of biocontainers we deployed.
1617

1718
```
1819
module load biocontainers

docs/userguides/bell/run/examples/apps/biocontainers.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/biocontainers.md"
11+
{{ biocontainers_snippet(resource) }}
1212

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

main.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,13 @@ def apptainer_snippet(resource):
702702
with open("docs/snippets/examples/apps/apptainer.md", "r") as f:
703703
content = f.read()
704704
return content.replace("{CLUSTER}", resource.title()).replace("{cluster}", resource.lower())
705-
705+
706+
@env.macro
707+
def biocontainers_snippet(resource):
708+
with open("docs/snippets/examples/apps/biocontainers.md", "r") as f:
709+
content = f.read()
710+
return content.replace("{CLUSTER}", resource.title()).replace("{cluster}", resource.lower())
711+
706712
@env.macro
707713
def resource_use(resource):
708714
with open("docs/snippets/resourceuse.md", "r") as f:

0 commit comments

Comments
 (0)