Skip to content

Getting Started

This page gives the fastest reliable path from install to a validated run.

1) Create and Activate a Virtual Environment

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip

All commands below assume this .venv is active.

2) Install

pip install iints-sdk-python35

Optional extras:

pip install "iints-sdk-python35[research]"
pip install "iints-sdk-python35[nightscout]"

3) Verify Environment

iints doctor --smoke-run

If this fails, fix environment issues before running long experiments.

4) Create a Project

iints quickstart --project-name iints_quickstart
cd iints_quickstart

Generated structure includes: - algorithms/ - scenarios/ - results/

5) Run a Baseline Simulation

iints presets run --name baseline_t1d --algo algorithms/example_algorithm.py

6) Check Outputs

A typical run writes: - results.csv: time-series simulation output. - clinical_report.pdf: report for review. - audit/: decision and safety trail. - run_manifest.json: file hashes for reproducibility. - run_metadata.json: run config and environment details.

7) Build a Study-Ready Bundle

iints study-ready --algo algorithms/example_algorithm.py --output-dir results/study_ready

Adds: - validation_report.json - sources_manifest.json - SUMMARY.md

8) Next Steps

Safety Scope

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