reV.SAM.SAM.Sam

class Sam

Bases: object

reV wrapper on the PySAM framework.

Methods

assign_inputs(inputs[, raise_warning])	Assign a flat dictionary of inputs to the PySAM object.
default()	Get the executed default pysam object.
execute()	Call the PySAM execute method.

Attributes

IGNORE_ATTRS
attr_dict	Get the heirarchical PySAM object attribute dictionary.
input_list	Get the list of lowest level input attribute/variable names.
pysam	Get the pysam object.

PYSAM = <module 'PySAM.CustomGeneration' from '/opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/PySAM/CustomGeneration.cpython-311-x86_64-linux-gnu.so'>

property pysam

Get the pysam object.

classmethod default()

Get the executed default pysam object.

Returns:

PySAM.CustomGeneration

property attr_dict

Get the heirarchical PySAM object attribute dictionary.

Returns:

_attr_dict (dict) –

Dictionary with:

keys: variable groups values: lowest level attribute/variable names

property input_list

Get the list of lowest level input attribute/variable names.

Returns:

_inputs (list) – List of lowest level input attributes.

execute()

Call the PySAM execute method. Raise SAMExecutionError if error.

assign_inputs(inputs, raise_warning=False)

Assign a flat dictionary of inputs to the PySAM object.

Parameters:

• inputs (dict) – Flat (single-level) dictionary of PySAM inputs.

• raise_warning (bool) – Flag to raise a warning for inputs that are not set because they are not found in the PySAM object.