IINTS-AF SDK Documentation¶

IINTS-AF is a research SDK for testing insulin algorithms on virtual patients, validating data quality, and reviewing outputs with reproducible reports.

It combines three core workflows: - Simulate closed-loop behavior on virtual patients - Certify datasets and outputs with built-in trust grading - Review runs with reports, posters, and optional local AI tooling

Use a Virtual Environment

Run SDK commands from an active Python virtual environment such as .venv. This avoids package conflicts and missing dependency issues.

Decide What You Need¶

New external users should start with the User Guide Map. It links the quickstart, research, data, edge, and maintainer paths into one readable route.

I want to...	Start here	Why
Understand the whole docs site	User Guide Map	Connected manual-style route
Get a recommended command	`iints start`	Goal-based first-run plan
See something work in a few minutes	Quickstart	Fastest route to a successful first run
Let the CLI guide me	`iints guide`	Interactive beginner path
Run a zero-config example	`iints demo`	No custom files required
Build my own simulation command	`iints run --wizard`	Guided custom run builder
Install or repair the environment	Installation	Dependency and environment setup
Fix a failing command	Troubleshooting	Common errors and exact fixes
Browse the CLI surface	Command Reference	Short command map without deep internals
Run reproducible studies	Scientific Workflow	Protocols, study bundles, comparisons
Bring a Pi to Maker Faire	Maker Faire Pi Mode	Show-ready Raspberry Pi flow
Maintain or release the SDK	Maintainer Guide	Local checks, release audit, and manual upkeep

5-Minute First Run¶

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install -U "iints-sdk-python35[full,mdmp]"

iints doctor --suggest
iints demo

If you want to inspect the plan before running anything:

iints demo --dry-run

Friendly CLI Entry Points¶

iints start: prints the shortest path for demo, project, study, edge, or data work
iints guide: asks what you want to do and points you to the right flow
iints demo: zero-config first run
iints run --wizard: guided custom run
iints doctor --full --suggest: diagnostics plus concrete next commands

Choose Your Path¶

New Users¶

Researchers¶

Edge / Maker Faire Users¶

Maintainers¶

Scope¶

Research use only.
Not a medical device.
No clinical dosing advice.

Next Step¶

Start with User Guide Map if you want a guided route, or Quickstart if you want to run the SDK immediately.