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.
ASHPB is the most commonly used model and the one Getting Started walks you through. The remaining pages mirror the same template so moving between source families feels uniform.
ASHPB core + STC preheat, STC stratified tank, PV + ESS composed variants. The default first stop.
GSHPB core with g-function borehole, plus the same three composed variants as ASHPB.
WSHPB with a prescribed water-loop inlet temperature.
ASHP for building heating / cooling load instead of DHW.
GSHP for building heating / cooling load instead of DHW.