Skip to content

Commit b7fa595

Browse files
committed
Add BioShell context pages
1 parent 06e434c commit b7fa595

3 files changed

Lines changed: 103 additions & 0 deletions

File tree

_data/sidebars/main.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
subitems:
22
- title: Home
33
url: /index
4+
- title: Why BioShell?
5+
url: /why-bioshell
6+
subitems:
7+
- title: What is a virtual machine?
8+
url: /why-bioshell#what-is-a-vm
9+
- title: Cloud vs HPC
10+
url: /why-bioshell#cloud-vs-hpc
11+
- title: Why BioShell?
12+
url: /why-bioshell#why-bioshell
13+
- title: BioShell and HPC
14+
url: /why-bioshell#bioshell-and-hpc
415
- title: Accessing BioShell
516
url: /access
617
subitems:

index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ the BioCommons Training cooperative and
3838

3939
## Quick start guide
4040

41+
> **Tip:** New to cloud computing or virtual machines? Read [Why use a cloud workspace?](why-bioshell)
42+
> first — it explains what BioShell is, how it compares to HPC, and whether it is right for your work.
43+
4144
1. [Check you are eligible](access#eligibility) — confirm your project is life-science
4245
related and aligns with the five ABLeS principles.
4346
2. [Identify your access pathway](access#pathways) — most users apply through

pages/why-bioshell.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Why use a cloud workspace for bioinformatics?
3+
description: An introduction to virtual machines, cloud computing, and why BioShell is a great starting point for life-science researchers and workshop participants.
4+
---
5+
6+
If you are new to bioinformatics or planning a workshop, this page explains what cloud
7+
computing is, when to use it, and why BioShell makes it easy to get started.
8+
9+
---
10+
11+
## What is a virtual machine? {#what-is-a-vm}
12+
13+
A virtual machine is a computer that runs inside another computer — delivered to you over the
14+
internet. You connect to it from your laptop or desktop, and it behaves like a full computer
15+
you have complete control over. You do not need to worry about your own hardware specs,
16+
operating system, or software installation.
17+
18+
> Think of it like a fully-equipped lab bench that is always ready — you just sit down and
19+
> start working, then leave when you are done. The bench does not belong to you, but it is
20+
> set up exactly the way you need it.
21+
22+
With a virtual machine you can:
23+
24+
- Get more computing power than your laptop for data analysis
25+
- Share the same environment with colleagues or workshop participants
26+
- Run long jobs overnight without worrying about power outages or closing your laptop
27+
- Use a Linux environment even if you normally use Windows or macOS
28+
- Have administrator access to install software and configure the system
29+
- Host services such as databases or web servers
30+
31+
---
32+
33+
## Cloud vs HPC — which should I use? {#cloud-vs-hpc}
34+
35+
Both cloud computing and High-Performance Computing (HPC) systems such as NCI Gadi are
36+
powerful research tools, but they suit different types of work.
37+
38+
| | Cloud (BioShell) | HPC (e.g. NCI Gadi) |
39+
|--|-----------------|---------------------|
40+
| **Session type** | Interactive — work in real time | Batch — submit jobs and come back later |
41+
| **Interfaces** | JupyterLab, RStudio, CLI | CLI only (PBS/Slurm schedulers) |
42+
| **Setup required** | None — environment is preconfigured | Familiarity with job schedulers required |
43+
| **Best for** | Learning, workshops, exploratory analysis | Large-scale, tightly coupled, or long-running workloads |
44+
| **Scaling** | Flexible — choose your VM size on demand | Fixed allocations managed through project quotas |
45+
46+
**Not sure which to use?** If you are learning bioinformatics, running a workshop, or
47+
exploring a new analysis, start with cloud. BioShell is the right choice. You can move to
48+
HPC later once your workflow is established and you need more compute power.
49+
50+
---
51+
52+
## Why BioShell? {#why-bioshell}
53+
54+
Getting started on the command line is often the hardest part. Software installs break.
55+
Environments differ between computers. Trainers spend hours configuring machines instead of
56+
teaching. BioShell solves this.
57+
58+
| Feature | What it means for you |
59+
|---------|----------------------|
60+
| **Ready to use** | Over 20,000 bioinformatics tools and reference datasets available — no setup required |
61+
| **Consistent everywhere** | The same environment works identically on Nectar and NCI Nirin |
62+
| **Training-ready** | Trainers can provision dozens of identical machines for a workshop in minutes |
63+
| **Multiple interfaces** | Access via SSH, or use JupyterLab and RStudio in your browser |
64+
| **Reproducible** | Containerised software means your analysis works the same way today, next year, and on a colleague's machine |
65+
| **Safe to explore** | You have administrator access to your own VM — mistakes only affect your own instance |
66+
67+
---
68+
69+
## How does BioShell fit with HPC? {#bioshell-and-hpc}
70+
71+
BioShell is not a replacement for large-scale HPC — it complements it. Think of it as the
72+
place where you learn, develop, and test your workflows before scaling up.
73+
74+
1. **Learn and explore on BioShell** — get comfortable with the command line, tools, and
75+
your data in a low-pressure environment.
76+
2. **Develop and test your workflow** — build and validate your Nextflow or Snakemake
77+
pipeline using BioShell's pre-installed tools and example datasets.
78+
3. **Scale up to HPC when ready** — once your workflow is confirmed and your data needs are
79+
clear, move to NCI Gadi or another HPC system for large-scale runs.
80+
81+
---
82+
83+
## Ready to get started? {#get-started}
84+
85+
BioShell is available to Australian life-science researchers, trainers, and developers
86+
through [ABLeS](https://australianbiocommons.github.io/ables/). Access is free — you just
87+
need to be affiliated with an Australian research organisation.
88+
89+
[Check your eligibility and apply →](access#eligibility)

0 commit comments

Comments
 (0)