Skip to main content

Friendly, reproducible bioinformatics toolkit with schema-verified viz

Project description

Helix — Deterministic, auditable genome-editing simulation (CRISPR/Prime/PCR)

PyPI Scientific Contract CI VeriBiota CI Verified by VeriBiota Reproducible Viz (spec v1.0)

Helix is a deterministic, auditable genome editing simulator and reporting system for pre-clinical, in-silico CRISPR, Prime, and PCR workflows — a computational system of record for genome editing design decisions.

Helix does not claim biological truth. It guarantees computational reproducibility, explicit modeling boundaries, and verifiable decision artifacts (reports, manifests, schema-versioned evidence bundles).

Pre-clinical, in-silico simulation only. See docs/positioning.md.

Migration note (veri-helix → helix-governance)

Helix is now published on PyPI as helix-governance (Python module namespace and CLI entrypoints are unchanged).

python -m pip uninstall -y veri-helix
python -m pip install -U helix-governance

Helix Studio Outcome Explorer overlay

Choose your path

First Run

Install, run a deterministic demo, and open the exported report:

python -m venv .venv
source .venv/bin/activate
pip install "helix-governance"

helix demo run --demo-id crispr --outdir out/demo_crispr --zip
python -m http.server --directory out/demo_crispr/reports 8000

Prime demo:

helix demo run --demo-id prime --outdir out/demo_prime --zip

Governance licensing (principle: authority, not bits)

  • Helix is free to install/run (simulate + explore).
  • Decision-grade assertions and signed bundles require an offline license file.
  • Verification is always free + offline: helix verify <bundle_dir_or_zip> validates signatures and lineage, and never reads your local license.

Dynamic CRISPR simulation (resource-aware)

Copy/paste quickstart (Python API):

from helix.crispr.dynamic import CrisprDynamicSimConfig, simulate_crispr_dynamic

# Key mental model: `delivery` shapes Cas(t) (availability over time), not a static cut probability.
# `population.seed` makes the stochastic simulation reproducible.
cfg = CrisprDynamicSimConfig.from_yaml("""
time: {dt_h: 0.25, t_end_h: 48.0}
population: {n_cells: 2000, seed: 1}
delivery: {mode: RNP, params: {C0: 1.0}}
cas_kinetics: {k_deg: 0.35, k_dil: 0.0}
engagement: {k_eff: 0.55}
grnas: [{id: g1, abundance: 1.0, load_efficiency: 1.0}, {id: g2, abundance: 1.0, load_efficiency: 1.0}]
targets: [{id: t1, grna_id: g1, chr: chr1, pos: 1000, accessibility: 1.0}, {id: t2, grna_id: g2, chr: chr1, pos: 2000, accessibility: 1.0}]
ploidy: {loci: [{locus_id: t1, copies: 2, allele_accessibility: [1.0, 0.5]}, {locus_id: t2, copies: 2, allele_accessibility: [1.0, 1.0]}]}
measurement: {amplicons: [{id: amp1, chr: chr1, start: 900, end: 1100, locus_id: t1}]}
""")
result = simulate_crispr_dynamic(cfg)

print("edited_fraction(t1) =", result.edited_fraction("t1"))
print("edited_fraction(t2) =", result.edited_fraction("t2"))
print("amp1 truth =", result.measurement.amplicons[0].truth_counts)
print("amp1 observed =", result.measurement.amplicons[0].observed_counts)

Want the GUI? pip install "helix-governance[studio]" then run helix-studio.

Who this is for

  • Genome editing researchers who need reproducible CRISPR/Prime outcome enumeration and comparisons
  • Auditors/reviewers who need deterministic replays and verifiable artifacts
  • Contributors building policies, verifiers, and visualization/reporting pipelines

Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

helix_governance-1.1.4.tar.gz (3.9 MB view details)

Uploaded Source

Built Distribution

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

helix_governance-1.1.4-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file helix_governance-1.1.4.tar.gz.

File metadata

  • Download URL: helix_governance-1.1.4.tar.gz
  • Upload date:
  • Size: 3.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for helix_governance-1.1.4.tar.gz
Algorithm Hash digest
SHA256 61294465edc39fed0987e92477eb7c774fbe3886f236f464d6ea0119f72435a9
MD5 b6a44a2806ef7543742b7c0754972e9d
BLAKE2b-256 34b391261365e062e0559c162446774201f2c1932ffc312565aab8f6d99de304

See more details on using hashes here.

Provenance

The following attestation bundles were made for helix_governance-1.1.4.tar.gz:

Publisher: release.yml on omniscoder/Helix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file helix_governance-1.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for helix_governance-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 401e16ec67a0903475cc1557a71c59ad417a6dbc2f1505898a862c955700a2de
MD5 c4d8ccd090bb0e4a7081244c544de151
BLAKE2b-256 1b02b03e9898c46731014e4b1a78f61ea35de2ace3ecffb93f00c4717069703b

See more details on using hashes here.

Provenance

The following attestation bundles were made for helix_governance-1.1.4-py3-none-any.whl:

Publisher: release.yml on omniscoder/Helix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page