iints-sdk-python35 1.3.0__tar.gz → 1.3.2__tar.gz

{iints_sdk_python35-1.3.0/src/iints_sdk_python35.egg-info → iints_sdk_python35-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iints-sdk-python35
-Version: 1.3.0
+Version: 1.3.2
 Summary: A pre-clinical Edge-AI SDK for diabetes management validation.
 Author-email: Rune Bobbaers <rune.bobbaers@gmail.com>
 Project-URL: Homepage, https://github.com/python35/IINTS-SDK
@@ -71,7 +71,7 @@ Docs (GitHub Pages): [python35.github.io/IINTS-SDK](https://python35.github.io/I
 python3 -m venv .venv
 source .venv/bin/activate
 python -m pip install -U pip
-pip install iints-sdk-python35
+python -m pip install -U "iints-sdk-python35[mdmp]"
 ```
 
 ```bash
@@ -81,6 +81,14 @@ cd iints_quickstart
 iints presets run --name baseline_t1d --algo algorithms/example_algorithm.py
 ```
 
+If you want the clearest install/path rules first, read:
+- `docs/INSTALLATION.md`
+
+Short rule:
+- installed `iints ...` commands can run from any folder
+- `python -m pip install -e ".[mdmp]"` only works from the SDK repo root
+- after `iints quickstart`, switch into the generated project folder
+
 ## CareLink Import
 
 The SDK can now ingest Medtronic CareLink / MiniMed CSV exports and convert them into the standard IINTS schema:
@@ -127,19 +135,27 @@ That workbench is designed for three things:
 The SDK now includes a research-only AI assistant layer for explanations and run summaries.
 It is gated by MDMP verification before any LLM call is allowed.
 
-Use an active virtual environment for the full flow:
+Use an active virtual environment for the full flow.
+
+If you installed the released SDK from PyPI, run:
 
 ```bash
 python3 -m venv .venv
 source .venv/bin/activate
 python -m pip install -U pip
-python -m pip install -e ".[mdmp]"
+python -m pip install -U "iints-sdk-python35[mdmp]"
+```
+
+If you are developing from source instead, first move into the SDK repo root and then run:
+
+```bash
+cd /path/to/IINTS-SDK
+python -m pip install -U -e ".[mdmp]"
 ```
 
 Run the open local Mistral model locally with Ollama:
 
 ```bash
-python -m pip install -e ".[mdmp]"
 ollama pull ministral-3:8b
 iints ai models
 ```
@@ -239,14 +255,54 @@ You can also run it through the CLI:
 iints demo-booth --output-dir results/booth_demo
 ```
 
+For a cleaner live explanation, show this source file first:
+
+```bash
+examples/demos/07_live_stage_demo.py
+```
+
+That file is deliberately small and readable, so you can point to:
+- `PATIENT_CONFIG`
+- `OUTPUT_DIR`
+- `DURATION_MINUTES`
+- `TIME_STEP_MINUTES`
+- `SEED`
+
+Then run:
+
+```bash
+./scripts/run_live_stage_demo.sh
+```
+
+That shell wrapper resolves the SDK repo root automatically, so it still works if you launch it from another working directory via its full path.
+
+And open:
+- `results/booth_demo_live/booth_demo_poster.png`
+- `results/booth_demo_live/JURY_TALK_TRACK.md`
+- `results/booth_demo_live/BEURS_LIVE_DEMO_SCRIPT.txt`
+
+What makes this script good for a booth:
+- it visibly calls `run_full(...)`
+- it visibly calls `generate_results_poster(...)`
+- it visibly calls `prepare_ai_ready_artifacts(...)`
+- you can point to one patient setting and explain how the same pipeline reruns for another patient
+
+If you installed the SDK on another machine and do not have the repository checkout there, export the same demo code with:
+
+```bash
+iints demo-export --output-dir iints_demo
+cd iints_demo
+python 07_live_stage_demo.py
+```
+
 ## Updating The SDK
 
-If another machine is missing newer commands like `iints ai ...` or `iints demo-booth`, upgrade inside the active virtual environment:
+If another machine is missing newer commands like `iints ai ...` or `iints demo-booth`, upgrade inside the active virtual environment to the latest release:
 
 ```bash
 source .venv/bin/activate
 python -m pip install -U pip
-python -m pip install -U "iints-sdk-python35[mdmp]==1.3.0"
+python -m pip install -U "iints-sdk-python35[mdmp]"
 hash -r
 python -c "import iints; print(iints.__version__)"
 ```
@@ -260,6 +316,8 @@ iints-sdk-doctor
 Full guide:
 - `docs/UPDATING.md`
 
+If you specifically need to reproduce a known environment, you can pin an exact release number instead of using the unpinned upgrade command above.
+
 Troubleshooting:
 - If `iints ai ...` says `No such command 'ai'`, your environment usually still has a legacy `iints` package installed alongside `iints-sdk-python35`.
 - Run `iints-sdk-doctor` first.
@@ -267,7 +325,7 @@ Troubleshooting:
 
 ```bash
 python -m pip uninstall -y iints iints-sdk-python35
-python -m pip install -U "iints-sdk-python35[mdmp]==1.3.0"
+python -m pip install -U "iints-sdk-python35[mdmp]"
 hash -r
 ```
 

{iints_sdk_python35-1.3.0 → iints_sdk_python35-1.3.2}/README.md

@@ -20,7 +20,7 @@ Docs (GitHub Pages): [python35.github.io/IINTS-SDK](https://python35.github.io/I
 python3 -m venv .venv
 source .venv/bin/activate
 python -m pip install -U pip
-pip install iints-sdk-python35
+python -m pip install -U "iints-sdk-python35[mdmp]"
 ```
 
 ```bash
@@ -30,6 +30,14 @@ cd iints_quickstart
 iints presets run --name baseline_t1d --algo algorithms/example_algorithm.py
 ```
 
+If you want the clearest install/path rules first, read:
+- `docs/INSTALLATION.md`
+
+Short rule:
+- installed `iints ...` commands can run from any folder
+- `python -m pip install -e ".[mdmp]"` only works from the SDK repo root
+- after `iints quickstart`, switch into the generated project folder
+
 ## CareLink Import
 
 The SDK can now ingest Medtronic CareLink / MiniMed CSV exports and convert them into the standard IINTS schema:
@@ -76,19 +84,27 @@ That workbench is designed for three things:
 The SDK now includes a research-only AI assistant layer for explanations and run summaries.
 It is gated by MDMP verification before any LLM call is allowed.
 
-Use an active virtual environment for the full flow:
+Use an active virtual environment for the full flow.
+
+If you installed the released SDK from PyPI, run:
 
 ```bash
 python3 -m venv .venv
 source .venv/bin/activate
 python -m pip install -U pip
-python -m pip install -e ".[mdmp]"
+python -m pip install -U "iints-sdk-python35[mdmp]"
+```
+
+If you are developing from source instead, first move into the SDK repo root and then run:
+
+```bash
+cd /path/to/IINTS-SDK
+python -m pip install -U -e ".[mdmp]"
 ```
 
 Run the open local Mistral model locally with Ollama:
 
 ```bash
-python -m pip install -e ".[mdmp]"
 ollama pull ministral-3:8b
 iints ai models
 ```
@@ -188,14 +204,54 @@ You can also run it through the CLI:
 iints demo-booth --output-dir results/booth_demo
 ```
 
+For a cleaner live explanation, show this source file first:
+
+```bash
+examples/demos/07_live_stage_demo.py
+```
+
+That file is deliberately small and readable, so you can point to:
+- `PATIENT_CONFIG`
+- `OUTPUT_DIR`
+- `DURATION_MINUTES`
+- `TIME_STEP_MINUTES`
+- `SEED`
+
+Then run:
+
+```bash
+./scripts/run_live_stage_demo.sh
+```
+
+That shell wrapper resolves the SDK repo root automatically, so it still works if you launch it from another working directory via its full path.
+
+And open:
+- `results/booth_demo_live/booth_demo_poster.png`
+- `results/booth_demo_live/JURY_TALK_TRACK.md`
+- `results/booth_demo_live/BEURS_LIVE_DEMO_SCRIPT.txt`
+
+What makes this script good for a booth:
+- it visibly calls `run_full(...)`
+- it visibly calls `generate_results_poster(...)`
+- it visibly calls `prepare_ai_ready_artifacts(...)`
+- you can point to one patient setting and explain how the same pipeline reruns for another patient
+
+If you installed the SDK on another machine and do not have the repository checkout there, export the same demo code with:
+
+```bash
+iints demo-export --output-dir iints_demo
+cd iints_demo
+python 07_live_stage_demo.py
+```
+
 ## Updating The SDK
 
-If another machine is missing newer commands like `iints ai ...` or `iints demo-booth`, upgrade inside the active virtual environment:
+If another machine is missing newer commands like `iints ai ...` or `iints demo-booth`, upgrade inside the active virtual environment to the latest release:
 
 ```bash
 source .venv/bin/activate
 python -m pip install -U pip
-python -m pip install -U "iints-sdk-python35[mdmp]==1.3.0"
+python -m pip install -U "iints-sdk-python35[mdmp]"
 hash -r
 python -c "import iints; print(iints.__version__)"
 ```
@@ -209,6 +265,8 @@ iints-sdk-doctor
 Full guide:
 - `docs/UPDATING.md`
 
+If you specifically need to reproduce a known environment, you can pin an exact release number instead of using the unpinned upgrade command above.
+
 Troubleshooting:
 - If `iints ai ...` says `No such command 'ai'`, your environment usually still has a legacy `iints` package installed alongside `iints-sdk-python35`.
 - Run `iints-sdk-doctor` first.
@@ -216,7 +274,7 @@ Troubleshooting:
 
 ```bash
 python -m pip uninstall -y iints iints-sdk-python35
-python -m pip install -U "iints-sdk-python35[mdmp]==1.3.0"
+python -m pip install -U "iints-sdk-python35[mdmp]"
 hash -r
 ```
 

{iints_sdk_python35-1.3.0 → iints_sdk_python35-1.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "iints-sdk-python35" 
-version = "1.3.0"
+version = "1.3.2"
 authors = [
   { name="Rune Bobbaers", email="rune.bobbaers@gmail.com" },
 ]

{iints_sdk_python35-1.3.0 → iints_sdk_python35-1.3.2}/src/iints/__init__.py

@@ -11,7 +11,7 @@ except ImportError:  # pragma: no cover - Python < 3.8 fallback
 try:
     __version__ = version("iints-sdk-python35")
 except PackageNotFoundError:  # pragma: no cover - source tree fallback
-    __version__ = "1.3.0"
+    __version__ = "1.3.2"
 
 # Note to developers: this SDK is currently maintained by a single author.
 # Please report bugs via GitHub issues and feel free to contribute fixes via PRs.

{iints_sdk_python35-1.3.0 → iints_sdk_python35-1.3.2}/src/iints/analysis/booth_demo.py

@@ -231,9 +231,13 @@ def _build_commands_markdown(
     supervisor_dir = run_outputs["03_supervisor_override"]["output_dir"]
     return (
         "# Booth Demo Commands\n\n"
+        "## Showable live demo script\n\n"
+        "```bash\n"
+        f"python3 {example_script} --output-dir {output_dir}\n"
+        "```\n\n"
         "## Run from source tree\n\n"
         "```bash\n"
-        f"PYTHONPATH=src python3 {example_script} --output-dir {output_dir}\n"
+        f"PYTHONPATH=src python3 examples/demos/06_booth_demo.py --output-dir {output_dir}\n"
         "```\n\n"
         "## Run via installed CLI\n\n"
         "```bash\n"
@@ -258,12 +262,17 @@ def _build_live_demo_script_text(
         "IINTS-AF BOOTH LIVE DEMO SCRIPT\n"
         "===============================\n\n"
         "1. WHAT CODE TO SHOW FIRST\n"
-        "- Show examples/demos/06_booth_demo.py first.\n"
-        "  Reason: it is the shortest, clearest orchestration file and shows the whole story in one screen.\n"
-        "- If someone asks how it really works, open src/iints/analysis/booth_demo.py.\n"
-        "  Reason: that file defines the three scenarios and writes the poster, talk track, and run bundle outputs.\n\n"
+        "- Show examples/demos/07_live_stage_demo.py first.\n"
+        "  Reason: the top of that file exposes the patient profile, output folder, duration, and seed on one screen.\n"
+        "- Point out the visible SDK feature calls in that script:\n"
+        "  run_full(...), generate_results_poster(...), and prepare_ai_ready_artifacts(...).\n"
+        "- Point out that you can swap PATIENT_CONFIG to another packaged profile such as patient_559_config or clinic_safe_hypo_prone.\n"
+        "- If someone asks how the full bundle is generated, open examples/demos/06_booth_demo.py and then src/iints/analysis/booth_demo.py.\n"
+        "  Reason: those files define the three scenarios and write the poster, talk track, and run bundle outputs.\n\n"
         "2. LIVE COMMAND TO RUN\n"
-        "- From the repository root, run:\n"
+        "- From the repository root, run the live stage script:\n"
+        "  ./scripts/run_live_stage_demo.sh\n"
+        "- Or run the booth bundle directly:\n"
         "  ./scripts/run_booth_demo.sh\n"
         "- Or use the installed CLI:\n"
         "  iints demo-booth --output-dir results/booth_demo\n\n"
@@ -304,6 +313,7 @@ def _build_live_demo_script_text(
 def build_booth_demo(
     output_dir: str | Path = "./results/booth_demo",
     *,
+    patient_config: str | Path | dict[str, Any] = "default_patient",
     duration_minutes: int = 360,
     time_step: int = 5,
     seed: int = 42,
@@ -326,7 +336,7 @@ def build_booth_demo(
         outputs = run_full(
             algorithm=spec.algorithm_factory(),
             scenario=spec.scenario,
-            patient_config="default_patient",
+            patient_config=patient_config,
             duration_minutes=duration_minutes,
             time_step=time_step,
             seed=seed,
@@ -375,6 +385,7 @@ def build_booth_demo(
 
     summary_payload = {
         "output_dir": str(resolved_output),
+        "patient_config": str(patient_config),
         "duration_minutes": duration_minutes,
         "time_step_minutes": time_step,
         "seed": seed,
@@ -395,7 +406,7 @@ def build_booth_demo(
     }
     _write_json(resolved_output / "demo_summary.json", summary_payload)
 
-    example_script = Path("examples/demos/06_booth_demo.py")
+    example_script = Path("examples/demos/07_live_stage_demo.py")
     commands_markdown = _build_commands_markdown(
         output_dir=resolved_output,
         example_script=example_script,

{iints_sdk_python35-1.3.0 → iints_sdk_python35-1.3.2}/src/iints/cli/cli.py

@@ -53,6 +53,7 @@ from iints.data.registry import (
 )
 from iints.data.contracts import load_contract_yaml
 from iints.data.synthetic_mirror import generate_synthetic_mirror
+from iints.demo_assets import export_live_stage_demo
 from iints.mdmp.backend import (
     MDMP_GRADE_ORDER,
     active_mdmp_backend,
@@ -2740,6 +2741,39 @@ def demo_booth(
     )
 
 
+@app.command("demo-export")
+def demo_export(
+    output_dir: Annotated[
+        Path,
+        typer.Option(help="Directory where the bundled live stage demo files should be written."),
+    ] = Path("./iints_demo"),
+    overwrite: Annotated[
+        bool,
+        typer.Option("--overwrite/--no-overwrite", help="Allow overwriting exported demo files."),
+    ] = False,
+) -> None:
+    """Export the showable live demo code from the installed SDK."""
+    console = Console()
+    try:
+        outputs = export_live_stage_demo(output_dir=output_dir, overwrite=overwrite)
+    except FileExistsError as exc:
+        console.print(f"[bold red]Demo export stopped:[/bold red] {exc}")
+        raise typer.Exit(code=1)
+    except Exception as exc:
+        console.print(f"[bold red]Demo export failed:[/bold red] {exc}")
+        raise typer.Exit(code=1)
+
+    table = Table(title="IINTS Demo Export")
+    table.add_column("Artifact", style="cyan")
+    table.add_column("Path", overflow="fold")
+    table.add_row("script", outputs["script_path"])
+    table.add_row("notes", outputs["notes_path"])
+    console.print(table)
+    console.print(
+        "[green]Next:[/green] open `07_live_stage_demo.py`, explain the visible SDK calls, then run `python 07_live_stage_demo.py`."
+    )
+
+
 @app.command()
 def report(
     results_csv: Annotated[Path, typer.Option(help="Path to a simulation results CSV")],

iints_sdk_python35-1.3.2/src/iints/demo_assets.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from importlib.resources import files
+from pathlib import Path
+
+
+def export_live_stage_demo(output_dir: str | Path = '.', *, overwrite: bool = False) -> dict[str, str]:
+    """Export the bundled live stage demo script for users running the installed SDK."""
+    resolved_output = Path(output_dir).expanduser().resolve()
+    resolved_output.mkdir(parents=True, exist_ok=True)
+
+    script_target = resolved_output / '07_live_stage_demo.py'
+    notes_target = resolved_output / 'RUN_ME_FIRST.txt'
+
+    if not overwrite and script_target.exists():
+        raise FileExistsError(f'Demo script already exists: {script_target}')
+    if not overwrite and notes_target.exists():
+        raise FileExistsError(f'Instruction file already exists: {notes_target}')
+
+    script_content = files('iints.templates.demos').joinpath('live_stage_demo.py').read_text(encoding='utf-8')
+    notes_content = (
+        'IINTS LIVE DEMO EXPORT\n'
+        '======================\n\n'
+        'This folder was exported from the installed IINTS SDK.\n\n'
+        '1. Activate the virtual environment that contains IINTS.\n'
+        '2. Open 07_live_stage_demo.py and point to:\n'
+        '   - PATIENT_CONFIG\n'
+        '   - OUTPUT_DIR\n'
+        '   - DURATION_MINUTES\n'
+        '   - TIME_STEP_MINUTES\n'
+        '   - SEED\n'
+        '3. Explain that the script visibly calls:\n'
+        '   - run_full(...)\n'
+        '   - generate_results_poster(...)\n'
+        '   - prepare_ai_ready_artifacts(...)\n'
+        '4. Run:\n'
+        '   python 07_live_stage_demo.py\n'
+        '5. Open the generated files under results/booth_demo_live/.\n\n'
+        'Tip: if you also cloned the SDK repo, you can run the repo wrapper instead:\n'
+        '  ./scripts/run_live_stage_demo.sh\n'
+    )
+
+    script_target.write_text(script_content, encoding='utf-8')
+    notes_target.write_text(notes_content, encoding='utf-8')
+
+    return {
+        'output_dir': str(resolved_output),
+        'script_path': str(script_target),
+        'notes_path': str(notes_target),
+    }

iints_sdk_python35-1.3.2/src/iints/templates/demos/__init__.py

@@ -0,0 +1 @@
+"""Bundled demo script templates for installed IINTS users."""