API reference¶
datamodel¶
The datamodel.
datamodel |
Data classes and acceptable variables as defined by the SolarForecastArbiter Data Model document. |
There are two kinds of sites:
datamodel.Site (name, latitude, longitude, …) |
Class for keeping track of Site metadata. |
datamodel.SolarPowerPlant (name, latitude, …) |
Class for keeping track of metadata associated with solar power plant Sites. |
The several model parameters are associated with the solar power plant site:
datamodel.PVModelingParameters (ac_capacity, …) |
Class for keeping track of generic PV modeling parameters |
datamodel.FixedTiltModelingParameters (…) |
A class based on PVModelingParameters that has additional parameters for fixed tilt PV systems. |
datamodel.SingleAxisModelingParameters (…) |
A class based on PVModelingParameters that has additional parameters for single axis tracking systems. |
The Observation and Forecast:
datamodel.Observation (name, variable, …) |
A class for keeping track of metadata associated with an observation. |
datamodel.Forecast (name, issue_time_of_day, …) |
A class to hold metadata for Forecast objects. |
pvmodel¶
The pvmodel
module contains functions
closely associated with PV modeling.
pvmodel |
Calculate AC power and modeling intermediates from system metadata, times, and weather data. |
Several utility functions wrap pvlib functions:
pvmodel.calculate_solar_position (latitude, …) |
Calculates solar position using pvlib’s implementation of NREL SPA. |
pvmodel.complete_irradiance_components (ghi, …) |
Uses the Erbs model to calculate DNI and DHI from GHI. |
pvmodel.calculate_clearsky (latitude, …) |
Calculates clear sky irradiance using the Ineichen model and the SoDa climatological turbidity data set. |
Three functions are useful for determining AOI, surface tilt, and
surface azimuth. aoi_func_factory()
is helpful for
standardizing the calculations for tracking and fixed systems.
See calculate_poa_effective()
, for example.
pvmodel.aoi_func_factory (modeling_parameters) |
Create a function to calculate AOI, surface tilt, and surface azimuth from system modeling_parameters. |
pvmodel.aoi_fixed (surface_tilt, …) |
Calculate AOI for fixed system, bundle return with tilt, azimuth for consistency with similar tracker function. |
pvmodel.aoi_tracking (axis_tilt, …) |
Calculate AOI, surface tilt, and surface azimuth for tracking system. |
pvmodel.calculate_poa_effective_explicit (…) |
Calculate effective plane of array irradiance from system metadata, solar position, and irradiance components. |
pvmodel.calculate_poa_effective (aoi_func, …) |
Calculate effective plane of array irradiance from system metadata, solar position, and irradiance components. |
pvmodel.calculate_power (dc_capacity, …[, …]) |
Calcuate AC power from system metadata, plane of array irradiance, and weather data using the PVWatts model. |
pvmodel.irradiance_to_power (…[, temp_air, …]) |
Calcuate AC power from system metadata, solar position, and ghi, dni, dhi. |