Skip to content

Commit cfdf46b

Browse files
committed
DOC: Update shelley usage with bwa-mem2
Replaced the original samtools example with bwa-mem2 because the most recently updated samtools version contains multiple builds and does not exist in the shpc registry yet. bwa-mem2 has a straightforward installation
1 parent 5e96fe6 commit cfdf46b

4 files changed

Lines changed: 50 additions & 18 deletions

File tree

assets/img/module_avail.png

26.7 KB
Loading
50.3 KB
Loading
95.6 KB
Loading

pages/tools.md

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ catalogue. You can run it directly from the command line or in interactive mode.
8686
```bash
8787
shelley find <tool> # Look up a specific tool by name
8888
shelley search "<function>" # Search by keyword or function
89-
shelley versions <tool> # List all available versions
9089
shelley build <tool> # Install the tool as a loadable module
9190
```
9291

@@ -96,28 +95,61 @@ shelley build <tool> # Install the tool as a loadable module
9695
shelley interactive # Launch Shelley in interactive mode
9796
```
9897

99-
**Example: installing `samtools`**
98+
#### Example: installing `bwa-mem2`
99+
100+
Use `shelley` to look up `bwa-mem2` and the versions available for it:
101+
102+
```bash
103+
shelley find bwa-mem2
104+
```
105+
106+
<details markdown="1">
107+
<summary>Example output</summary>
108+
109+
![](assets/img/shelley_find_bwa-mem2.png)
110+
111+
</details>
112+
113+
Build a loadable module:
100114

101115
```bash
102-
shelley find samtools
103-
# samtools: Tools for manipulating next-generation sequencing data
104-
105-
shelley versions samtools
106-
# samtools/1.21
107-
# samtools/1.20
108-
# samtools/1.19.2
109-
# ...
110-
111-
shelley build samtools/1.21
112-
# Installing samtools/1.21 from CVMFS...
113-
# Module samtools/1.21 was created.
116+
shelley build bwa-mem2/2.3
114117
```
115118

116-
![](images/bioshell/SCREENSHOT_NEEDED_bioshelley_build.png)
119+
<details markdown="1">
120+
<summary>Example output</summary>
117121

118-
_Fig 3. Using `Shelley build samtools/1.21` to install a tool module._
122+
![](assets/img/shelley_build_bwa-mem2.png)
123+
124+
</details>
125+
126+
Confirm the module was built succesfully:
127+
128+
```bash
129+
module avail
130+
```
131+
132+
<details markdown="1">
133+
<summary>Example output</summary>
134+
135+
![](assets/img/module_avail.png)
136+
137+
</details>
138+
139+
Load the module:
140+
141+
```bash
142+
module load bwa-mem2
143+
```
144+
145+
Finally, run `bwa-mem2`:
146+
147+
```bash
148+
bwa-mem2 version
149+
# 2.2.1
150+
```
119151

120-
{% include callout.html type="tip" content="Use `Shelley search` when you know what you want to do but not the tool name. For example, `Shelley search 'variant calling'` returns tools relevant to that task." %}
152+
{% include callout.html type="tip" content="Use `shelley search` when you know what you want to do but not the tool name. For example, `shelley search 'variant calling'` returns tools relevant to that task." %}
121153

122154
### Why Shelley over manual sHPC? {#why-shelley}
123155

@@ -131,7 +163,7 @@ create and register a local registry, ensure it takes precedence, then run the i
131163
With Shelley, 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.
132164

133165
```bash
134-
shelley build samtools/1.20
166+
shelley build bwa-mem2/2.3
135167
```
136168

137169
The result is identical: a working `module load` command,

0 commit comments

Comments
 (0)