Skip to main content

Flock Bio shared scoring + calibration infrastructure for transcript-design sub-pipelines.

Project description

bioscoring-shared-FB

Flock Bio shared scoring + calibration infrastructure library (flockbio_bioscoring). The 5th repo in the Flock Bio transcript-design suite.

This library packages the common machinery used by the four sub-pipelines + the orchestrator:

  • DatasetSpec dataclass + sentinel framework for offline calibration runs
  • License-aware download helpers with retries + EBI tier-0 probe
  • Generic FASTA / CSV / GTF parsers
  • Bootstrap LODO + null-model + ship gate framework
  • NNLS calibration helpers
  • HTML / PDF report scaffolding (Jinja2 + matplotlib + Chromium)

Per the Rule of Three (L21 in docs/CROSS_PIPELINE_LESSONS.md; canonical here since 2026-05-12, moved from codon's docs/), this library is extracted from the already-shipping codon

  • 5'UTR + 3'UTR pipelines after they paid for the infrastructure once each.

Status

v0.4.0 shipped (Sprint 4 Day 8). All three extraction tiers are complete; the library is feature-complete for the Sprint 4 scope. Next milestone is v1.0.0 after the four consumer pipelines migrate from their inline copies to the shared lib (see docs/CONSUMER_MIGRATION_PLAN.md + docs/CONSUMER_MIGRATION_STATUS.md).

Tier Sprint 4 days Modules Status
1 Days 1-3 DatasetSpec + sentinels + download + parsers + cache + EuropePMC tier-0 ✅ shipped (v0.1.0)
2 Days 4-5 NNLS + ship gate + upload-success-gate + merge_artifacts + artifact_schema ✅ shipped (v0.2.0)
3 Days 6-7 HTML / PDF report scaffolding (style + figures + chromium_pdf + templates_loader) ✅ shipped (v0.3.0)

Strategic position

Repo Role Status
flock-bio/codon_optimization-FB Codon optimization ✅ shipping v2.8.5 (Tier 3 first-pass migrated)
flock-bio/5utr_optimization-FB 5'UTR design ✅ shipping v2.8.24 (Tier 2 + Tier 3 first-pass migrated)
flock-bio/3utr_optimization-FB 3'UTR design ✅ shipping v0.3.1 (Tier 2 + Tier 3 first-pass migrated)
flock-bio/promoter_design-FB Tissue-specific promoter design ✅ shipping v0.5.0 (adopted shared lib from start; Phase D phase_d_empirical)
flock-bio/bioscoring-shared-FB (THIS REPO) Shared library v1.0.0 on PyPI (2026-05-12) — first stable API after 4-consumer first-pass migration
flock-bio/transcript_design-FB Orchestrator v1.0.0 GA shipped 2026-05-12 — adopted flockbio_bioscoring>=1.0.0,<2.0.0

Installation

pip install flockbio_bioscoring  # once published

For development:

pip install -e .[dev]
PYTHONPATH=src python3 -m pytest tests/ -q

Documentation

  • CLAUDE.md — Claude Code guidance for this repo.
  • CHANGELOG.md — chronological history of behavior changes.
  • docs/INTEGRATION_GUIDE.md — API surface reference + recipes for consuming pipelines to migrate from inline copies to the shared library.
  • docs/CONSUMER_MIGRATION_PLAN.md — master migration plan for the 4-consumer migration (binding order, per-consumer effort, Step 0-9 recipe).
  • docs/CONSUMER_MIGRATION_STATUS.md — live status tracker for the 4-consumer migration.
  • docs/CALIBRATION_RUNBOOK_TEMPLATE.md — template for consumer-side CALIBRATION_RUNBOOK.md (Phase D / OFFLINE calibration operator doc; consumers extend with pipeline specifics).
  • docs/CROSS_PIPELINE_LESSONS.md — canonical strategic doc for the 6-repo suite (Strategic North Star + Part I L1-L26 lessons + Part X per-pipeline kickoff guides + Part XI binding I/O contracts). Moved here from codon's docs/ on 2026-05-12 per L21. L22 + L23 added 2026-05-20 from the 3utr Griesemer 2021 wiring saga; L24 added 2026-05-20 from the orchestrator promoter-v1.0.0 vendor-sync doc- drift (artifact-truth supersedes CLAUDE.md-prose); L25 added 2026-05-20 (authorship verification before cross- pipeline attribution; operationalized in v1.1.0 l20_audit_runner); L26 added 2026-05-20 (PMID-to-paper consistency before attribution work; operationalized in v1.2.0 claimed_title_substring + claimed_first_author kwargs).
  • docs/CYPHERBIO_PIPELINE_PLAYBOOK.md + docs/CYPHERBIO_PLAYBOOK_v2.md — canonical CypherBio packaging conventions (moved here from per-consumer copies on 2026-05-12 per L21).

License

The library code is licensed under the MIT license (see LICENSE). License terms for bundled / downloaded datasets are tracked separately in LICENSES.md per the L20 4-layer audit pattern (article + supplementary + deposit + cross-walk).

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

flockbio_bioscoring-1.2.1.tar.gz (93.4 kB view details)

Uploaded Source

Built Distribution

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

flockbio_bioscoring-1.2.1-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

File details

Details for the file flockbio_bioscoring-1.2.1.tar.gz.

File metadata

  • Download URL: flockbio_bioscoring-1.2.1.tar.gz
  • Upload date:
  • Size: 93.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flockbio_bioscoring-1.2.1.tar.gz
Algorithm Hash digest
SHA256 28a887510fd7df454d0778a0c9a906ee5d207ae93887aab261693e99c20d4f6b
MD5 aa50c95d0abe740b30cce9ed544e3949
BLAKE2b-256 0f00907dabfca505736eb8c64992ec48155fa66be04bf3abd42935cde93387c9

See more details on using hashes here.

File details

Details for the file flockbio_bioscoring-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for flockbio_bioscoring-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 751158401690ec1cdcfd308496e331e93de4070608c4e2405500a92eba07d7bd
MD5 25359240e83eb4e05e2dc373caa537fc
BLAKE2b-256 1458a48e56725315f83ccb4011555136dcbd5c51aebd9af336f65c95bfa70094

See more details on using hashes here.

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