Annualoutput¶
Wrapper for SAM Simulation Core model: cmod_annualoutput.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.
Annualoutput model description
Annualoutput
-
PySAM.Annualoutput.
default
(config) → Annualoutput¶ Use financial config-specific default attributes
-
PySAM.Annualoutput.
from_existing
(data, optional config) → Annualoutput¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Annualoutput.
new
() → Annualoutput¶
-
PySAM.Annualoutput.
wrap
(ssc_data_t) → Annualoutput¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Annualoutput.
Annualoutput
¶ 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 = { 'AnnualOutput': { 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.
-
AnnualOutput Group¶
-
class
PySAM.Annualoutput.Annualoutput.
AnnualOutput
¶ -
assign
() → None¶ Assign attributes from dictionary
AnnualOutput_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
analysis_period
¶ Analyis period [years]
Constraints: INTEGER,MIN=0,MAX=50
Required: If not provided, assumed to be 30
Type: float
-
energy_availability
¶ Annual energy availability [%]
Required: True
Type: sequence
-
energy_curtailment
¶ First year energy curtailment
Info: (0..1)
Required: True
Type: sequence[sequence]
-
energy_degradation
¶ Annual energy degradation [%]
Required: True
Type: sequence
-
system_hourly_energy
¶ Hourly energy produced by the system [kW]
Required: True
Type: sequence
-
system_use_lifetime_output
¶ Lifetime hourly system outputs [0/1]
Options: 0=hourly first year,1=hourly lifetime
Constraints: INTEGER,MIN=0
Required: True
Type: float
-
Outputs Group¶
-
class
PySAM.Annualoutput.Annualoutput.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
annual_availability
¶ Annual availability
Type: sequence
-
annual_degradation
¶ Annual degradation
Type: sequence
-
annual_energy
¶ Annual energy [kWh]
Type: sequence
-
hourly_energy
¶ Hourly energy [kWh]
Type: sequence
-
monthly_energy
¶ Monthly energy [kWh]
Type: sequence
-