GenericSystem¶

Basic power system model using either capacity, capacity factor, and heat rate, or an hourly power generation profile as input

PySAM.GenericSystem.default(config) → GenericSystem¶

Load defaults for the configuration config. Available configurations are:

“GenericBatteryAllEquityPartnershipFlip”

“GenericBatteryCommercial”

“GenericBatteryHostDeveloper”

“GenericBatteryLeveragedPartnershipFlip”

“GenericBatteryMerchantPlant”

“GenericBatteryResidential”

“GenericBatterySaleLeaseback”

“GenericBatterySingleOwner”

“GenericBatteryThirdParty”

“GenericSystemAllEquityPartnershipFlip”

“GenericSystemCommercial”

“GenericSystemHostDeveloper”

“GenericSystemLCOECalculator”

“GenericSystemLeveragedPartnershipFlip”

“GenericSystemMerchantPlant”

“GenericSystemNone”

“GenericSystemResidential”

“GenericSystemSaleLeaseback”

“GenericSystemSingleOwner”

“GenericSystemThirdParty”

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.GenericSystem.from_existing(data, optional config) → GenericSystem¶: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.GenericSystem.new() → GenericSystem¶

PySAM.GenericSystem.wrap(ssc_data_t) → GenericSystem¶: Load data from a PySSC object.

Warning

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

GenericSystem is a wrapper for the SSC compute module cmod_generic_system.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.

conv_eff

heat_rate

Functions¶

class PySAM.GenericSystem.GenericSystem¶

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 = { 'Plant': { var: val, ...}, ...}

execute(int verbosity) → None¶: Execute simulation with verbosity level 0 (default) or 1

export() → dict¶: Export attributes into nested dictionary

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 = { 'Plant': { var: val, ...}, ...}

unassign(name) → None¶: Unassign a value in any of the variable groups.

value(name, optional value) → Union[None, float, dict, sequence, str]¶: Get or set by name a value in any of the variable groups.

Plant Group¶

class PySAM.GenericSystem.GenericSystem.Plant¶

assign(dict) → None¶

Assign attributes from dictionary, overwriting but not removing values.

Plant_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary.

replace(dict) → None¶

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

Plant_vals = { var: val, ...}

conv_eff¶

Conversion Efficiency [%]

Required: True

The value of conv_eff depends on the following variables:

heat_rate

Type:	float

derate¶

Derate [%]

Required: True

Type:	float

energy_output_array¶

Array of Energy Output Profile [kW]

Required: Required if spec_mode=1

Type:	sequence

heat_rate¶

Heat Rate [MMBTUs/MWhe]

Required: True

The value of the following variables depends on heat_rate:

conv_eff

Type:	float

spec_mode¶

0=constant CF,1=profile

Required: True

Type:	float
Type:	Spec mode

system_capacity¶

Nameplace Capcity [kW]

Required: True

Type:	float

user_capacity_factor¶

Capacity Factor [%]

Required: True

Type:	float

Lifetime Group¶

class PySAM.GenericSystem.GenericSystem.Lifetime¶

assign(dict) → None¶

Assign attributes from dictionary, overwriting but not removing values.

Lifetime_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary.

replace(dict) → None¶

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

Lifetime_vals = { var: val, ...}

analysis_period¶

Lifetime analysis period [years]

Required: Required if system_use_lifetime_output=1

Type:	float

generic_degradation¶

Annual AC degradation [%/year]

Required: Required if system_use_lifetime_output=1

Type:	sequence

system_use_lifetime_output¶

Generic lifetime simulation [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:	float

AdjustmentFactors Group¶

class PySAM.GenericSystem.GenericSystem.AdjustmentFactors¶

assign() → None¶: Assign attributes from dictionary

export() → Dict¶: Export attributes into dictionary

constant¶

float

Type:	type

dc_constant¶: DC Constant loss adjustment [%]

dc_hourly¶: DC Hourly Adjustment Factors [%]

dc_periods¶: DC Period-based Adjustment Factors [%]

hourly¶: AC Hourly Adjustment Factors [%]

periods¶: AC Period-based Adjustment Factors [%]

sf_constant¶: DC Constant loss adjustment [%]

sf_hourly¶: DC Hourly Adjustment Factors [%]

sf_periods¶: DC Period-based Adjustment Factors [%]

Outputs Group¶

class PySAM.GenericSystem.GenericSystem.Outputs¶

assign(dict) → None¶

Assign attributes from dictionary, overwriting but not removing values.

Outputs_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary.

replace(dict) → None¶

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

Outputs_vals = { var: val, ...}

annual_energy¶

Annual Energy [kWh]

Type:	float

annual_energy_distribution_time¶

Annual energy production as function of time [kW]

Type:	sequence[sequence]

annual_fuel_usage¶

Annual Fuel Usage [kWht]

Type:	float

capacity_factor¶

Capacity factor [%]

Type:	float

gen¶

System power generated [kW]

Type:	sequence

kwh_per_kw¶

First year kWh/kW [kWh/kW]

Type:	float

monthly_energy¶

Monthly Energy [kWh]

Type:	sequence

system_heat_rate¶

Heat Rate Conversion Factor [MMBTUs/MWhe]

Type:	float

water_usage¶

Annual Water Usage

Type:	float