Skip to content

Commit 4bc0514

Browse files
committed
line breaks
1 parent 99f1a50 commit 4bc0514

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

pages/shelley-howto.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ shelley find bwa-mem2
4343
![](assets/img/shelley_find_bwa-mem2.png)
4444
<br>
4545
</details>
46-
46+
<br>
4747

4848
**2.** Build a loadable module
4949

@@ -56,6 +56,7 @@ shelley build bwa-mem2/2.3
5656
![](assets/img/shelley_build_bwa-mem2.png)
5757
<br>
5858
</details>
59+
<br>
5960

6061
**3.** Confirm the module was built succesfully
6162

@@ -68,6 +69,7 @@ module avail
6869
![](assets/img/module_avail.png)
6970
<br>
7071
</details>
72+
<br>
7173

7274
**4.** Load the module
7375

@@ -127,6 +129,7 @@ Shelley builds each tool in the file in sequence, showing a progress table as it
127129
![](assets/img/shelley_build_tools-txt.png)
128130
<br>
129131
</details>
132+
<br>
130133

131134
**3.** If a tool has more than one build for the same version (for example, several
132135
`--hash` builds of `samtools/1.21`), Shelley pauses and asks you to pick one.
@@ -136,6 +139,7 @@ Shelley builds each tool in the file in sequence, showing a progress table as it
136139
![](assets/img/shelley_build_multiple-builds-prompt.png)
137140
<br>
138141
</details>
142+
<br>
139143

140144
Use the arrow keys to select a build, then press Enter to continue the batch.
141145

@@ -151,6 +155,7 @@ module avail
151155
![](assets/img/shelley_build_tools-txt_summary.png)
152156
<br>
153157
</details>
158+
<br>
154159

155160
```
156161
---------------------------------------------------------- /apps/Modules/modulefiles ----------------------------------------------------------
@@ -180,6 +185,7 @@ shelley find fastqc -v
180185
![](assets/img/shelley_find_fastqc_v.png)
181186
<br>
182187
</details>
188+
<br>
183189

184190
Each row corresponds to one `--hash` build of a version, with its buildable/installed
185191
status and the path you can copy into a config file, such as:
@@ -222,6 +228,7 @@ docker.io/library/busybox:1.34: removed 90 shared paths.
222228
![](assets/img/shelley_build_bowtie2_unregistered.png)
223229
<br>
224230
</details>
231+
<br>
225232

226233
If the version is missing from the upstream registry, Shelley creates a local registry
227234
entry from the CVMFS container itself and retries the install. This is transparent and
@@ -253,6 +260,7 @@ curation, all of these would be exposed by the module:
253260
![](assets/img/shelley_build_vcftools_alias-select-all.png)
254261
<br>
255262
</details>
263+
<br>
256264

257265
**2.** Type to filter the list down to the ones relevant to `vcftools`, for example `vcf`:
258266

@@ -261,6 +269,7 @@ curation, all of these would be exposed by the module:
261269
![](assets/img/shelley_build_vcftools_alias-filter-vcf.png)
262270
<br>
263271
</details>
272+
<br>
264273

265274
**3.** Toggle each one you want with space, then press Enter once they're all selected:
266275

@@ -269,6 +278,7 @@ curation, all of these would be exposed by the module:
269278
![](assets/img/shelley_build_vcftools_alias-selected.png)
270279
<br>
271280
</details>
281+
<br>
272282

273283
**4.** Shelley then asks whether to add or rename any aliases. Answer `n` to both to keep
274284
the selection as-is:
@@ -285,4 +295,5 @@ the selection as-is:
285295
![](assets/img/shelley_build_vcftools_complete.png)
286296
<br>
287297
</details>
298+
<br>
288299

pages/tools.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ You will see a list of available commands.
9191
![](assets/img/shelley_help.png)
9292
<br>
9393
</details>
94+
<br>
9495

9596
#### Finding a tool you already know by name
9697

@@ -105,6 +106,7 @@ shelley find fastqc
105106
![](assets/img/shelley_find_fastqc.png)
106107
<br>
107108
</details>
109+
<br>
108110

109111
Shelley returns the tool's description together with its most recent container versions,
110112
plus whether it is installed as a module yet. `find` is forgiving about
@@ -129,6 +131,7 @@ Each result will show you the tool name and a brief description of what it does.
129131
![](assets/img/shelley_search_de-novo-assembly.png)
130132
<br>
131133
</details>
134+
<br>
132135

133136
{% include callout.html type="note" content="Search is under active development. All results are broad, and currently presented alphabetically. We recommend using shorter and more specific phrases as each extra word broadens the match rather than narrowing it, so a broad query like &quot;dna sequence quality control&quot; can return a large number of tools. Use the fewest, most specific terms you know, and remove words rather than adding them if you get too many results." %}
134137

@@ -147,6 +150,7 @@ shelley find fastqc -v
147150
![](assets/img/shelley_find_fastqc_v.png)
148151
<br>
149152
</details>
153+
<br>
150154

151155
### Building a module
152156

@@ -163,6 +167,7 @@ This installs the most recent available version by default.
163167
![](assets/img/shelley_build_fastqc.png)
164168
<br>
165169
</details>
170+
<br>
166171

167172
{% include callout.html type="tip" content="To install a specific version instead of the most recent one, give `build` the same `<tool>/<version>` spec that `find -v` showed you, for example `shelley build fastqc/0.12.1`." %}
168173

0 commit comments

Comments
 (0)