Skip to content

Manual Overview

Use this page to choose the right manual quickly.

Environment Baseline

Before following any manual, activate a virtual environment:

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

All command examples in the documentation assume .venv is active.

Best Entry Points

  • USER_GUIDE_MAP.md: connected route through the public docs for external users.
  • GETTING_STARTED.md: fastest route to a working run.
  • PLAIN_LANGUAGE_GUIDE.md: non-technical explanation.
  • TECHNICAL_README.md: command and integration reference.
  • AI_ASSISTANT.md: how the local open-weight Ministral 3 assistant works, how it is gated, and how to debug it.

Full Manuals

  • manuals/IINTS-AF_SDK_Manual.md: full long-form technical manual.
  • manuals/IINTS-AF_SDK_Manual.pdf: printable/export version.
  • COMPREHENSIVE_GUIDE.md: architecture + workflows + SDK concepts.

For a new external user:

  1. User Guide Map
  2. Quickstart
  3. Getting Started
  4. Command Reference

For a research user:

  1. Scientific Workflow
  2. Study Analysis
  3. MDMP Quickstart

For an edge user:

  1. Raspberry Pi Digital Patient
  2. Remote Deploy & Pi Connect
  3. Maker Faire Pi Mode

Research-Specific Manual

  • ../research/README.md: predictor data prep, training, and evaluation.

Scope

  • Research and simulation only.
  • Not a medical device.