API Reference

Reference for the tmhp package’s support modules — the lower-level building blocks the system models compose internally. For the system-level models you instantiate directly (ASHPB, GSHPB, WSHPB, ASHP, GSHP), see Models.

Support modules

Lower-level building blocks used by the system models.

Refrigerant & thermodynamics

CoolProp state-point helpers, cycle analysis, and COP correlations.

Refrigerant & thermodynamics
Heat transfer & exchangers

ε-NTU heat exchanger model, air-side fan and heat-exchanger calculations, and borehole g-function.

Heat transfer & exchangers
Demand & weather

Outdoor air temperature utilities and domestic hot water demand profiles.

Demand & weather
Subsystems

Solar thermal collector, photovoltaic system, energy storage system, and UV treatment.

Subsystems
Simulation helpers

Per-step dynamic context, energy / exergy helpers, and stdout summary tables.

Simulation helpers
Visualization

Plotting facade and Mollier (T-h / P-h / T-s) diagrams.

Visualization
Utilities & constants

Unit-conversion helpers and physical constants.

Utilities & constants