Belpe

Electric load calculator for residential buildings

PySAM.Belpe.default(config) → Belpe

Load defaults for the configuration config. Available configurations are:

• “FlatPlatePVResidential”

• “FlatPlatePVThirdParty”

• “PVBatteryResidential”

• “PVBatteryThirdParty”

• “PVWattsBatteryResidential”

• “PVWattsBatteryThirdParty”

• “PVWattsResidential”

• “PVWattsThirdParty”

• “SolarWaterHeatingResidential”

Note

Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.

PySAM.Belpe.from_existing(data, optional config) → Belpe

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Belpe.new() → Belpe

PySAM.Belpe.wrap(ssc_data_t) → Belpe

Load data from a PySSC object.

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap()

Belpe is a wrapper for the SSC compute module cmod_belpe.cpp

Interdependent Variables

The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.

• None

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

get_data_ptr() → Pointer

Get ssc_data_t pointer

replace(dict) → None

Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.

nested_dict = { 'Load Profile Estimator': { var: val, ...}, ...}

unassign(name) → None

Unassign a value in any of the variable groups.

value(name, optional value) → 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(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

LoadProfileEstimator_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

LoadProfileEstimator_vals = { var: val, ...}

Monthly_util

Monthly consumption from utility bill [kWh]

Constraints: LENGTH=12

Required: Required if en_belpe=1

Type:

sequence

Occ_Schedule

Hourly occupant schedule [frac/hr]

Constraints: LENGTH=24

Required: Required if en_belpe=1

Type:

sequence

Occupants

Occupants [#]

Required: Required if en_belpe=1

Type:

float

Retrofits

Energy retrofitted [0/1]

Options: 0=No, 1=Yes

Required: Required if en_belpe=1

Type:

float

Stories

Number of stories [#]

Required: Required if en_belpe=1

Type:

float

TCool

Cooling setpoint [degF]

Required: Required if en_belpe=1

Type:

float

TCoolSB

Cooling setpoint setback [degF]

Required: Required if en_belpe=1

Type:

float

THeat

Heating setpoint [degF]

Required: Required if en_belpe=1

Type:

float

THeatSB

Heating setpoint setback [degf]

Required: Required if en_belpe=1

Type:

float

T_Sched

Temperature schedule [0/1]

Constraints: LENGTH=24

Required: Required if en_belpe=1

Type:

sequence

YrBuilt

Year built [yr]

Required: Required 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: Required if en_belpe=1

Type:

float

en_dish

Enable electric dishwasher [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_dry

Enable electric dryer [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_fridge

Enable electric fridge [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_heat

Enable electric heat [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_mels

Enable misc electric loads [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_range

Enable electric range [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

en_wash

Enable electric washer [0/1]

Constraints: BOOLEAN

Required: Required if en_belpe=1

Type:

float

floor_area

Building floor area [m2]

Required: Required if en_belpe=1

Type:

float

load

Electricity load (year 1) [kW]

INOUT: This variable is both an input and an output to the compute module.

Required: Required if en_belpe=0

Type:

sequence

solar_resource_file

Weather Data file [n/a]

Constraints: LOCAL_FILE

Required: Required if en_belpe=1

Type:

str