Tutorial Coverage Map

Coverage Result

The released public denominator contains 186 operations across PinchProblem, PinchWorkspace, targeting, all-period targeting, components and returned component results, ordered case batches, HEN design/result views, and plotting. The canonical manifest maps all 186 live operations to tutorial code cells: 186/186, or 100 percent mapping coverage.

Operation coverage and notebook execution coverage are different. The base profile is executed in routine CI. slow-hpr, solver, and interactive have executable opt-in gates and require their declared environment. A profile is not reported as executed merely because its operations are mapped. The execution_evidence column distinguishes routine execution, opt-in profiles, and batch-delegation contracts.

The two Brayton callables, and their batch mirrors, are mapped but explicitly marked runtime unsupported while the underlying solver contract is under repair. Tutorial 09 demonstrates handling that status as a screening outcome; the map does not misreport those callables as successful analyses.

Counting Rules

  • The live public classes and accessors form the denominator.

  • Only executable code-cell references count; Markdown mentions do not.

  • Every manifest operation must exist live and every primary tutorial must be packaged.

  • A removed operation leaves the denominator only after it is absent from the live facade and tutorials. No compatibility alias is counted.

  • Properties and accessors use the cached observation semantic mode.

  • Named analysis/design methods use explicit execution. Export and dashboard calls use explicit side effect.

  • Constructors and returned result operations are included; coverage is not limited to methods reached by a shallow accessor scan.

  • Source type, zone scope, configuration precedence, placement, period scope, aggregation, workspace selection, HEN method, and plot behavior are tracked as separate semantic dimensions.

Execution Profiles

Run an optional profile only in an environment containing its declared extras:

OPENPINCH_TUTORIAL_PROFILES=slow-hpr uv run pytest \
  tests/packaging/test_notebooks.py -k optional_profile

Use solver or interactive in place of slow-hpr. The routine gate always executes every base notebook from a clean temporary directory.

Release Verification Snapshot

For this release candidate, all declared profiles were executed from clean temporary directories:

  • base: 10 notebooks, passed in the routine non-solver suite;

  • slow-hpr: 4 notebooks, passed;

  • solver: 3 HEN notebooks, passed with the synthesis environment; and

  • interactive: 1 notebook, passed with dashboard launch guarded while real plot and workbook exports executed.

Numerical infeasibility is a valid screening result and is retained with its reason. It is distinct from an unsupported method and from a test failure.

Canonical Manifest

Public operation to tutorial coverage

owner

operation

classification

semantic_mode

primary_tutorial

secondary_tutorials

execution_profile

optional_dependency

coverage_status

source_type

zone_scope

config_precedence

placement

period_scope

aggregation

workspace_selection

hen_method

plot_behavior

execution_evidence

PinchProblem

PinchProblem.__init__

constructor

preparation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

packaged sample;mapping

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.__init__

constructor

preparation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

packaged sample;mapping

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.cold_streams

property

cached observation

03_multisegment_streams.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.cold_utilities

property

cached observation

03_multisegment_streams.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.compare_to

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.components

accessor

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

PinchProblem

PinchProblem.config

property

cached observation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.design

accessor

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: solver

PinchProblem

PinchProblem.export_excel

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.hot_streams

property

cached observation

03_multisegment_streams.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.hot_utilities

property

cached observation

03_multisegment_streams.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.load

method

preparation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

packaged sample;mapping

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.master_zone

property

cached observation

03_multisegment_streams.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.metrics

method

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.period_ids

property

cached observation

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.period_results

property

cached observation

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.plot

accessor

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.problem_data

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.problem_filepath

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.process_components

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

PinchProblem

PinchProblem.project_name

property

cached observation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.report

method

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.results

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.set_dt_cont_multiplier

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.show_dashboard

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.summary_frame

method

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.target

accessor

cached observation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

site

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.to_problem_json

method

explicit execution

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: interactive

PinchProblem

PinchProblem.update_options

method

preparation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.validate

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchProblem

PinchProblem.validation_report

