GPAS Client
The command line interface for the GPAS platform.
The client enables privacy-preserving sequence data submission and retrieval of analytical output files. Prior to upload, sample identifiers are anonymised and human host sequences are removed. A computer with Linux or MacOS is required to use the client. When running human read removal prior to upload a computer with a modern multi-core processor and at least 16GB of RAM is recommended.
Install
There are two recommended methods for installing the GPAS Client, either by installing as a python package or by using our publicly available Docker container which we build at release time.
pip install --upgrade gpas
A simple test to verify installation would be to run a version check:
gpas --version
gpas auth
GPAS client version: 3.1.3
Usage: gpas auth [OPTIONS]
Authenticate with GPAS.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --check-expiry Check for a current token and print the expiry if exists │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Most actions with the GPAS CLI require that the user have first authenticated with the GPAS server with their login credentials. Upon successfully authentication, a bearer token is stored in the user's home directory and will be used on subsequent CLI usage.
The token is valid for 7 days and a new token can be retrieved at anytime.
Usage
Running gpas auth will ask for your username and password for GPAS, your password will not be shown
in the terminal session.
$ gpas auth
GPAS client version 2.0.0rc1
Authenticating with portal.gpas.global
Enter your username: gpas-user@eit.org
Enter your password:
Authenticated (/Users/<user>/.config/gpas/tokens/portal.gpas.global.json)
Troubleshooting Authentication
How do I get an account for GPAS?
Creating a Personal Account:
Navigate to GPAS and click on “Sign Up”. Follow the instructions to create a user account.
Shortly after filling out the form you'll receive a verification email. Click the link in the email to verify your account and email address. If you don’t receive the email, please contact gpas.support@eit.org.
You are now ready to start using GPAS.
What happens when my token expires?
If you haven't already retrieved a token, you will receive the following error message.
$ gpas upload tests/data/illumina-2.csv
GPAS client version 2.0.0rc1
12:46:43 ERROR: FileNotFoundError: Token not found at /Users/<user>/.config/gpas/tokens/portal.gpas.global.json, have you authenticated?
If your token is invalid or expired, you will receive the following message
GPAS client version 2.0.0rc1
14:03:26 ERROR: AuthorizationError: Authorization checks failed! Please re-authenticate with `gpas auth` and
try again.
How can I check my token expiry before long running processes?
You can check the expiry of your token with the following command:
$ gpas auth --check-expiry
GPAS client version 2.0.0rc1
Current token for portal.gpas.global expires at 2024-08-13 14:04:50.672085
gpas upload
GPAS client version: 3.1.3
Usage: gpas upload [OPTIONS] UPLOAD_CSV
Validate, decontaminate and upload reads to GPAS.
Creates a mapping CSV file which can be used to download output files with original sample names.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --threads INTEGER Number of alignment threads used during decontamination │
│ --save Retain decontaminated reads after upload completion │
│ --skip-fastq-check Skip checking FASTQ files for validity │
│ --skip-decontamination Skips decontamination step prior to upload │
│ --output-dir DIRECTORY Output directory for the cleaned FastQ files, defaults to clean-files/<timestamp>/. │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Where samples may contain human reads we strongly recommend using the provided decontamination functionality. This is best practice to minimise the risk of personally identifiable information being uploaded to the cloud.
The upload command performs metadata validation and client-side removal of human reads for each of your samples, before uploading sequences to GPAS for analysis.
To generate a CSV file to use with this command see the build-csv documentation.
Human Read Removal
A 4GB human genome index is downloaded the first time you run gpas upload. If for any reason this is interrupted,
run the upload command again. Upload will not proceed until the index has been downloaded and passed an integrity
check. You may optionally download the index ahead of time using the command gpas download-index.
By default, the upload command will first run gpas decontaminate to attempt to remove human reads prior to
uploading the input samples to GPAS, this option can be overridden but only do so if you're aware of the risks
stated above.
To retain the decontaminated FASTQ files uploaded to GPAS, include the optional --save flag. To perform
decontamination without uploading anything, use the gpas decontaminate command.
During upload, a mapping CSV is created (e.g. a5w2e8.mapping.csv) linking your local sample names with their randomly
generated remote names. Keep this file safe, as it is useful for downloading and relinking results later, it cannot be
recreated after this step without re-uploading the same samples again.
Usage
$ gpas upload my-first-batch.csv
GPAS client version 3.1.3
Removing human reads from ILLUMINA FastQ files and storing in /Users/<user>/code/gpas/client/clean-files/2026-07-17_12-18-20
Human reads removed from input samples and can be found here: /home/<user>/code/gpas/client/clean-files/2026-07-17_12-18-20
The mapping file gx5y5p.mapping.csv has been created.
You can monitor the progress of your batch in GPAS here: "..."
Uploading 66433ffc-3c10-4576-8502-56b4805c7ecc_1.fastq.gz
Uploading 66433ffc-3c10-4576-8502-56b4805c7ecc_2.fastq.gz
Upload complete. Created gx5y5p.mapping.csv (keep this safe)
$ gpas upload --skip-decontamination my-first-batch.csv
GPAS client version 3.1.3
Calculating read count in: /home/jeremy/covid_genomes/dev-ont/9b59b910-1c76-a0d6-e49f-0ec67377d402.reads.fastq.gz
4900 reads in FASTQ file
The mapping file gx5y5p.mapping.csv has been created.
You can monitor the progress of your batch in GPAS here: "..."
Uploading 66433ffc-3c10-4576-8502-56b4805c7ecc_1.fastq.gz
Uploading 66433ffc-3c10-4576-8502-56b4805c7ecc_2.fastq.gz
Upload complete. Created gx5y5p.mapping.csv (keep this safe)
gpas build-csv
GPAS client version: 3.1.3
Usage: gpas build-csv [OPTIONS] SAMPLES_FOLDER
Command to create upload csv from SAMPLES_FOLDER containing sample fastqs.
Use max_batch_size to split into multiple separate upload csvs.
Adjust the read_suffix parameters to match the file endings for your read files.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * --output-csv FILE Path to output CSV file [required] │
│ * --batch-name TEXT Batch name [required] │
│ * --collection-date [%Y-%m-%d] Collection date (YYYY-MM-DD) [default: 2026-08-26] [required] │
│ * --country TEXT 3-letter Country Code [required] │
│ --instrument-platform [illumina|ont] Sequencing technology [default: illumina] │
│ --subdivision TEXT Subdivision in ISO 3166-2 format, see https://www.iso.org/standard/72483.html [default: │
│ ""] │
│ --district TEXT District [default: ""] │
│ --specimen-organism [mycobacteria|sars-cov-2|ont-assembly] Specimen organism [default: mycobacteria] │
│ --amplicon-scheme [|Automatic Amplicon scheme, use only when SARS-CoV-2 is the specimen organism │
│ Detection|COVID-AMPLISEQ-V1|COVID-ARTIC-V3|COVID-ARTIC-V4.1|COVID-ARTIC-V5.0-5.2.0_1200| │
│ COVID-ARTIC-V5.0-5.3.2_400|COVID-MIDNIGHT-1200|COVID-VARSKIP-V1a-2b] │
│ --ont_read_suffix TEXT Read file ending for ONT fastq files [default: .fastq.gz] │
│ --illumina_read1_suffix TEXT Read file ending for Illumina read 1 files [default: _1.fastq.gz] │
│ --illumina_read2_suffix TEXT Read file ending for Illumina read 2 files [default: _2.fastq.gz] │
│ --max-batch-size INTEGER [default: 50] │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
This command generates a CSV from a given directory of fastq sample files. An example of such a CSV file is given in the assets directory. A CSV file in this format is required to run the gpas upload command.
Note: the CSV file must be located in the same directory as the sample.fastq files to be used with the upload command.
Usage
gpas build-csv ~/Downloads/samples --batch-name <batch-name> --country <three-letter-country-code>
for ex:
gpas build-csv ~/Downloads/samples --batch-name mybatch123 --country GBR
This will generate a CSV file in the samples folder named upload.csv, prompting users to manually fill in optional fields later (like instrument-platform, amplicon-scheme, etc.). Alternatively, these optional parameters can be passed directly via the CLI rather than filling them in manually later; the example below shows how to include some of these, but for the full list of available options, refer to gpas build-csv --help.
for ex:
gpas build-csv ~/Downloads/samples \
--batch-name mybatch123 \
--country GBR \
--instrument-platform illumina \
--specimen-organism sars-cov-2 \
--amplicon-scheme "Automatic Detection"
gpas decontaminate
GPAS client version: 3.1.3
Usage: gpas decontaminate [OPTIONS] INPUT_CSV
Decontaminate reads from provided csv samples.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --output-dir DIRECTORY Output directory for the cleaned FastQ files, defaults to clean-files/<timestamp>/. │
│ --threads INTEGER Number of alignment threads used during decontamination │
│ --skip-fastq-check Skip checking FASTQ files for validity │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
This command will attempt to remove human reads from a given input CSV file, in the same structure as the input CSV that would be used for uploading to GPAS, an example can be found here.
By default, the processed files will be output in the same directory that the command is run in, but you can choose a
different directory with the --output-dir argument.
Usage
$ gpas decontaminate tests/data/illumina.csv
GPAS client version: 3.1.3
Removing human reads from ONT FastQ files and storing in /home/jeremy/Documents/work/client/clean-files/2026-07-17_12-24-00
Human reads removed from input samples and can be found here: /home/jeremy/Documents/work/client/clean-files/2026-07-17_12-24-00
gpas download
GPAS client version: 3.1.3
Usage: gpas download [OPTIONS] SAMPLES
Download input and output files associated with sample IDs or a mapping CSV file.
That are created during upload.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --filenames TEXT Comma-separated list of output filenames to download │
│ --inputs Also download decontaminated input FASTQ file(s) │
│ --output-dir DIRECTORY Output directory for the downloaded files. │
│ --rename/--no-rename Rename downloaded files using sample names when given a mapping CSV │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The download command retrieves the output (and/or input) files associated with a batch of samples given a mapping CSV generated during upload, or one or more sample GUIDs. When a mapping CSV is used, by default downloaded file names are prefixed with the sample names provided at upload. Otherwise, downloaded files are prefixed with the sample GUID.
Usage
# Download the main reports for all samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv
# Download the main and speciation reports for all samples in a5w2e8.mapping.csv
gpas download a5w2e8.mapping.csv --filenames main_report.json,speciation_report.json
# Download the main report for one sample
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6
# Download the final assembly for one M. tuberculosis sample
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6 --filenames final.fasta
# Download the main report for two samples
gpas download 3bf7d6f9-c883-4273-adc0-93bb96a499f6,6f004868-096b-4587-9d50-b13e09d01882
# Save downloaded files to a specific directory
gpas download a5w2e8.mapping.csv --output-dir results
# Download only input fastqs
gpas download a5w2e8.mapping.csv --inputs --filenames ""
The complete list of --filenames available for download varies by sample, and can be found in the Downloads section of
sample view pages in GPAS.
gpas validate
GPAS client version: 3.1.3
Usage: gpas validate [OPTIONS] UPLOAD_CSV
Validate a given upload CSV.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The validate command will check that a Batch can be created from a given CSV and if your user account has permission
to upload the samples, the individual FastQ files are then checked for validity. These checks are already performed
by default with the upload command but using this can ensure validity without committing to the subsequent upload
if you're looking to check a CSV during writing it.
gpas query-raw
GPAS client version: 3.1.3
Usage: gpas query-raw [OPTIONS] SAMPLES
Fetch metadata for one or more SAMPLES in JSON format.
SAMPLES should be command separated list of GUIDs or path to mapping CSV.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The query-raw command fetches either the raw metadata of one more samples given a mapping CSV
generated during upload, or one or more sample GUIDs.
Usage
# Query all available metadata in JSON format
gpas query-raw a5w2e8.mapping.csv
gpas query-status
GPAS client version: 3.1.3
Usage: gpas query-status [OPTIONS] SAMPLES
Fetch processing status for one or more SAMPLES.
SAMPLES should be command separated list of GUIDs or path to mapping CSV.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --output_json Output status in JSON format │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The query-status command fetches the current processing status of one or more samples in a mapping CSV
generated during upload, or one or more sample GUIDs.
Usage
# Query the processing status of all samples in a5w2e8.mapping.csv
gpas query-status a5w2e8.mapping.csv
# Query the processing status of a single sample
gpas query-status 3bf7d6f9-c883-4273-adc0-93bb96a499f6
gpas get-pipelines
GPAS client version: 3.1.3
Usage: gpas get-pipelines [OPTIONS]
Get valid pipelines from the server.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The get-pipelines command fetches the valid pipelines and their versions from the server.
Usage
gpas get-pipelines
gpas get-amplicon-schemes
GPAS client version: 3.1.3
Usage: gpas get-amplicon-schemes [OPTIONS]
Get valid amplicon schemes from the server.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
The get-amplicon-schemes command fetches the valid amplicon schemes from the server.
Usage
gpas get-amplicon-schemes
gpas autocomplete
GPAS client version: 3.1.3
Usage: gpas autocomplete [OPTIONS]
Enable shell autocompletion.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
This command will output the steps required to enable auto-completion in either a Bash or ZSH shell, follow the output to enable autocompletion, this will need to be executed on every new shell session, instructions are provided on how to make this permanent depending on your environment. More information and instructions for other shells can be found in the Click documentation.
Usage
$ gpas autocomplete
Run this command to enable autocompletion:
eval "$(_GPAS_COMPLETE=bash_source gpas)"
Add this to your ~/.bashrc file to enable this permanently:
command -v gpas > /dev/null 2>&1 && eval "$(_GPAS_COMPLETE=bash_source gpas)"
Tab completion can optionally be enabled by adding the lines output by the command to your shell source files.
This will enable the ability to press tab after writing gpas to list possible sub-commands. It can also be used
for sub-command options, if -- is entered prior to pressing tab.
Support
For technical support, please open an issue or contact gpas.support@eit.org
6 maintainers
Metadata
6 maintainers
Release files for gpas 3.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gpas-3.1.3.tar.gz | 49.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gpas-3.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.8 kB
Release files / gpas-3.1.3.tar.gz
| Download URL | gpas-3.1.3.tar.gz |
|---|---|
| Size | 49.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6cce41bcb28a75eceef0d1b3dcee4b368059c90df6d3c6baf35a15f18a42023d
|
|
BLAKE2b-256 checksum How to use checksums |
6ccb2111ebfb2c1f3411a30f12689c1ef411bb6423f650cb3494cb4edef3255c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / gpas-3.1.3-py3-none-any.whl
| Download URL | gpas-3.1.3-py3-none-any.whl |
|---|---|
| Size | 52.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df9f5a981de63bbd4ccbdc61d4394e569369acd413ac83ded667d3d8832827b3
|
|
BLAKE2b-256 checksum How to use checksums |
e6b15179e63368d11ea57d67a09dd0d4ec2e2140ae35fef5328d1c46e63743b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
