Documentation

Read the record, not a summary of it

The canonical documents live in the repository. This page only routes to them — it deliberately does not copy them, so a number cannot drift between two pages.

package v0.5.0MIT1,160 offline tests

Quickstart

Install, test, demo, then optionally go live.

  • Install

    Standard library only; Python 3.10, 3.11 and 3.12 are tested in CI.

  • Test

    1,160 collected, 1,157 passed, 3 skipped. No network, no API key.

  • Demo

    Offline build from the committed snapshot in under 60 s: out/demo/index.html.

  • Live run

    Needs network, about three minutes, still no API key. Writes the report, the dashboard and the CSV.

source: README.md → Reproduce; PROJECT_STATE.yaml → tests; .github/workflows/ci.yml

shellverified commands
git clone https://github.com/ChazY11/medradar.git
cd medradar && pip install -e .

# 1,160 offline tests · no network · no API key
python -m pytest -q -o addopts=""

# offline demo → out/demo/index.html (< 60 s)
medradar demo

# live run → report, dashboard, summary.csv (~3 min)
medradar run --months 24 --with-trade --with-dashboard

Reading map

Four readers, four routes.

Pick the route that matches why you are here; each ends at the document that owns the explanation.

source: docs/INDEX.md → How to read this repository; README.md

Contributing

Curated knowledge before code.

The core package stays standard-library-only. Every new metric updates docs/METHODS.md and docs/SCHEMA.md first, so a metric cannot enter the codebase without a definition.

source: README.md → Contributing; CONTRIBUTING.md

Licence and citation

MIT, with the publishers' terms intact.

Licence
MIT — see LICENSE
Source data
Belongs to its publishers: openFDA is public domain; ClinicalTrials.gov and SEC EDGAR have their own terms.
Version
v0.5.0 — CHANGELOG.md is the record
Dataset
Snapshot 2026-10-31, generated 2026-10-31T05:33:25Z (not committed)

Citation

Cite the repository and the version, not a published paper: no paper here is submitted or peer reviewed. Paper drafts and their claim maps live in papers/.

MedRadar (2026). Research infrastructure for public medical-technology evidence, v0.5.0, dataset snapshot 2026-10-31. https://github.com/ChazY11/medradar

source: README.md → Licence; papers/README.md

One rule for every document

A fact is stated once, in its canonical file, and linked everywhere else. If you find the same number in two places without a pointer, one of them is already drifting — report it rather than copy it.

source: docs/INDEX.md → Maintenance rules for this page