method

cached observation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.active_case_name

property

cached observation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.case

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.cases

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.compare_cases

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.compare_to

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.components

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

opt-in executable profile: interactive

PinchWorkspace

PinchWorkspace.config

property

cached observation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.design

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

opt-in executable profile: interactive

PinchWorkspace

PinchWorkspace.export_excel

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

opt-in executable profile: interactive

PinchWorkspace

PinchWorkspace.list_cases

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.load

method

preparation

05_workspace_persistence.ipynb

base

none

mapped and executable

packaged sample;mapping

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.load_bundle

method

preparation

05_workspace_persistence.ipynb

base

none

mapped and executable

workspace bundle

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.master_zone

property

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.metrics

method

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.plot

property

cached observation

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

opt-in executable profile: interactive

PinchWorkspace

PinchWorkspace.problem_data

property

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.problem_filepath

property

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.report

method

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.results

property

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.save_bundle

method

explicit execution

05_workspace_persistence.ipynb

base

none

mapped and executable

workspace bundle

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.scenario

method

preparation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.set_dt_cont_multiplier

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.show_dashboard

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

opt-in executable profile: interactive

PinchWorkspace

PinchWorkspace.summary_frame

method

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.target

property

cached observation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.to_problem_json

method

explicit execution

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.update_options

method

preparation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

stored fallback

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.use_case

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.validate

method

explicit execution

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

PinchWorkspace

PinchWorkspace.validation_report

method

cached observation

05_workspace_persistence.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

active case

n/a

n/a

routine pytest execution

Target

problem.target.all_heat_integration

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.all_periods

property

cached observation

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

Target

problem.target.brayton_heat_pump

method

explicit execution

09_vapour_compression_and_brayton.ipynb

slow-hpr

hpr

mapped; runtime unsupported

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.brayton_refrigeration

method

explicit execution

09_vapour_compression_and_brayton.ipynb

slow-hpr

hpr

mapped; runtime unsupported

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.carnot_heat_pump

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.carnot_refrigeration

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.cogeneration

method

explicit execution

12_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.direct_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.energy_transfer

method

explicit execution

14_energy_transfer.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.exergy

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.heat_exchanger_area_and_cost

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.indirect_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.isentropic_cogeneration

method

explicit execution

12_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.mvr_heat_pump

method

explicit execution

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.sun_smith_cogeneration

method

explicit execution

12_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.total_site_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

Target

problem.target.vapour_compression_heat_pump

method

explicit execution

09_vapour_compression_and_brayton.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.vapour_compression_refrigeration

method

explicit execution

09_vapour_compression_and_brayton.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Target

problem.target.varbanov_cogeneration

method

explicit execution

12_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.all_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.carnot_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

all periods

per-period;weighted average

n/a

n/a

n/a

opt-in executable profile: slow-hpr

All-period target

problem.target.all_periods.carnot_refrigeration

method

explicit execution

10_multiperiod_heat_pumps.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

all periods

per-period;weighted average

n/a

n/a

n/a

opt-in executable profile: slow-hpr

All-period target

problem.target.all_periods.cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.direct_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.energy_transfer

method

explicit execution

14_energy_transfer.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

all periods

single result

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.exergy

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

single result

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.heat_exchanger_area_and_cost

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

single result

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.indirect_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.isentropic_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.mvr_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process

all periods

per-period;weighted average

n/a

n/a

n/a

opt-in executable profile: slow-hpr

All-period target

problem.target.all_periods.sun_smith_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.total_site_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

All-period target

problem.target.all_periods.vapour_compression_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

opt-in executable profile: slow-hpr

All-period target

problem.target.all_periods.vapour_compression_refrigeration

method

explicit execution

10_multiperiod_heat_pumps.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

opt-in executable profile: slow-hpr

All-period target

problem.target.all_periods.varbanov_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

n/a

n/a

n/a

routine pytest execution

Components

problem.components.add_process_mvr

method

explicit execution

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

keyword > options > stored config > default

