You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/tools.md
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ samtools --version
61
61
62
62
sHPC turns containers into clean, versioned modules without requiring you to know how containers work. On BioShell, sHPC should be configured so that installations point at containers already present in CVMFS, so nothing is re-downloaded.
63
63
64
-
###Introducing Shelley :turtle: {#Shelley}
64
+
## Introducing Shelley :turtle: {#Shelley}
65
65
66
66
Working with CVMFS paths and sHPC registry recipes by hand is tedious and error-prone,
67
67
particularly for older tool versions not listed in the standard registry. **Shelley** is
@@ -71,7 +71,7 @@ entries, and runs the sHPC install, all from a single command.
71
71
72
72
{% include callout.html type="tip" content="**Recommended:** use Shelley rather than sHPC directly. The rest of this guide walks through how Shelley can be used to find, install, and run tools without interacting with the CVMFS or sHPC directly!" %}
73
73
74
-
## Getting started with Shelley {#getting-started-with-shelley}
74
+
###Getting started with Shelley {#getting-started-with-shelley}
75
75
76
76
Shelley indexes **over 700 tools and 118,000 container versions** from the BioContainers
77
77
catalogue, and you can run it directly from the command line or in an interactive mode.
Each result will show you the tool name and a brief description of what it does. **Shorter and more species phrases tend to work better than full sentences.**
117
+
Each result will show you the tool name and a brief description of what it does. **Shorter, more specific phrases tend to work better than full sentences.**
118
118
119
-
120
-
{% include callout.html type="note" content="Search is under active development. Results are currently alphabetical rather than ranked by relevance." %}
121
-
TODO: Also returns a lot of files.
119
+
{% 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 "dna sequence quality control" 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." %}
122
120
123
121
### Checking every available version
124
122
@@ -127,7 +125,7 @@ an exact version for reproducibility, or to match a pipeline's requirements, you
127
125
`-v` (verbose) flag to see every available container, sorted newest-first:
128
126
129
127
```bash
130
-
shelley find fastq -v
128
+
shelley find fastqc -v
131
129
```
132
130
133
131
TODO: Add screenshot
@@ -142,10 +140,9 @@ shelley build fastqc
142
140
143
141
This installs the most recent available version by default.
144
142
145
-
146
143
TODO: screenshot
147
144
148
-
TODO: Call out tip: to use `build` <tool>/<version>` for a specific version install.
145
+
{% 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`." %}
0 commit comments