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 model-specific default attributes config options:
- “FlatPlatePVResidential”
- “FlatPlatePVThirdParty”
- “PVWattsResidential”
- “PVWattsThirdParty”
- “SolarWaterHeatingResidential”
-
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
-
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¶ sequence: Monthly consumption from utility bill [kWh]
Constraints: LENGTH=12
Required: set to 1 if not provided.
-
Occ_Schedule¶ sequence: Hourly occupant schedule [frac/hr]
Constraints: LENGTH=24
Required: set to 1 if not provided.
-
Occupants¶ float: Occupants [#]
Required: set to 1 if not provided.
-
Retrofits¶ float: Energy retrofitted [0/1]
Options: 0=No, 1=Yes
Required: set to 1 if not provided.
-
Stories¶ float: Number of stories [#]
Required: set to 1 if not provided.
-
TCool¶ float: Cooling setpoint [degF]
Required: set to 1 if not provided.
-
TCoolSB¶ float: Cooling setpoint setback [degF]
Required: set to 1 if not provided.
-
THeat¶ float: Heating setpoint [degF]
Required: set to 1 if not provided.
-
THeatSB¶ float: Heating setpoint setback [degf]
Required: set to 1 if not provided.
-
T_Sched¶ sequence: Temperature schedule [0/1]
Constraints: LENGTH=24
Required: set to 1 if not provided.
-
YrBuilt¶ float: Year built [yr]
Required: set to 1 if not provided.
-
en_belpe¶ float: Enable building load calculator [0/1]
Constraints: BOOLEAN
Required: True
-
en_cool¶ float: Enable electric cool [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_dish¶ float: Enable electric dishwasher [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_dry¶ float: Enable electric dryer [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_fridge¶ float: Enable electric fridge [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_heat¶ float: Enable electric heat [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_mels¶ float: Enable misc electric loads [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_range¶ float: Enable electric range [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
en_wash¶ float: Enable electric washer [0/1]
Constraints: BOOLEAN
Required: set to 1 if not provided.
-
floor_area¶ float: Building floor area [m2]
Required: set to 1 if not provided.
-
load¶ sequence: Electricity load (year 1) [kW]
Required: set to 0 if not provided.
-
solar_resource_file¶ str: Weather Data file [n/a]
Constraints: LOCAL_FILE
Required: set to 1 if not provided.
-