Skip to content
OGN logo
Omnis Genomics
Genomics infrastructure
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
OGN Core Kit (open source)
Docs overviewOGN CLI quickstartBioFlow API referenceBenchmark 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
What you getInstall (Python)Engine requirementUsing `ogn-runner`Contracts
Mobile navigation
Jump to section
Open
OGN Core Kit is the public integration surface for Omnis Genome Nexus (OGN): the stable contracts, the worker runner, SDKs, and workflow adapters. It does not include the proprietary OGN engine binaries or GPU kernels.
GitHub: https://github.com/omniscoder/ogn-core-kit

What you get

  • Job Spec JSON v1 (docs + JSON schema + conformance fixtures)
  • ogn-runner: stable worker entrypoint (ogn-runner -) that executes an engine and uploads artifacts
  • Python package ogn-sdk: ogn CLI + ogn_sdk helpers + ogn_runner
  • Workflow adapters (example Nextflow pipeline)

Install (Python)

BashRunnable example
python -m pip install ogn-sdk
ogn-runner --help

Engine requirement

To run real genomics compute you need access to an OGN engine binary or container image (distributed separately).
ogn-runner shells out to an engine executable (defaults to ogn_run on PATH):
BashRunnable example
export OGN_ENGINE_BIN=/path/to/ogn_run

Using ogn-runner

Workers are expected to run:
BashRunnable example
ogn-runner -
where the Job Spec JSON v1 payload is provided on stdin.
For local testing you can also pass a file path:
BashRunnable example
ogn-runner job_spec.json
Upload behavior:
  • If outputs.*.put_url is present, the runner uploads via presigned HTTP PUT.
  • If put_url is absent, the runner uploads directly to the stable outputs.*.uri when supported (e.g. s3://...).

Contracts

The canonical contract lives in the core kit repo:
  • spec/v1/jobspec.md
  • spec/v1/jobspec.schema.json
  • spec/v1/conformance/
Job Spec v1 is additive-only and consumers must ignore unknown fields.
OGN Core Kit (open source) | Omnis documentation | Omnis Genomics