Poacalib

Poacalib

PySAM.Poacalib.default(config) → Poacalib

Load defaults for the configuration config. Available configurations are:

  • None

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.Poacalib.from_existing(data, optional config) → Poacalib

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

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

Load data from a PySSC object.

Warning

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

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

  • None

Functions

class PySAM.Poacalib.Poacalib

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 = { 'POA Calibrate': { 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 = { 'POA Calibrate': { 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.

POACalibrate Group

class PySAM.Poacalib.Poacalib.POACalibrate
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

POACalibrate_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

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

POACalibrate_vals = { var: val, ...}

albedo

Albedo

Constraints: MIN=0,MAX=1

Required: True

Type:float
array_az

Array Azimuth [degrees]

Options: 0=N, 90=E, 180=S

Constraints: MIN=0,MAX=360

Required: True

Type:float
array_tilt

Array tilt [degrees]

Info: 0-90

Constraints: MIN=0,MAX=90

Required: True

Type:float
beam

Beam Irradiation [W/m^2]

Constraints: LENGTH=8760

Required: True

Type:sequence
diffuse

Diffuse Irradiation [W/m^2]

Constraints: LENGTH=8760

Required: True

Type:sequence
elevation

Elevation [m]

Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.

Type:float
latitude

Latitude [decimal degrees]

Options: N= positive

Required: True

Type:float
longitude

Longitude [decimal degrees]

Options: E= positive

Required: True

Type:float
poa

Plane of Array [W/m^2]

Constraints: LENGTH=8760

Required: True

Type:sequence
pressure

Pressure [millibars]

Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.

Type:float
tamb

Ambient Temperature (dry bulb temperature) [°C]

Required: False for configuration with default inputs. May be required if a variable dependent on its value changes. Example: For the Detailed PV - Single Owner configuration, only Subarray 1 is enabled in the configuration defaults, so Subarray 2 inputs would not be required; if Subarray 2 is enabled, then Subarray 2 inputs is required.

Type:float
time_zone

Time Zone

Options: -7= Denver

Constraints: MIN=-12,MAX=12

Required: True

Type:float
year

Year

Required: True

Type:float

Outputs Group

class PySAM.Poacalib.Poacalib.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, ...}

pcalc

Calculated POA [W/m^2]

Type:sequence