Sample Cases

The packaged sample cases are not filler assets. They are the fastest path to a reproducible OpenPinch workflow and each one corresponds to a specific part of the supported surface.

Included Cases

basic_pinch.json

Minimal direct-integration process example for first-run validation and baseline graph interpretation.

crude_preheat_train.json

Process-only case that is useful for direct integration and dt_cont sensitivity studies.

zonal_site.json

Hierarchical zone-tree case for multi-zone and aggregated Total Site workflows.

pulp_mill.json

Larger site-style example used in the packaged Total Site notebook.

heat_pump_targeting.json

Compact HPR screening input data for direct Heat Pump experimentation without the larger multi-case notebook flow.

chocolate_factory.json

Advanced direct-versus-indirect Carnot HPR and refrigeration example used in the packaged notebook workflow.

How To Copy Them

Browse or copy the packaged cases through OpenPinch.resources when you want a local editable copy:

from OpenPinch.resources import copy_sample_case, list_sample_cases

print(list_sample_cases())
copy_sample_case("basic_pinch.json", "basic_pinch.json")

You can also load a packaged case by name directly from Python when no local file with that name exists:

from OpenPinch import PinchProblem, PinchWorkspace

problem = PinchProblem("basic_pinch.json")
workspace = PinchWorkspace(
    source="crude_preheat_train.json",
    project_name="crude_preheat_train",
)

Choosing The Right Case

  • Use basic_pinch.json for first-run validation and graph reading.

  • Use crude_preheat_train.json for process-only sensitivity studies.

  • Use zonal_site.json or pulp_mill.json when you need a real zone-tree and indirect integration example.

  • Use heat_pump_targeting.json when you want a smaller direct HPR screening input data.

  • Use chocolate_factory.json when you want to study the advanced direct-versus-indirect HPR and refrigeration surface used by notebook 03.