Bits & Flames Fyron bitsandflames/fyron

Public Beta

Fyron is in public beta. It is ready for research teams to try, inspect, and build with, while still leaving room for API refinement before a stable 1.0 release.

Stability Expectations

AreaPublic-beta expectation
Core workflowsTested and intended for real research workflows
API compatibilityBest effort within 0.x; breaking changes should be documented
ExamplesSynthetic or de-identified only
Clinical deploymentNot supported
Regulated audit useNot claimed

Fyron favors small, explicit APIs and DataFrame-friendly outputs. When an API changes, the project should prefer additive options, compatibility aliases, or release notes that explain the migration.

Responsible Use

Fyron can help structure clinical data science work, but users remain responsible for:

  • study approvals and institutional governance,
  • privacy review and de-identification,
  • clinical validation and endpoint definitions,
  • correct interpretation of statistical and ML outputs,
  • secure handling of FHIR, DICOMweb, S3, and other credentials.

Do not share PHI, secrets, private endpoint URLs, or real patient-linked DICOM/FHIR payloads in public issues, pull requests, screenshots, or examples.

What Is Already In Place

  • MIT license, citation metadata, security policy, contributing guide, code of conduct, issue templates, and pull request checklist.
  • CI for Python 3.10, 3.11, and 3.12.
  • Documentation build and GitHub Pages workflow.
  • Release-readiness checks for package contents, generated docs links, version alignment, local artifact ignores, private path patterns, and selected public-safety markers.

Known Public-Beta Polish

  • Generated docstring coverage is not complete for every public API.
  • Optional extras need ongoing compatibility checks as upstream scientific packages evolve.
  • Warning cleanup remains useful for pandas, sklearn, lifelines, NumPy, and Matplotlib changes.

See the Open Source Release Checklist before tagging or announcing a new public release.