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
+15-17Lines changed: 15 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: How to find, install, and load bioinformatics tools and reference d
7
7
BioShell instances arrive with bioinformatics software and some reference data already installed. You don't have to compile tools, manage dependencies, or track down
8
8
container images before you can start.
9
9
10
-
## What's already installed {#preinstalled}
10
+
## What's installed {#preinstalled}
11
11
12
12
Every instance comes with a core set of tools:
13
13
@@ -29,28 +29,26 @@ module avail
29
29
```
30
30
31
31
Then load what you need, for example `module load jupyter` or `module load rstudio`. Anything
32
-
not listed, you can install yourself with Shelley.
32
+
not listed, you can install yourself with [**Shelley**](tutorials/shelley-howto).
33
33
34
-
## How BioShell manages tools {#tooling-stack}
34
+
## How BioShell manages bioinformatics software {#tooling-stack}
35
35
36
-
BioShell manages tools in three layers so you don't have to:
36
+
Bioinformatics often requires us to use many different software including command-line software, R and Python packages. BioShell gives you access to over 100,000 bioinformatics packages, managed in three layers for you:
37
37
38
-
-**[CernVM-FS](https://cvmfs.readthedocs.io/en/stable/)** holds 13,000+ tools and 118,000+
39
-
versions from [BioContainers](https://biocontainers.pro/registry) in one shared repository and mounted read-only at `/cvmfs/`. It looks like an ordinary folder, and files
40
-
are fetched only when you use them, so they don't count against your disk.
41
-
-**[sHPC](https://singularity-hpc.readthedocs.io/)** translates those containers into modules
42
-
that Lmod understands.
43
-
-**[Lmod](https://lmod.readthedocs.io/en/latest/)** lets you load and switch between tools with
44
-
simple `module` commands.
38
+
-**[CernVM-FS](https://cvmfs.readthedocs.io/en/stable/)** is a read only filesystem that acts as a repository for 13,000+ tools and 118,000+
39
+
versions from [BioContainers](https://biocontainers.pro/registry). It is available in your BioShell VM at `/cvmfs/`. It looks like an ordinary folder, and files
40
+
are fetched only when you use them, to help you manage your disk space.
41
+
-**[sHPC](https://singularity-hpc.readthedocs.io/)** packages containers in cvmfs into installable modules
42
+
-**[Lmod](https://lmod.readthedocs.io/en/latest/)** is the system behind the `module` command you use to load and switch tools
45
43
46
-
**Shelley**, BioShell's command-line assistant, drives all three for you. It searches the
47
-
tools, picks the right container version, creates any sHPC registry entry that is
48
-
missing, and installs the module: one command to find a tool, one to install it. You never need
49
-
to know container syntax or work with CernVM-FS and sHPC directly.
44
+
You don't need to undersand any of this to use BioShell because **Shelley**, BioShell's command-line assistant, drives all three for you. She:
50
45
51
-

52
-
*Fig 1. Shelley finds a tool in CernVM-FS, installs it with sHPC, and gives you a module to load.*
46
+
* Searches the tool library
47
+
* Picks the right container version
48
+
* Creates any sHPC registry entry that is missing
49
+
* Installs the module: one command to find a tool, one to install it
53
50
51
+

54
52
55
53
## Finding and installing tools with Shelley :turtle: {#getting-started-with-shelley}
0 commit comments