Models¶

System-level heat pump models — the classes you instantiate directly. Each page below is a 1-stop reference for one model family: how it plugs the shared refrigerant cycle into a specific source / sink pairing, what the system-specific mechanics look like, how to compose subsystems (STC, PV + ESS) on top, and the full API reference.

The families are peers around one cycle core, but the docs distinguish implemented public APIs from future source/sink combinations. The released combinations are ASHPB, GSHPB, and WSHPB for DHW tanks, plus ASHP and GSHP for building heating/cooling loads. Getting Started uses the ASHPB reference case because it is validated and has the smallest input surface, not because the library is limited to heat-pump boilers.

TMHP released source and sink matrix showing ASHPB, GSHPB, and WSHPB for DHW and ASHP and GSHP for space conditioning. — TMHP model families differ by released source/sink boundary while sharing the same refrigerant-cycle calculations and diagnostics.¶

Code-backed family matrix¶

Public class	Source boundary	Demand boundary	Operating mode	Public time boundary
`tmhp.AirSourceHeatPumpBoiler`	Outdoor air coil	DHW tank charge	Heating / tank charge	`analyze_steady()`, `analyze_dynamic()`, `step()`
`tmhp.GroundSourceHeatPumpBoiler`	Borehole field	DHW tank charge	Heating / tank charge	`analyze_steady()`, `analyze_dynamic()`; point-state `step()` is intentionally unavailable because the borehole response is history-dependent.
`tmhp.WaterSourceHeatPumpBoiler`	Prescribed water loop	DHW tank charge	Heating / tank charge	`analyze_steady()`, `analyze_dynamic()`
`tmhp.AirSourceHeatPump`	Outdoor air coil	Indoor-unit building load	`Q_r_iu > 0` cooling, `Q_r_iu < 0` heating	`analyze_steady()`, `analyze_dynamic()`
`tmhp.GroundSourceHeatPump`	Borehole field	Indoor-unit building load	`Q_r_iu > 0` cooling, `Q_r_iu < 0` heating	`analyze_steady()`, `analyze_dynamic()`

Only tmhp.AirSourceHeatPumpBoiler has a quantitative catalogue validation page today. The other cycle-resolved families share the same refrigerant-cycle core and have smoke coverage on representative operating points. tmhp.GroundSourceHeatPumpEmpirical is documented on the GSHP page as a faster EquationFit alternative; it is not one of the refrigerant-cycle-core families in the matrix above.

Air-source heat pump boiler

ASHPB core + STC preheat, STC stratified tank, PV + ESS composed variants. The validated reference example.

Air-source heat pump boiler (ASHPB)

Ground-source heat pump boiler

GSHPB core with g-function borehole, plus the same three composed variants as ASHPB.

Ground-source heat pump boiler (GSHPB)

Water-source heat pump boiler

WSHPB with a prescribed water-loop inlet temperature.

Water-source heat pump boiler (WSHPB)

Air-source heat pump (space conditioning)

ASHP for building heating / cooling load instead of DHW.

Air-source heat pump (ASHP — space conditioning)