Skip to main content

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.cfg and standard workspace directories, including inputs/
  • raft run: run an existing project, or create and run a new workflow project
  • raft run-demo: create and run a demo workflow
  • raft available-workflows: inspect workflow definitions
  • raft check-manifest: validate a manifest
  • raft generate-reports: open the workflow report viewer

Documentation In This Repo

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:

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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file reproducible_analyses_framework_and_tools-1.5.tar.gz.

File metadata

File hashes

Hashes for reproducible_analyses_framework_and_tools-1.5.tar.gz
Algorithm Hash digest
SHA256 47c6222095a8a5b3ea6d369ec9b221bfffb239d8748ab70d6f670fb28946f8a8
MD5 83827a04f9f1a14fa051420e52ad714b
BLAKE2b-256 01ac44ecd9f90865d3adfa8be24e69781d0f2526a589d811928f62742316f039

See more details on using hashes here.

File details

Details for the file reproducible_analyses_framework_and_tools-1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for reproducible_analyses_framework_and_tools-1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 07cd106434d484d5d3f495cbb19b535a2d668430e98a6742a18e61ac61a9806d
MD5 79bff076ab95d87d0b5faa5c48debc23
BLAKE2b-256 18f00401af69609b521178c04a7bae030f99f829afb994a6e153baf75956f865

See more details on using hashes here.

Release history Release notifications | RSS feed

1.5.1

2 files

This release

1.5 This release

2 files

1.4.5

1 file

1.4.4

1 file

1.4.3

1 file

1.4.2

1 file

1.4.1

1 file

1.4

1 file

1.3

1 file

1.2

1 file

1.1.1

1 file

1.1

1 file

1.0.2

1 file

1.0.1

1 file

1.0

1 file

0.9.8.1

1 file

0.9.8

1 file

0.9.7

1 file

0.9.5.6

2 files

0.9.5.5

2 files

0.9.5.4

2 files

0.9.5.3

2 files

0.9.5.2

2 files

0.9.5.1

2 files

0.9.5

2 files

0.9.4

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page