Docs · Omnis platform

Platform, pipeline, and proof docs

Use this docs shell for CLI workflows, architecture, benchmark contracts, and public operating guidance across the Omnis platform.

CLIArchitectureBenchmarksDeployment

Viewing

Pilot quickstart (Compose stack)

Docs overview OGN CLI quickstart BioFlow API reference Benchmark pack

Need another page?

Search the docs

Jump to buyers, verification, demos, self-hosting, or adapters without opening the full docs tree first.

Key sections

1. Requirements 2. Download the compose stack 3. Start the stack 4. Submit a run 5. Poll status and download artifacts 6. Tear down

Mobile navigation

Jump to section

Open

This quickstart is a self-contained pilot demo you can run on your laptop. It simulates the OGN “submit → run → download artifacts” flow and returns a small proof bundle (metrics JSON + a tiny VCF).

It is intentionally lightweight: no GPUs, no real genomics compute. Snapshot Reports replace this demo server with the GPU pipeline and return your real artifacts.

1. Requirements

Docker Desktop / Docker Engine
Docker Compose v2 (docker compose)
curl (and optionally jq)

2. Download the compose stack

Create a clean working directory:

BashRunnable example

mkdir -p ogn-pilot-demo && cd ogn-pilot-demo

Download the compose file and demo server:

BashRunnable example

curl -L -o docker-compose.yml https://omnisgenomics.com/pilot-demo/docker-compose.yml
curl -L -o demo_server.py https://omnisgenomics.com/pilot-demo/demo_server.py

3. Start the stack

BashRunnable example

docker compose up

You should see the server listening on http://localhost:8080.

Health check:

BashRunnable example

curl -s http://localhost:8080/healthz

4. Submit a run

Submit a demo run (any JSON payload is accepted):

BashRunnable example

curl -sS -X POST http://localhost:8080/v1/runs \
  -H 'Content-Type: application/json' \
  -d '{
    "pipeline": "wgs30",
    "sample": "hg002",
    "reads": ["R1.fastq.gz", "R2.fastq.gz"],
    "ref": "GRCh38_noalt.fa"
  }'

If you have jq, extract the run id:

BashRunnable example

RUN_ID=$(curl -sS -X POST http://localhost:8080/v1/runs -H 'Content-Type: application/json' -d '{"sample":"hg002"}' | jq -r .id)
echo "$RUN_ID"

5. Poll status and download artifacts

Poll until the run reaches succeeded (the demo returns quickly with synthetic artifacts):

BashRunnable example

curl -sS http://localhost:8080/v1/runs/$RUN_ID

List available artifacts:

BashRunnable example

curl -sS http://localhost:8080/v1/runs/$RUN_ID/artifacts

Download the proof bundle artifacts:

BashRunnable example

curl -sS -o metrics.json http://localhost:8080/v1/runs/$RUN_ID/artifacts/metrics.json
curl -sS -o variants.vcf http://localhost:8080/v1/runs/$RUN_ID/artifacts/variants.vcf
curl -sS -o proof_bundle.json http://localhost:8080/v1/runs/$RUN_ID/artifacts/proof_bundle.json

6. Tear down

BashRunnable example

docker compose down