Wfcheck

Wrapper for SAM Simulation Core model: cmod_wfcheck.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.

Wfcheck model description

Wfcheck

PySAM.Wfcheck.default(config) → Wfcheck

Use financial config-specific default attributes

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

Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.

PySAM.Wfcheck.new() → Wfcheck
PySAM.Wfcheck.wrap(ssc_data_t) → Wfcheck

Use existing PySSC data

Warning

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

Functions

class PySAM.Wfcheck.Wfcheck

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 = { 'Weather File Checker': { 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.

WeatherFileChecker Group

class PySAM.Wfcheck.Wfcheck.WeatherFileChecker
assign() → None

Assign attributes from dictionary

WeatherFileChecker_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

input_file

Input weather file name

Info: wfcsv format

Required: True

Type:str

Outputs Group