process

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Components

problem.components.inventory

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Design

problem.design.enhanced_heat_exchanger_network

method

explicit execution

16_advanced_hen_methods.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

enhanced_heat_exchanger_network

n/a

opt-in executable profile: solver

Design

problem.design.heat_exchanger_network

method

explicit execution

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

heat_exchanger_network

n/a

opt-in executable profile: solver

Design

problem.design.multiperiod_heat_exchanger_network

method

explicit execution

17_multiperiod_hen_synthesis.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

per-period;weighted average

n/a

multiperiod_heat_exchanger_network

n/a

opt-in executable profile: solver

Design

problem.design.network_evolution

method

explicit execution

16_advanced_hen_methods.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

network_evolution

n/a

opt-in executable profile: solver

Design

problem.design.open_hens

method

explicit execution

16_advanced_hen_methods.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

open_hens

n/a

opt-in executable profile: solver

Design

problem.design.pinch_design

method

explicit execution

16_advanced_hen_methods.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

pinch_design

n/a

opt-in executable profile: solver

Design

problem.design.thermal_derivative

method

explicit execution

16_advanced_hen_methods.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

n/a

thermal_derivative

n/a

opt-in executable profile: solver

Design result

design_result.grid

method

explicit execution

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.network

method

explicit execution

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.result

property

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.selected_network

property

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.top

method

explicit execution

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.total_cold_utility

property

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.total_heat_recovery

property

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.total_hot_utility

property

cached observation

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Design result

design_result.utility

method

explicit execution

15_hen_synthesis_and_selection.ipynb

solver

hen

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

ranked result inspection

n/a

opt-in executable profile: solver

Plot

problem.plot.balanced_composite_curve

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.catalog

method

cached observation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.composite_curve

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.data

method

cached observation

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.energy_transfer_diagram

method

explicit execution

14_energy_transfer.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.exergetic_grand_composite_curve

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.exergetic_net_load_profiles

method

explicit execution

07_area_cost_and_exergy.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.export

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure;explicit export

opt-in executable profile: interactive

Plot

problem.plot.export_gallery

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure;explicit export

opt-in executable profile: interactive

Plot

problem.plot.grand_composite_curve

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.grand_composite_curve_with_heat_pump

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

opt-in executable profile: slow-hpr

Plot

problem.plot.net_load_profiles

method

explicit execution

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

opt-in executable profile: interactive

Plot

problem.plot.net_load_profiles_with_heat_pump

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

opt-in executable profile: slow-hpr

Plot

problem.plot.real_grand_composite_curve

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.shifted_composite_curve

method

explicit execution

01_first_solve_and_core_curves.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.site_utility_grand_composite_curve

method

explicit execution

02_focused_direct_and_total_site.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Plot

problem.plot.total_site_profiles

method

explicit execution

02_focused_direct_and_total_site.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

n/a

n/a

selected period

single result

n/a

n/a

return figure

routine pytest execution

Process MVR result

mvr.activate

method

explicit execution

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.active

accessor

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.affected_zone_paths

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.component_type

accessor

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.deactivate

method

explicit execution

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.original_streams

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.replacement_streams

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.stage_results_by_period

property

cached observation

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Process MVR result

mvr.work_for_zone

method

explicit execution

11_process_mvr_and_cascade.ipynb

slow-hpr

hpr

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

n/a

n/a

n/a

opt-in executable profile: slow-hpr

Case batch

batch.export_excel

method

explicit side effect

18_results_plots_reports_exports.ipynb

interactive

plot;excel;dashboard

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: interactive

Case batch

batch.metrics

method

cached observation

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Case batch

batch.reports

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Case batch

batch.summary_frames

method

explicit execution

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

n/a

n/a

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.all_heat_integration

method

explicit execution

01_first_solve_and_core_curves.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.all_periods

property

cached observation

06_multiperiod_heat_integration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.brayton_heat_pump

method

explicit execution

09_vapour_compression_and_brayton.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped; runtime unsupported

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.brayton_refrigeration

