This release is a pre-release and may not be stable for production use.
RAFT
Reproducible Analyses Framework and Tools
RAFT is a Python package and CLI for running and managing bioinformatics workflows built on Nextflow DSL2. The repository also includes browser-based tools for manifest/config generation, a report viewer, and a Bring Your Own Cloud (BYOC) launcher for running on GCP Batch.
What RAFT does
- Creates and manages reproducible workflow projects
- Runs off-the-shelf workflows from versioned definitions
- Validates manifests before execution
- Launches browser UIs for manifest editing, config generation, report viewing, and BYOC setup
- Supports local execution and BYOC submission to GCP Batch
Installation
RAFT installs a raft command-line entry point.
pip install --user reproducible-analyses-framework-and-tools
Runtime prerequisites for most workflow execution paths:
- Python 3.9+
- Nextflow
- Java
wget- Singularity/Apptainer
Quick Start
Initialize a RAFT workspace in the current directory:
raft setup --default
List available off-the-shelf workflows:
raft available-workflows
raft available-workflows --workflow lens
Create and run a new workflow project:
raft run \
--project-id demo-lens \
--workflow lens \
--version v1.9-dev
If --manifest is omitted for a new project, RAFT launches the manifest
generator UI. If --workflow-profile is not provided, RAFT can also launch
the config generator UI. Use --workflow-profile standard to apply the base
workflow configuration non-interactively.
Launch the report viewer for an existing project:
raft generate-reports --project-id demo-lens
Main Commands
raft setup: create.raft.cfgand standard workspace directories, includinginputs/raft run: run an existing project, or create and run a new workflow projectraft run-demo: create and run a demo workflowraft available-workflows: inspect workflow definitionsraft check-manifest: validate a manifestraft generate-reports: open the workflow report viewer
Documentation In This Repo
- User docs: docs/source
- Runner container: containers/raft-runner
Cloud / BYOC
The repository includes:
- A browser-based BYOC launcher for GCP Batch
- A runner container image used by Batch jobs
- Local
raft run --bucket ...support for advanced cases
Start with:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reproducible_analyses_framework_and_tools-1.5.dev0.tar.gz.
File metadata
- Download URL: reproducible_analyses_framework_and_tools-1.5.dev0.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97b3773ed114390104fea527126af824ec623d5ee71c1d917b8b59601dcd370c
|
|
| MD5 |
683f1c15067ee5c7a838ee15359df103
|
|
| BLAKE2b-256 |
a7bd1b601c2a6eac3fe598cd2066756fe7ad0196280b7c7f8a4104f67bb37472
|
File details
Details for the file reproducible_analyses_framework_and_tools-1.5.dev0-py3-none-any.whl.
File metadata
- Download URL: reproducible_analyses_framework_and_tools-1.5.dev0-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b3e9e5ae4adc0de7bc237bef3b66b1e248cb643fe64692fdb713bc80a1e8733
|
|
| MD5 |
eb41c595e96456adccb5bf09fa6e7195
|
|
| BLAKE2b-256 |
323758e34eadfa89100e4423d6a7975f141e9b548faaf1325e77f9f6a83768cc
|
