Quick start

This page provides a short path from installation to a local demonstration workflow.

Before you begin, complete the steps in Installing RAFT.

Initialize a RAFT workspace

RAFT can be initialized in the current directory using:

$ raft setup --default

Note

Expected result:

• .raft.cfg exists in the current directory.

• Workspace directories such as projects/, inputs/, references/, and shared/ were created.

Run a demonstration workflow

Run a demo workflow:

$ raft run-demo --workflow lens --version v1.9-dev

Note

Expected result:

• A demo project directory exists under projects/. By default this is projects/default-demo/ unless you passed --project-id.

• raft project-status --project-id default-demo reports a detected workflow and shows the project state.

View example report

An example of a report can be viewed using:

$ raft generate-reports --demo

Note

Expected result:

• A local report viewer opens in your browser, or RAFT prints the viewer URL for you to open manually.

• The viewer loads a hosted synthetic example report rather than requiring a completed local workflow run.

Note

A hosted example report using synthetic data is available here.

Run on your own data

Once you’re ready:

• See Installing RAFT if you still need to install RAFT or set up a workspace.

• See Choosing your environment to decide between local and cloud execution.

• See Choosing a workflow to find the right workflow for your data.

• See Preparing your samples for how to prepare your samples

• See either Running RAFT locally or Running RAFT on the cloud for a full overview of the run process.

• See Accessing and reviewing outputs for how to access outputs and review results