Skip to content

Commit dd6d90f

Browse files
committed
Updating tooling docs - clean up advanced into dropbox
1 parent 9d94b36 commit dd6d90f

1 file changed

Lines changed: 18 additions & 21 deletions

File tree

pages/tools.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -84,29 +84,18 @@ catalogue. You can run it directly from the command line or in interactive mode.
8484
**From the command line:**
8585

8686
```bash
87-
shelley-bio find <tool>
88-
shelley-bio search "<function>"
89-
shelley-bio versions <tool>
90-
shelley-bio build <tool>
87+
shelley-bio find <tool> # Look up a specific tool by name
88+
shelley-bio search "<function>" # Search by keyword or function
89+
shelley-bio versions <tool> # List all available versions
90+
shelley-bio build <tool> # Install the tool as a loadable module
9191
```
9292

9393
**In interactive mode:**
9494

9595
```bash
96-
shelley-bio interactive
96+
shelley-bio interactive # Launch Shelley-Bio in interactive mode
9797
```
9898

99-
| Command | What it does | Example |
100-
| ------------------------ | -------------------------------------- | -------------------------------------- |
101-
| `find <tool>` | Look up a specific tool by name | `shelley-bio find fastqc` |
102-
| `search "<function>"` | Search by keyword or function | `shelley-bio search "quality control"` |
103-
| `versions <tool>` | List all available versions | `shelley-bio versions samtools` |
104-
| `build <tool[/version]>` | Install the tool as a loadable module | `shelley-bio build samtools/1.21` |
105-
| `interactive` | Launch Shelley-Bio in interactive mode | `shelley-bio interactive` |
106-
107-
The `build` command handles the full installation automatically: it finds the correct container
108-
in CVMFS, generates the module file, and makes the tool ready to load.
109-
11099
**Example: installing `samtools`**
111100

112101
```bash
@@ -140,19 +129,19 @@ for anything older than the latest release), you also need to check CVMFS direct
140129
image, compute its checksum, fetch the registry YAML, edit it to add the missing version,
141130
create and register a local registry, ensure it takes precedence, then run the install.
142131

143-
With Shelley-Bio, regardless of whether the version is in the registry or not:
132+
With Shelley-Bio, regardless of whether the version is in the sHPC registry or not it handles the registry check, CVMFS path resolution, local entry creation, and the sHPC installation.
144133

145134
```bash
146135
shelley-bio build samtools/1.20
147136
```
148137

149-
Shelley-Bio handles the registry check, CVMFS path resolution, local entry creation if
150-
needed, and the sHPC install call. The result is identical: a working `module load` command,
138+
The result is identical: a working `module load` command,
151139
without requiring you to know how the underlying machinery works.
152140

153141
> **Tip:** If Shelley-Bio cannot find a tool, fall back to the manual sHPC method below.
154142
155-
### Advanced: manual installation {#shpc-manual}
143+
<details markdown="1" id="shpc-manual">
144+
<summary>Advanced: manual installation</summary>
156145

157146
#### Using sHPC directly {#shpc-direct}
158147

@@ -172,6 +161,12 @@ shpc show -f plink
172161
shpc show quay.io/biocontainers/plink
173162
```
174163

164+
**Verify container path on CVMFS:**
165+
166+
```bash
167+
ls /cvmfs/singularity.galaxyproject.org/all/plink*
168+
```
169+
175170
**Install a module directly from CVMFS:**
176171

177172
```bash
@@ -181,7 +176,7 @@ shpc install quay.io/biocontainers/plink:1.90b7.7--h18e278d_1 \
181176
```
182177

183178
The `--keep-path` flag tells sHPC to use the container already present in CVMFS rather than
184-
downloading a fresh copy.
179+
downloading a fresh copy. The tag numbers must match.
185180

186181
**Load and use the module:**
187182

@@ -256,6 +251,8 @@ sudo shpc install quay.io/biocontainers/plink:1.90b4--h0a6d026_2 \
256251
> **Tip:** If Shelley-Bio recognises the container path but the version is not in the
257252
> registry, `shelley-bio build` handles the local registry creation automatically.
258253
254+
</details>
255+
259256
---
260257

261258
## Loading modules {#load-tool}

0 commit comments

Comments
 (0)