GenericSystem¶
Wrapper for SAM Simulation Core model: cmod_generic_system.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.
GenericSystem model description
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¶ Use financial model-specific default attributes config options:
- “GenericSystemAllEquityPartnershipFlip”
- “GenericSystemCommercial”
- “GenericSystemCommercialPPA”
- “GenericSystemHostDeveloper”
- “GenericSystemIndependentPowerProducer”
- “GenericSystemLCOECalculator”
- “GenericSystemLeveragedPartnershipFlip”
- “GenericSystemNone”
- “GenericSystemResidential”
- “GenericSystemSaleLeaseback”
- “GenericSystemSingleOwner”
- “GenericSystemThirdParty”
-
PySAM.GenericSystem.new() → GenericSystem¶
-
PySAM.GenericSystem.wrap(ssc_data_t) → GenericSystem¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
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
-
Plant Group¶
-
class
PySAM.GenericSystem.GenericSystem.Plant¶ -
assign() → None¶ Assign attributes from dictionary
Plant_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
conv_eff¶ float: Conversion Efficiency [%]
Required: True
-
derate¶ float: Derate [%]
Required: True
-
energy_output_array¶ sequence: Array of Energy Output Profile [kW]
Required: set to 1 if not provided.
-
heat_rate¶ float: Heat Rate [MMBTUs/MWhe]
Required: True
-
spec_mode¶ float: Spec mode: 0=constant CF,1=profile
Required: True
-
system_capacity¶ float: Nameplace Capcity [kW]
Required: True
-
user_capacity_factor¶ float: Capacity Factor [%]
Required: True
-
Lifetime Group¶
-
class
PySAM.GenericSystem.GenericSystem.Lifetime¶ -
assign() → None¶ Assign attributes from dictionary
Lifetime_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
analysis_period¶ float: Lifetime analysis period [years]
Required: set to 1 if not provided.
-
generic_degradation¶ sequence: Annual module degradation [%/year]
Required: set to 1 if not provided.
-
system_use_lifetime_output¶ float: Generic lifetime simulation [0/1]
Constraints: INTEGER,MIN=0,MAX=1
Required: set to 0 if not provided.
-
AdjustmentFactors Group¶
-
class
PySAM.GenericSystem.GenericSystem.AdjustmentFactors¶ -
assign() → None¶ Assign attributes from dictionary
-
export() → Dict¶ Export attributes into dictionary
-
constant¶ type: float
-
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() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
annual_energy¶ float: Annual Energy [kWh]
-
annual_fuel_usage¶ float: Annual Fuel Usage [kWht]
-
capacity_factor¶ float: Capacity factor [%]
-
gen¶ sequence: System power generated [kW]
-
kwh_per_kw¶ float: First year kWh/kW [kWh/kW]
-
monthly_energy¶ sequence: Monthly Energy [kWh]
-
system_heat_rate¶ float: Heat Rate Conversion Factor [MMBTUs/MWhe]
-
water_usage¶ float: Annual Water Usage
-