Belpe¶
Wrapper for SAM Simulation Core model: cmod_belpe.cpp
Creating an Instance¶
There are three methods to create a new instance of a PySAM module. Using default
populates the newclass’ attributes with default values specific to a config
. Each technology-financialconfiguration corresponds to a SAM GUI configuration. Using new
creates an instance with empty attributes. The wrap
function allows compatibility with PySSC, for details, refer to PySSC.
Belpe model description
Electric load calculator for residential buildings
-
PySAM.Belpe.
default
(config) → Belpe¶ Use financial config-specific default attributes config options:
- “FlatPlatePVResidential”
- “FlatPlatePVThirdParty”
- “GenericBatteryResidential”
- “GenericBatteryThirdParty”
- “PVBatteryResidential”
- “PVBatteryThirdParty”
- “PVWattsBatteryResidential”
- “PVWattsBatteryThirdParty”
- “PVWattsResidential”
- “PVWattsThirdParty”
- “SolarWaterHeatingResidential”
-
PySAM.Belpe.
from_existing
(data, optional config) → Belpe¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Belpe.
new
() → Belpe¶
-
PySAM.Belpe.
wrap
(ssc_data_t) → Belpe¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Belpe.
Belpe
¶ This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.
-
assign
(dict) → None¶ Assign attributes from nested dictionary, except for Outputs
nested_dict = { 'Load Profile Estimator': { var: val, ...}, ...}
-
execute
(int verbosity) → None¶ Execute simulation with verbosity level 0 (default) or 1
-
export
() → dict¶ Export attributes into nested dictionary
-
value
(name, optional value) → Union[None, float, dict, sequence, str]¶ Get or set by name a value in any of the variable groups.
-
LoadProfileEstimator Group¶
-
class
PySAM.Belpe.Belpe.
LoadProfileEstimator
¶ -
assign
() → None¶ Assign attributes from dictionary
LoadProfileEstimator_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
Monthly_util
¶ Monthly consumption from utility bill [kWh]
Constraints: LENGTH=12
Required: True if en_belpe=1
Type: sequence
-
Occ_Schedule
¶ Hourly occupant schedule [frac/hr]
Constraints: LENGTH=24
Required: True if en_belpe=1
Type: sequence
-
Occupants
¶ Occupants [#]
Required: True if en_belpe=1
Type: float
-
Retrofits
¶ Energy retrofitted [0/1]
Options: 0=No, 1=Yes
Required: True if en_belpe=1
Type: float
-
Stories
¶ Number of stories [#]
Required: True if en_belpe=1
Type: float
-
TCool
¶ Cooling setpoint [degF]
Required: True if en_belpe=1
Type: float
-
TCoolSB
¶ Cooling setpoint setback [degF]
Required: True if en_belpe=1
Type: float
-
THeat
¶ Heating setpoint [degF]
Required: True if en_belpe=1
Type: float
-
THeatSB
¶ Heating setpoint setback [degf]
Required: True if en_belpe=1
Type: float
-
T_Sched
¶ Temperature schedule [0/1]
Constraints: LENGTH=24
Required: True if en_belpe=1
Type: sequence
-
YrBuilt
¶ Year built [yr]
Required: True if en_belpe=1
Type: float
-
en_belpe
¶ Enable building load calculator [0/1]
Constraints: BOOLEAN
Required: True
Type: float
-
en_cool
¶ Enable electric cool [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_dish
¶ Enable electric dishwasher [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_dry
¶ Enable electric dryer [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_fridge
¶ Enable electric fridge [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_heat
¶ Enable electric heat [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_mels
¶ Enable misc electric loads [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_range
¶ Enable electric range [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
en_wash
¶ Enable electric washer [0/1]
Constraints: BOOLEAN
Required: True if en_belpe=1
Type: float
-
floor_area
¶ Building floor area [m2]
Required: True if en_belpe=1
Type: float
-
load
¶ Electricity load (year 1) [kW]
Required: True if en_belpe=0
Type: sequence
-
solar_resource_file
¶ Weather Data file [n/a]
Constraints: LOCAL_FILE
Required: True if en_belpe=1
Type: str
-