Quickstart

Get started with THOA in just a few minutes, no infrastructure setup required.

1. Install

We also recommend using a virtual environment to manage system-level Python package installations.

pip install thoa

Next Step

After installing the client, create and save your API key to link your local THOA client with your workspace and securely manage your jobs and data.

2. Launch Your First Job

Once your API key is configured, you’re ready to run your first job.

The run command lets you execute containerized bioinformatics tools directly from your terminal.
Here’s a simple hello-world example to get started:

thoa run \
  --cmd "nextflow run hello" \
  --tools nextflow \
  --output ./ \
  --storage 2 \
  --n-cores 1 \
  --ram 2

Flag	Description
`--cmd`	The command to run inside the container
`--tools`	Which tool(s) or environments to load
`--output`	Where to place output files
`--storage`	GB of disk space to allocate
`--n-cores`	Number of CPU cores to use
`--ram`	GB of RAM to allocate

This command will:

Provision a temporary compute environment with 1 core, 2 GB RAM, and 2 GB storage
Load the specified tools (nextflow) into the container (currently Conda inside Docker. Support for other environments coming soon)
Run nextflow run hello inside the container
Write output files to ./

If you want a full breakdown of all available command flags and examples, see the CLI documentation.