method

explicit execution

09_vapour_compression_and_brayton.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped; runtime unsupported

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.carnot_heat_pump

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.carnot_refrigeration

method

explicit execution

08_carnot_heat_pump_and_refrigeration.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.cogeneration

method

explicit execution

12_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.direct_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.energy_transfer

method

explicit execution

14_energy_transfer.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.exergy

method

explicit execution

07_area_cost_and_exergy.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.heat_exchanger_area_and_cost

method

explicit execution

07_area_cost_and_exergy.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.indirect_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.isentropic_cogeneration

method

explicit execution

12_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.mvr_heat_pump

method

explicit execution

11_process_mvr_and_cascade.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.sun_smith_cogeneration

method

explicit execution

12_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.total_site_heat_integration

method

explicit execution

02_focused_direct_and_total_site.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch target

batch.target.vapour_compression_heat_pump

method

explicit execution

09_vapour_compression_and_brayton.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.vapour_compression_refrigeration

method

explicit execution

09_vapour_compression_and_brayton.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch target

batch.target.varbanov_cogeneration

method

explicit execution

12_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.all_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.carnot_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch all-period target

batch.target.all_periods.carnot_refrigeration

method

explicit execution

10_multiperiod_heat_pumps.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process;utility

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch all-period target

batch.target.all_periods.cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.direct_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.energy_transfer

method

explicit execution

14_energy_transfer.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

focused zone;site;total site

keyword > options > stored config > default

n/a

all periods

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.exergy

method

explicit execution

07_area_cost_and_exergy.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.heat_exchanger_area_and_cost

method

explicit execution

07_area_cost_and_exergy.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

single result

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.indirect_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.isentropic_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.mvr_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

process

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch all-period target

batch.target.all_periods.sun_smith_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.total_site_heat_integration

method

explicit execution

06_multiperiod_heat_integration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch all-period target

batch.target.all_periods.vapour_compression_heat_pump

method

explicit execution

10_multiperiod_heat_pumps.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch all-period target

batch.target.all_periods.vapour_compression_refrigeration

method

explicit execution

10_multiperiod_heat_pumps.ipynb

04_workspace_cases_and_scenarios.ipynb

slow-hpr

hpr

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; opt-in executable profile: slow-hpr

Batch all-period target

batch.target.all_periods.varbanov_cogeneration

method

explicit execution

13_multiperiod_cogeneration.ipynb

04_workspace_cases_and_scenarios.ipynb

base

none

mapped and executable

n/a

site

keyword > options > stored config > default

n/a

all periods

per-period;weighted average

named case;active case;ordered batch

n/a

n/a

batch delegation contract; routine pytest execution

Batch design

batch.design.enhanced_heat_exchanger_network

method

explicit execution

16_advanced_hen_methods.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

enhanced_heat_exchanger_network

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.heat_exchanger_network

method

explicit execution

15_hen_synthesis_and_selection.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

heat_exchanger_network

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.multiperiod_heat_exchanger_network

method

explicit execution

17_multiperiod_hen_synthesis.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

per-period;weighted average

named case;active case;ordered batch

multiperiod_heat_exchanger_network

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.network_evolution

method

explicit execution

16_advanced_hen_methods.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

network_evolution

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.open_hens

method

explicit execution

16_advanced_hen_methods.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

open_hens

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.pinch_design

method

explicit execution

16_advanced_hen_methods.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

pinch_design

n/a

batch delegation contract; opt-in executable profile: solver

Batch design

batch.design.thermal_derivative

method

explicit execution

16_advanced_hen_methods.ipynb

04_workspace_cases_and_scenarios.ipynb

solver

hen

mapped and executable

n/a

n/a

keyword > options > stored config > default

n/a

selected period

single result

named case;active case;ordered batch

thermal_derivative

n/a

batch delegation contract; opt-in executable profile: solver

API owners are documented in PinchProblem and PinchWorkspace. Tutorial owners are described in Notebook Series.