Irradproc¶
Irradproc
-
PySAM.Irradproc.
default
(config) → Irradproc¶ 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.Irradproc.
from_existing
(data, optional config) → Irradproc¶ Share data with an existing PySAM class. If
optional config
is a valid configuration name, load the module’s defaults for that configuration.
-
PySAM.Irradproc.
new
() → Irradproc¶
-
PySAM.Irradproc.
wrap
(ssc_data_t) → Irradproc¶ Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
Irradproc is a wrapper for the SSC compute module cmod_irradproc.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.Irradproc.
Irradproc
¶ 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 = { 'Irradiance Processor': { 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 = { 'Irradiance Processor': { 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.
-
IrradianceProcessor Group¶
-
class
PySAM.Irradproc.Irradproc.
IrradianceProcessor
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values.
IrradianceProcessor_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary.
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input
dict
.IrradianceProcessor_vals = { var: val, ...}
-
albedo
¶ Ground reflectance (time depend.) [frac]
Info: 0..1
Constraints: LENGTH_EQUAL=beam
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: sequence
-
albedo_const
¶ Ground reflectance (single value) [frac]
Info: 0..1
Required: False. Automatically set to 0.2 if not assigned explicitly or loaded from defaults.
Type: float
-
azimuth
¶ Azimuth angle [deg]
Options: E=90,S=180,W=270
Constraints: MIN=0,MAX=360
Required: True
Type: float
-
backtrack
¶ Enable backtracking [0/1]
Constraints: BOOLEAN
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: float
-
beam
¶ Beam normal irradiance [W/m2]
Required: irrad_mode~2
Type: sequence
-
day
¶ Day [dy]
Info: 1-days in month
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
diff
¶ Diffuse horizontal irradiance [W/m2]
Constraints: LENGTH_EQUAL=beam
Required: irrad_mode~1
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
-
gcr
¶ Ground coverage ratio [0..1]
Constraints: MIN=0,MAX=1
Required: Required if backtrack=1
Type: float
-
glob
¶ Global horizontal irradiance [W/m2]
Constraints: LENGTH_EQUAL=beam
Required: irrad_mode~0
Type: sequence
-
hour
¶ Hour [hr]
Info: 0-23
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
irrad_mode
¶ Irradiance input mode [0/1/2/3/4]
Info: Beam+Diff,Global+Beam, Global+Diff, POA Ref cell, POA Pyranometer
Constraints: INTEGER,MIN=0,MAX=2
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: float
-
lat
¶ Latitude [deg]
Required: True
Type: float
-
lon
¶ Longitude [deg]
Required: True
Type: float
-
minute
¶ Minute [min]
Info: 0-59
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
month
¶ Month [mn]
Info: 1-12
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
pressure
¶ Pressure [mbars]
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
-
rotlim
¶ Rotational limit on tracker [deg]
Constraints: MIN=0,MAX=90
Required: False. Automatically set to 45 if not assigned explicitly or loaded from defaults.
Type: float
-
sky_model
¶ Tilted surface irradiance model [0/1/2]
Info: Isotropic,HDKR,Perez
Constraints: INTEGER,MIN=0,MAX=2
Required: False. Automatically set to 2 if not assigned explicitly or loaded from defaults.
Type: float
-
slope_azm
¶ Terrain azimuth [deg]
Constraints: MIN=0,MAX=1
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: float
-
slope_tilt
¶ Terrain slope [deg]
Constraints: MIN=0,MAX=1
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
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
-
tilt
¶ Tilt angle [deg]
Options: H=0,V=90
Constraints: MIN=0,MAX=90
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
-
track_mode
¶ Tracking mode [0/1/2]
Info: Fixed,1Axis,2Axis
Constraints: MIN=0,MAX=2,INTEGER
Required: True
Type: float
-
tz
¶ Time zone [hr]
Required: True
Type: float
-
year
¶ Year [yr]
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
Outputs Group¶
-
class
PySAM.Irradproc.Irradproc.
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, ...}
-
axis_rotation
¶ Tracking axis rotation angle [deg]
Type: sequence
-
bt_diff
¶ Backtracking difference from ideal rotation [deg]
Type: sequence
-
incidence
¶ Incidence angle to surface [deg]
Type: sequence
-
poa_beam
¶ Incident Beam Irradiance [W/m2]
Type: sequence
-
poa_gnddiff
¶ Incident Ground Reflected Diffuse [W/m2]
Type: sequence
-
poa_skydiff
¶ Incident Sky Diffuse [W/m2]
Type: sequence
-
poa_skydiff_cir
¶ Incident Diffuse Circumsolar Component [W/m2]
Type: sequence
-
poa_skydiff_hor
¶ Incident Diffuse Horizon Brightening Component [W/m2]
Type: sequence
-
poa_skydiff_iso
¶ Incident Diffuse Isotropic Component [W/m2]
Type: sequence
-
sun_azm
¶ Solar azimuth [deg]
Type: sequence
-
sun_dec
¶ Sun declination [deg]
Type: sequence
-
sun_elv
¶ Sun elevation [deg]
Type: sequence
-
sun_zen
¶ Solar zenith [deg]
Type: sequence
-
surf_azm
¶ Surface azimuth angle [deg]
Type: sequence
-
surf_tilt
¶ Surface tilt angle [deg]
Type: sequence
-