Reference
Each page documents one request field, one loss row, one model step or one method. The workbench opens the same pages from its information icons. The API serves them as JSON at /v1/docs/{key} and as markdown at /v1/docs/{key}.md.
Guides
- East-west racking
- Generic modules and inverters
- Scene JSON for agents
- Simple run for agents
- Symbol registry
- Select a path
Model steps and methods
Irradiance
- Weather inputsWeather file
- Solar positionPVsyst 8 ephemeris · NREL SPA · Michalsky 1988 · NREL SPA (SSC application)
- Sun timingSunlit-slice midpoint · Interval midpoint
- Dark intervalsZero · Isotropic diffuse
- TranspositionPerez 1990 · Hay–Davies · Isotropic
- Perez settingsPVsyst 8 settings · Published settings · NREL SSC settings
- Circumsolar treatmentLike beam · As diffuse
- Low-light thresholdThreshold on the plane global · No threshold
- Far shading (horizon)Crossing fraction + diffuse integrals · Hourly beam gate · Do not model
- Near shading (row to row)Infinite rows, PVsyst application · Appelbaum geometric closed form · Shading-factor table, PVsyst application · Deline linear self-shading · Deline non-linear self-shading · Direct projection · Do not model
- Row countRows of the racking section · Square field from the DC nameplate
- Sky-diffuse maskingIsotropic integral of the row shading factor · View factor · Passias masking angle
- Backtracking widthActive band width · GCR · Custom
- Backtracking anglePlanar backtracking, PVsyst application · Terrain-aware backtracking
- Irradiance-optimised trackingOff · Flat on diffuse steps · Best plane angle, PVsyst application
- Best plane angle searchFull climb · PVsyst 8 settings
- Incidence-angle modifier, beamFresnel, AR coating · Module IAM profile · Fresnel, direct · ASHRAE b₀ · De Soto cover · Tabulated
- Incidence-angle modifier, diffuse and albedoMask-conditioned integrals · 19-bin histogram · Effective angle
- Ground IAM angleHorizontal direction · True incidence angle
- SoilingMonthly table · Do not model
- Rear side and front ground reflectionUnlimited sheds or trackers 2D (PVsyst) · bifacialvf (Marion 2017) · bifacialvf 1° sectors (Marion 2017) · Infinite sheds (Mikofski 2019) · Monofacial
- Rear-side geometryRacking and bifacial sections · PVWatts 8 fixed layout
- Cell temperaturePrilliman transient · Faiman · NOCT (Duffie and Beckman) · NOCT, module's rated NOCT · SAPM (King 2004) · Fuentes
- Module modelMermoud one-diode · CEC six-parameter, representative module · CEC six-parameter, this module · PVWatts DC model (Dobos 2014)
- One-diode STC pointThrough the datasheet MPP · Maximum at the nominal power
- Spectral correctionLee and Panchula · Air-mass modifier (King 2004) · Off
- Where the correction actsAfter the cell temperature · Before the cell temperature
- Townsend snowTownsend monthly · Do not model
- Electrical shading effectAccording to strings · String partitions, PVsyst application · Sub-module I-V curves, PVsyst application · Linear
- DC flat deratesSequential flat derates
- Rear mismatchFlat fraction · Deline 2020, from the rear cell rows · No rear mismatch
- DC ohmic wiringI²R on the MPP current · Load ratio · Flat fraction
- MPPT inputsOne input per string · Strings share the inverter
- Inverter efficiencyLinear in power and voltage · Parabolic voltage blend · Sandia, no voltage terms · Sandia, with voltage terms · Flat efficiency · PVWatts inverter (Dobos 2014)
- Inverter operating limitsOperating point on the array's I–V curve · Cap the power, no I–V curve · Clip at the AC nameplate · MPPT window on the module curve, AC clip
- DC drop referenceDrop at the MPP current · Drop at the operating current
- MPPT minimumHold the MPPT minimum, fitted voltage trim · Hold the MPPT minimum, curve current
- MPPT minimum loss rowPower-limit loss when it would have clipped · Count as an MPPT minimum loss
- IV shading current scaleScale the curve by the electrical shading · Leave the curve unscaled
- Night consumptionOn · Off
- AC ohmic wiringk·P² on the inverter output · Flat fraction
- AC resistive referenceInverter output · Cascade
- AC power referenceP_nom inverter · STC reference power
- Medium-voltage transformerIron and copper losses · Do not model
- System-level AC lossesOn the sum of the inverters
- MV lineResistive loss · Do not model
- HV transformerIron and copper losses · Do not model
- HV lineResistive loss · Do not model
- Transmission and other lossesFlat fractions · Do not model
- AuxiliariesDay and night draw · Do not model
- Grid power limitationAt the injection point · At the inverter output · Do not model
- UnavailabilityFlat fraction and periods · Do not model
- Power factorInside the inverter and AC rows · Own row
Energy
- Weather inputsWeather file
- Solar positionPVsyst 8 ephemeris · NREL SPA · Michalsky 1988 · NREL SPA (SSC application)
- Sun timingSunlit-slice midpoint · Interval midpoint
- Dark intervalsZero · Isotropic diffuse
- TranspositionPerez 1990 · Hay–Davies · Isotropic
- Perez settingsPVsyst 8 settings · Published settings · NREL SSC settings
- Circumsolar treatmentLike beam · As diffuse
- Low-light thresholdThreshold on the plane global · No threshold
- Far shading (horizon)Crossing fraction + diffuse integrals · Hourly beam gate · Do not model
- Near shading (row to row)Infinite rows, PVsyst application · Appelbaum geometric closed form · Shading-factor table, PVsyst application · Deline linear self-shading · Deline non-linear self-shading · Direct projection · Do not model
- Row countRows of the racking section · Square field from the DC nameplate
- Sky-diffuse maskingIsotropic integral of the row shading factor · View factor · Passias masking angle
- Backtracking widthActive band width · GCR · Custom
- Backtracking anglePlanar backtracking, PVsyst application · Terrain-aware backtracking
- Irradiance-optimised trackingOff · Flat on diffuse steps · Best plane angle, PVsyst application
- Best plane angle searchFull climb · PVsyst 8 settings
- Incidence-angle modifier, beamFresnel, AR coating · Module IAM profile · Fresnel, direct · ASHRAE b₀ · De Soto cover · Tabulated
- Incidence-angle modifier, diffuse and albedoMask-conditioned integrals · 19-bin histogram · Effective angle
- Ground IAM angleHorizontal direction · True incidence angle
- SoilingMonthly table · Do not model
- Rear side and front ground reflectionUnlimited sheds or trackers 2D (PVsyst) · bifacialvf (Marion 2017) · bifacialvf 1° sectors (Marion 2017) · Infinite sheds (Mikofski 2019) · Monofacial
- Rear-side geometryRacking and bifacial sections · PVWatts 8 fixed layout
- Cell temperaturePrilliman transient · Faiman · NOCT (Duffie and Beckman) · NOCT, module's rated NOCT · SAPM (King 2004) · Fuentes
- Module modelMermoud one-diode · CEC six-parameter, representative module · CEC six-parameter, this module · PVWatts DC model (Dobos 2014)
- One-diode STC pointThrough the datasheet MPP · Maximum at the nominal power
- Spectral correctionLee and Panchula · Air-mass modifier (King 2004) · Off
- Where the correction actsAfter the cell temperature · Before the cell temperature
- Townsend snowTownsend monthly · Do not model
- Electrical shading effectAccording to strings · String partitions, PVsyst application · Sub-module I-V curves, PVsyst application · Linear
- DC flat deratesSequential flat derates
- Rear mismatchFlat fraction · Deline 2020, from the rear cell rows · No rear mismatch
- DC ohmic wiringI²R on the MPP current · Load ratio · Flat fraction
- MPPT inputsOne input per string · Strings share the inverter
- Inverter efficiencyLinear in power and voltage · Parabolic voltage blend · Sandia, no voltage terms · Sandia, with voltage terms · Flat efficiency · PVWatts inverter (Dobos 2014)
- Inverter operating limitsOperating point on the array's I–V curve · Cap the power, no I–V curve · Clip at the AC nameplate · MPPT window on the module curve, AC clip
- DC drop referenceDrop at the MPP current · Drop at the operating current
- MPPT minimumHold the MPPT minimum, fitted voltage trim · Hold the MPPT minimum, curve current
- MPPT minimum loss rowPower-limit loss when it would have clipped · Count as an MPPT minimum loss
- IV shading current scaleScale the curve by the electrical shading · Leave the curve unscaled
- Night consumptionOn · Off
- AC ohmic wiringk·P² on the inverter output · Flat fraction
- AC resistive referenceInverter output · Cascade
- AC power referenceP_nom inverter · STC reference power
- Medium-voltage transformerIron and copper losses · Do not model
- System-level AC lossesOn the sum of the inverters
- MV lineResistive loss · Do not model
- HV transformerIron and copper losses · Do not model
- HV lineResistive loss · Do not model
- Transmission and other lossesFlat fractions · Do not model
- AuxiliariesDay and night draw · Do not model
- Grid power limitationAt the injection point · At the inverter output · Do not model
- UnavailabilityFlat fraction and periods · Do not model
- Power factorInside the inverter and AC rows · Own row
Loss rows
- AC ohmic loss
- AC other loss
- Active Energy injected into grid
- Array nominal energy (at STC effic.)
- Array virtual energy at MPP
- Auxiliaries (fans, other)
- Available Energy at Inverter Output
- Change at the POI from storage
- Effective irradiation on collectors
- Energy at POI after storage
- Energy curtailed at the POI limit
- Energy delivered from storage
- Energy diverted to storage
- Far Shadings: Horizon
- Fixed transmission loss
- Global horizontal irradiation
- Global incident below threshold
- Global incident in coll. plane
- Global incident rear side
- Ground reflection on front side
- HV line ohmic loss
- HV transformer loss
- IAM factor on global
- Inverter Loss due to max. input current
- Inverter Loss due to power threshold
- Inverter Loss due to voltage threshold
- Inverter Loss during operation (efficiency)
- Inverter Loss over nominal inv. power
- Inverter Loss over nominal inv. voltage
- LID - Light induced degradation
- Light soaking (CIS/CIGS)
- Medium voltage transfo loss
- Mismatch loss for back irradiance
- Mismatch loss, modules and strings
- Module quality loss
- MV line ohmic loss
- Near Shadings: irradiance loss
- Night consumption
- Ohmic wiring loss
- Power factor (reactive power)
- PV loss due to irradiance level
- PV loss due to temperature
- Shadings: Electrical Loss , sheds
- Soiling loss factor
- Solar energy at the POI (before storage)
- Spectral correction
- Townsend snow loss
- Unavailability of the system
- Unused energy (grid limitation)
Request fields
Site
- Albedo
site.albedo_monthly - Design low temperature
site.design_t_min_c - Altitude
site.elevation - Horizon profile
site.horizon - Fraction of albedo taken into account
site.horizon_albedo_fraction - Latitude
site.latitude - Longitude
site.longitude - Dark intervals
site.night_irradiance - Monthly relative humidity
site.relative_humidity_monthly - Angle of repose (snow)
site.snow_angle_of_repose_deg - Monthly snow events
site.snow_events_monthly - Lower-edge height (snow)
site.snow_lower_edge_height_m - Snow model
site.snow_model - String factor (snow)
site.snow_string_factor - Monthly snowfall
site.snowfall_monthly_cm - Soiling loss factor
site.soiling_monthly - Solar position method
site.sun_model - Sun timing
site.sun_timing - Time zone
site.timezone - Apply horizon shading
site.use_horizon - Apply soiling
site.use_soiling
Weather
- Diffuse horizontal irradiance
weather.diff_hor - Direct normal irradiance
weather.dni - Global horizontal irradiance
weather.glob_hor - Precipitable water
weather.precipitable_water - Station pressure
weather.pressure - Relative humidity
weather.relative_humidity - Start
weather.start - Step
weather.step_hours - Ambient temperature
weather.t_amb - Timestamps
weather.timestamps - Wind speed
weather.wind_vel
Array
- Azimuth
array.azimuth_deg - Backtracking
array.backtracking - Backtracking angle
array.backtracking_angle - Custom backtracking width
array.backtracking_width_m - Backtracking width
array.backtracking_width_method - Bottom inactive band
array.band_bottom_m - Top inactive band
array.band_top_m - Cell height along the slope
array.cell_traverse_m - Circumsolar treatment
array.circumsolar - Collector band width
array.collector_width_m - Fraction for electrical effect
array.fraction_for_electrical - GCR (ground cover ratio)
array.gcr - Model row-to-row shading
array.inter_row_shading - Tracking mode: irradiance optimization
array.irradiance_tracking - Irradiance-optimised tracking: gain threshold
array.irradiance_tracking_gain - Irradiance-optimised tracking: method
array.irradiance_tracking_method - Irradiance-optimised tracking: GHI threshold
array.irradiance_tracking_min_ghi_wm2 - Best plane angle search
array.irradiance_tracking_search - Modules per string
array.modules_per_string - Number of inverters
array.n_inverters - Number of rows
array.n_rows - Perez settings
array.perez_settings - Rotation limit (symmetric)
array.rotation_limit_deg - Rotation maximum
array.rotation_max_deg - Rotation minimum
array.rotation_min_deg - Row count
array.row_count - Electrical shading effect
array.shade_mode - Row-to-row shading geometry
array.shading_model - Sky masking method
array.sky_masking_method - String layout
array.string_layout - Strings on one rack
array.string_steps - Strings per inverter
array.strings_per_inverter - Plane tilt
array.tilt_deg - Racking type
array.track_mode - Transposition model
array.transposition_model - Wind stow
array.wind_stow - Wind stow: stow position
array.wind_stow_angle_deg - Wind stow: wind speed threshold
array.wind_stow_speed_ms
Module
- Isc temperature coefficient
module.alpha_isc - Voc temperature coefficient (specified)
module.beta_voc - Bifaciality factor
module.bifaciality_factor - CEC database parameters
module.cec - Recombination loss term (d²/μτ)
module.d2_mu_tau - Bandgap
module.e_g_ev - Module efficiency
module.efficiency - Reference irradiance
module.g_ref_wm2 - Length (height)
module.height_m - MPP current
module.i_mp_ref_a - Short-circuit current
module.i_sc_ref_a - IAM table rule
module.iam_mode - Module IAM profile
module.iam_profile - Module model
module.model - Ideality factor temperature coefficient
module.mu_n - Pmax temperature coefficient
module.mu_p_mp - Diode ideality factor
module.n_0 - Cell strings in parallel
module.n_parallel - Cells in series
module.n_series - Nameplate power
module.p_nom_w - Series resistance
module.r_s_ohm - Shunt resistance at zero irradiance
module.r_sh_0_ohm - Shunt resistance exponent
module.r_sh_exp - Shunt resistance at reference irradiance
module.r_sh_ref_ohm - Reference temperature
module.t_ref_c - Technology
module.technology - Twin half-cell layout
module.twin_half_cells - MPP voltage
module.v_mp_ref_v - Open-circuit voltage
module.v_oc_ref_v - Module mass
module.weight_kg - Width
module.width_m
Inverter
- DC drop reference
inverter.dc_drop_reference - Efficiency interpolation
inverter.efficiency_interpolation - Maximum DC input current
inverter.i_dc_max_a - IV shading current scale
inverter.iv_shading_current_scale - Max. efficiency
inverter.max_efficiency - MPPT minimum
inverter.mppt_floor_behavior - MPPT inputs
inverter.n_mppt - Operating point
inverter.operating_point - Night loss
inverter.p_night_w - AC nameplate power
inverter.p_nom_ac_w - DC reference power of the efficiency curve
inverter.p_nom_dc_w - Power threshold
inverter.p_threshold_w - Part-load efficiency curve
inverter.partload_curve - Sandia model parameters
inverter.sandia - Ambient nameplate schedule
inverter.temp_derate - Maximum DC voltage
inverter.v_dc_max_v - MPPT window maximum
inverter.v_mppt_max_v - MPPT window minimum
inverter.v_mppt_min_v - MPPT minimum loss row
inverter.vmin_loss_bucket - Per-voltage efficiency curves
inverter.voltage_curves
Incidence-angle modifier
- AR-coated glass
iam.ar_coating - ASHRAE b₀
iam.b0 - Diffuse IAM integration
iam.diffuse_integration - Ground IAM angle
iam.ground_iam_angle - IAM method
iam.kind - Tabulated IAM profile
iam.profile
Thermal
- Absorptivity
thermal.absorptivity - Thermal model
thermal.model - Module unit mass
thermal.module_mass_kg_m2 - NOCT standoff adjustment
thermal.noct_standoff_adjust_c - SAPM coefficient a
thermal.sapm_a - SAPM coefficient b
thermal.sapm_b - SAPM ΔT
thermal.sapm_delta_t - Thermal inertia
thermal.transient - Thermal loss factor Uc (constant)
thermal.u_c - Thermal loss factor Uv (wind)
thermal.u_v
Spectral correction
- Spectral air mass
spectral.airmass_method - Air-mass cap
spectral.am_max - Spectral application
spectral.application - Spectral coefficients
spectral.coefficients - Spectral mode
spectral.mode - Spectral model
spectral.model
Bifacial
- Ground albedo (bifacial system)
bifacial.albedo - Rear-side geometry
bifacial.geometry - Height above ground
bifacial.ground_clearance_m - Bifacial model
bifacial.model - Mismatch loss factor (rear side)
bifacial.rear_mismatch_loss - Rear mismatch model
bifacial.rear_mismatch_model - Structure shading factor
bifacial.structure_shade_factor - Transparent fraction of the module plane
bifacial.transmission_factor
DC losses
- Loss fraction at STC (DC circuit)
dc_losses.dc_wiring_loss_at_stc - Global wiring resistance
dc_losses.dc_wiring_r_ohm - LID loss factor
dc_losses.lid_loss - Light soaking gain (CIS/CIGS)
dc_losses.light_soaking_gain - Module mismatch: power loss at MPP
dc_losses.module_mismatch_loss - DC wiring model
dc_losses.ohmic_model - Module efficiency loss
dc_losses.quality_loss - Series diode voltage drop
dc_losses.series_diode_voltage_v - String voltage mismatch
dc_losses.string_mismatch_loss
AC losses
- AC circuit: loss fraction at STC
ac_losses.ac_wiring_loss_at_stc - Auxiliaries: continuous (fans, etc.)
ac_losses.aux_kw - Auxiliaries: night consumption
ac_losses.aux_night_kw - Auxiliaries: proportional to power
ac_losses.aux_proportional_w_per_kw - Auxiliaries: from power threshold
ac_losses.aux_threshold_kw - Grid limitation in kVA
ac_losses.grid_limit_apparent - Grid limitation at
ac_losses.grid_limit_at - Grid limitation: account as separate loss
ac_losses.grid_limit_separate_loss - Grid power limitation
ac_losses.grid_poi_limit_kw - HV line: loss fraction at STC
ac_losses.hv_line_loss_at_stc - HV transformer: no-load (iron) loss
ac_losses.hv_transformer_constant_loss - HV transformer: load (copper) loss at STC
ac_losses.hv_transformer_loss_at_stc - Inverter night consumption
ac_losses.inverter_night_tare - MV line: loss fraction at STC
ac_losses.mv_line_loss_at_stc - AC wiring model
ac_losses.ohmic_model - Other AC loss
ac_losses.other_loss - Nameplate is apparent
ac_losses.pnom_apparent - Power factor
ac_losses.power_factor - AC power reference
ac_losses.power_reference - AC resistive reference
ac_losses.resistive_reference - STC reference power (explicit)
ac_losses.stc_ref_power_w - MV transformer: no-load (iron) loss
ac_losses.transformer_constant_loss - MV transformer: load (copper) loss at STC
ac_losses.transformer_loss_at_stc - Night disconnect
ac_losses.transformer_night_disconnect - Fixed transmission loss
ac_losses.transmission_loss - Unavailability: flat energy fraction
ac_losses.unavailability_loss - Unavailability periods
ac_losses.unavailability_periods - Model the auxiliaries
ac_losses.use_auxiliaries - Model the grid power limitation
ac_losses.use_grid_limit - Model the HV line
ac_losses.use_hv_line - Model the HV transformer
ac_losses.use_hv_transformer - Model the MV line
ac_losses.use_mv_line - Model the MV transformer
ac_losses.use_mv_transformer - Model the transmission and other losses
ac_losses.use_transmission - Model the unavailability
ac_losses.use_unavailability
Scene
- Scene frame
scene.frame - Shading objects
scene.objects - Cylinder object
scene.objects.cylinder - Prism object
scene.objects.prism - Tree line object
scene.objects.tree_line - Wall object
scene.objects.wall - Scene origin
scene.origin - Outlines
scene.outlines - Placements
scene.placements - Placement azimuth
scene.placements.azimuth_deg - Placement roll
scene.placements.roll_deg - Placement string
scene.placements.string - Placement tilt
scene.placements.tilt_deg - Placement centre x, y
scene.placements.x - Placement centre z
scene.placements.z - Device types
scene.types - Device border
scene.types.border - Ridge gap
scene.types.gap - Device kind
scene.types.kind - Device length
scene.types.length - Device modules
scene.types.modules - Device string layout
scene.types.string_layout - Device strings
scene.types.strings - Device width
scene.types.width - Scene record version
scene.version
Battery storage
- AC conversion efficiency
storage.ac_conversion_efficiency - Capacity
storage.capacity_kwh - Clip lookahead
storage.clip_lookahead_hours - Coupling
storage.coupling - Dispatch
storage.dispatch - Discharge schedule
storage.dispatch_schedule - Interconnect target
storage.interconnect_limit_kw - Power
storage.power_kw - Round-trip efficiency
storage.round_trip_efficiency - State-of-charge window
storage.soc
Options
- Far shading method
options.far_shading_model - Threshold on the plane global
options.glob_inc_threshold_wm2 - DC drop reference (override)
options.inverter_dc_drop_reference - Efficiency interpolation (override)
options.inverter_efficiency_interpolation - IV shading current scale (override)
options.inverter_iv_shading_current_scale - MPPT minimum (override)
options.inverter_mppt_floor_behavior - MPPT inputs
options.inverter_mppt_inputs - Operating point (override)
options.inverter_operating_point - MPPT minimum loss row (override)
options.inverter_vmin_loss_bucket - Module model (override)
options.module_model - One-diode STC point
options.module_stc_point - Power factor row
options.power_factor_row - Apply the low-light threshold
options.use_glob_inc_threshold
Run options
- Engine version
engine_version - Include PVsyst-named series
include_pvsyst_series - Include series
include_series