Notebook Series

OpenPinch ships with a packaged notebook series that is treated as part of the supported learning and regression surface. Each notebook is built around one decision question rather than a generic feature tour. The notebooks load bundled sample cases directly through PinchWorkspace(source="sample_case.json", ...) and stay on the supported public API surface.

Included Notebooks

01_basic_pinch_and_dtcont_sensitivity.ipynb: Baseline direct-integration workflow, summary reading, graph inspection, and dt_cont sensitivity using PinchWorkspace plus real PinchProblem cases, including the selected-state targeting call surface.
02_total_site_targets_and_sugcc.ipynb: Zonal and Total Site workflow on a pulp-mill style case, including indirect targeting, selected-state total-site calls, and site utility grand composite interpretation.
03_carnot_hpr_comparison.ipynb: Direct and indirect Carnot HPR and refrigeration comparison using the advanced problem.target.* entry points plus the standard HPR-aware net-load and GCC plot accessors.

How To Use Them

Copy the full series:

openpinch notebook -o notebooks

Copy one notebook:

openpinch notebook --name 02_total_site_targets_and_sugcc.ipynb -o notebooks

Recommended Learning Order

Start with the basic pinch and dt_cont notebook to understand the main process-level workflow and output interpretation.
Move to the Total Site notebook once you are comfortable with zonal and indirect integration concepts.
Use the Carnot HPR notebook after you understand how to read the base utility and graph outputs.

Why These Matter

The notebooks do more than demonstrate commands. They reveal the practical power of the package: named case comparison, hierarchical targeting, graph-based interpretation, and advanced thermal integration studies on top of the same prepared data model. The packaged copies are also kept output-free so the distributed examples do not ship stale plots, tracebacks, or machine-specific execution state.