Friendly, reproducible bioinformatics toolkit with schema-verified viz
Project description
Helix — Deterministic, auditable genome-editing simulation (CRISPR/Prime/PCR)
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
Choose your path
- Try Helix quickly → First Run or docs/getting-started.md
- Evaluate auditability/reproducibility → docs/audit_walkthrough.md and docs/scientific_contract_v1.md
- Run the Public Validation Pack v1 → docs/validation/README.md
- Verify release receipts (trust model + receipts) → docs/reference_validation_bundle.md
- Enterprise proof dossier (security, threat model, signing, receipts) → docs/enterprise_proof/index.md
- Teams v0 blueprint (artifact store + run registry + RBAC) → docs/teams_v0.md
- Use CRISPR/Prime decision modeling → docs/edit_dag_overview.md (limitations: docs/model_limitations/crispr_edit_dag_limitations.md)
- Integrate in CI/headless lanes → docs/cli_headless.md and docs/trust_kit.md
- Hack on internals → docs/contributing.md (tests:
tools/test.sh/tools/test.ps1)
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
- Docs & Playground: https://omniscoder.github.io/Helix/
- Studio strategy: docs/helix_studio_strategy.md
- Snapshot spec v1: docs/snapshot_spec_v1.md
- Full manual / product cookbook (legacy README): docs/product_manual.md
Project details
Release history Release notifications | RSS feed
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file helix_governance-1.1.3.tar.gz.
File metadata
- Download URL: helix_governance-1.1.3.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d3dbd824268d5ff52e157ac6ad17ac690db490ff243cf6c9f822e8fdadd27049
|
|
| MD5 |
773de44aafa1448f61744e440c3f6cf0
|
|
| BLAKE2b-256 |
322afa9d39e7e2a663c731739b2bcf8e21fd2f1611e0c8c595ace87e3d8afe90
|
Provenance
The following attestation bundles were made for helix_governance-1.1.3.tar.gz:
Publisher:
release.yml on omniscoder/Helix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
helix_governance-1.1.3.tar.gz -
Subject digest:
d3dbd824268d5ff52e157ac6ad17ac690db490ff243cf6c9f822e8fdadd27049 - Sigstore transparency entry: 815154195
- Sigstore integration time:
-
Permalink:
omniscoder/Helix@297f32bdff1f858a43bfd856df6f361cdce51b91 -
Branch / Tag:
refs/tags/v1.1.3 - Owner: https://github.com/omniscoder
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@297f32bdff1f858a43bfd856df6f361cdce51b91 -
Trigger Event:
push
-
Statement type:
File details
Details for the file helix_governance-1.1.3-py3-none-any.whl.
File metadata
- Download URL: helix_governance-1.1.3-py3-none-any.whl
- Upload date:
- Size: 3.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ff706a651848214b4a1c7c39503a59f3550ac584716ee4a57a67f1f78710bd2
|
|
| MD5 |
153cfea3b3e043b0057ffb233a1fac59
|
|
| BLAKE2b-256 |
d9352101b25d2cb5ac220c4d5198e3a6db79602864578420569768d66027b712
|
Provenance
The following attestation bundles were made for helix_governance-1.1.3-py3-none-any.whl:
Publisher:
release.yml on omniscoder/Helix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
helix_governance-1.1.3-py3-none-any.whl -
Subject digest:
0ff706a651848214b4a1c7c39503a59f3550ac584716ee4a57a67f1f78710bd2 - Sigstore transparency entry: 815154200
- Sigstore integration time:
-
Permalink:
omniscoder/Helix@297f32bdff1f858a43bfd856df6f361cdce51b91 -
Branch / Tag:
refs/tags/v1.1.3 - Owner: https://github.com/omniscoder
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@297f32bdff1f858a43bfd856df6f361cdce51b91 -
Trigger Event:
push
-
Statement type: