Skip to content

Add notebook DataFrame interface and examples#182

Merged
gparadis merged 1 commit into
mainfrom
feature/p30-notebook-dataframe-interface
Jun 22, 2026
Merged

Add notebook DataFrame interface and examples#182
gparadis merged 1 commit into
mainfrom
feature/p30-notebook-dataframe-interface

Conversation

@gparadis

Copy link
Copy Markdown
Contributor

Summary

  • Adds modelwright.notebooks, a lazy pandas-backed notebook/DataFrame layer over ModelFacade.
  • Adds helpers for declared inputs, outputs, scenarios, tables, reports, and baseline-vs-scenario comparisons.
  • Adds the notebook optional extra with pandas>=2 while keeping pandas out of core runtime dependencies.
  • Adds Sphinx notebook docs plus an Examples Gallery.
  • Adds tracked examples for a tiny synthetic model and a production-size 2020 FABLE generated-model wrapper; the FABLE generated Python output is tracked as compressed .py.xz because the uncompressed module is above ordinary GitHub per-file limits.
  • Bumps package/import/release metadata to 0.1.0a5.

Boundary

This release may claim initial notebook/DataFrame-facing helpers, scenario comparison workflows, and tracked synthetic/FABLE examples. It must not claim full spreadsheet UI behavior, automatic semantic recovery, stable public API compatibility, Excel-backed recalculation equivalence, or compact runtime IR production readiness.

Verification

  • scripts/bootstrap_dev_env.sh
  • .venv/bin/python -m ruff check .
  • .venv/bin/python -m pytest -vv (163 passed, 1 skipped)
  • .venv/bin/sphinx-build -b html docs _build/html -W
  • .venv/bin/python scripts/verify_docs_theme.py _build/html
  • MODELWRIGHT_RUN_FABLE_BENCHMARKS=1 .venv/bin/python -m pytest -vv tests/test_fable_wrapper_benchmark.py (1 passed in 149.67s)
  • scripts/check_release_artifacts.sh (modelwright 0.1.0a5 clean wheel install and CLI smoke passed)

Closes #175.
Closes #178.
Closes #176.
Closes #177.
Closes #179.
Closes #181.
Refs #174.
Refs #180.

@gparadis gparadis merged commit 1b88dd1 into main Jun 22, 2026
5 checks passed
@gparadis gparadis deleted the feature/p30-notebook-dataframe-interface branch June 22, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant