Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Variables and Symbols page into a Glossary of terms #2234

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
181 changes: 181 additions & 0 deletions docs/sphinx/source/user_guide/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
.. glossary:

Glossary
========

.. glossary::

airmass
Airmass

airmass_absolute
Absolute airmass

airmass_relative
Relative airmass

albedo
Ratio of reflected solar irradiance to global horizontal irradiance
[unitless]

aoi
Angle of incidence between :math:`90\deg` and :math:`90\deg`

aoi_projection
cos(aoi)

ape
Average photon energy

apparent_zenith
Refraction-corrected solar zenith angle in degrees
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here the unit is mentioned in text. Should it be [°] instead?


bhi
Beam/direct horizontal irradiance

dhi
Diffuse horizontal irradiance

dni
Direct normal irradiance [Wm⁻²]. Amount of radiation received per unit
area by a surface perpendicular (normal) to the sun's rays that
propagate in a straight line from the sun.

dni_clear
Clear sky direct normal irradiance

dni_extra
Direct normal irradiance at top of atmosphere (extraterrestrial)

effective_irradiance
Effective irradiance

eta_inv
Inverter efficiency

eta_inv_nom
Nominal inverter efficiency

eta_inv_ref
Reference inverter efficiency

g_poa_effective
Broadband plane of array effective irradiance

gamma_pdc
Module temperature coefficient. Typically in units of 1/C.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again maybe try to be consistent on whether we report the units and how


ghi
Global horizontal irradiance

ghi_extra
Horizontal irradiance at top of atmosphere (extraterrestrial)

gri
Ground-reflected irradiance

i_sc
Short circuit module current

i_x, i_xx
Sandia Array Performance Model IV curve parameters

latitude
Latitude

longitude
Longitude

pac, ac
AC power

pdc, dc
DC power

pdc0
Nameplate DC rating

photocurrent
Photocurrent

poa_diffuse
Total diffuse irradiation in plane. Sum of ground and sky diffuse.

poa_direct
Direct/beam irradiation in plane

poa_global
Global irradiation in plane. sum of diffuse and beam projection.

poa_ground_diffuse
In plane ground reflected irradiation

poa_sky_diffuse
Diffuse irradiation in plane from scattered light in the atmosphere
(without ground reflected irradiation)

precipitable_water
Total precipitable water contained in a column of unit cross section
from earth to top of atmosphere

pressure
Atmospheric pressure

relative_humidity
Relative humidity

resistance_series
Series resistance

resistance_shunt
Shunt resistance

saturation_current
Diode saturation current

solar_azimuth
Azimuth angle of the sun in degrees East of North

solar_zenith
Zenith angle of the sun in degrees

surface_azimuth
Azimuth angle of the surface

surface_tilt
Tilt angle of the surface

surface_tilt
Panel tilt from horizontal [°]. For example, a surface facing up = 0°,
surface facing horizon = 90°.
RDaxini marked this conversation as resolved.
Show resolved Hide resolved

temp_air
Temperature of the air

temp_cell
Temperature of the cell

temp_dew
Dewpoint temperature

temp_module
Temperature of the module

transposition_factor
The gain ratio of the radiation on inclined plane to global horizontal
irradiation: :math:`\frac{poa\_global}{ghi}`

tz
Timezone

v_mp, i_mp, p_mp
Module voltage, current, power at the maximum power point

v_oc
Open circuit module voltage

wind_direction
Wind direction

wind_speed
Wind speed
1 change: 1 addition & 0 deletions docs/sphinx/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ User Guide
bifacial
weather_data
variables_style_rules
glossary
RDaxini marked this conversation as resolved.
Show resolved Hide resolved
singlediode
faq
11 changes: 7 additions & 4 deletions pvlib/irradiance.py
Original file line number Diff line number Diff line change
Expand Up @@ -734,9 +734,8 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
The Hay and Davies model determines the diffuse irradiance from
the sky (ground reflected irradiance is not included in this
algorithm) on a tilted surface using the surface tilt angle, surface
azimuth angle, diffuse horizontal irradiance, direct normal
irradiance, extraterrestrial irradiance, sun zenith angle, and sun
azimuth angle.
azimuth angle, diffuse horizontal irradiance, direct normal irradiance,
extraterrestrial irradiance, sun zenith angle, and sun azimuth angle.

Parameters
----------
Expand All @@ -745,6 +744,10 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
defined as degrees from horizontal (e.g. surface facing up = 0,
surface facing horizon = 90)

surface_tilt : numeric
Panel tilt from the horizontal, in decimal degrees, see
:term:`surface_tilt`.
RDaxini marked this conversation as resolved.
Show resolved Hide resolved

surface_azimuth : numeric
Surface azimuth angles in decimal degrees. The azimuth
convention is defined as degrees east of north (e.g. North=0,
Expand All @@ -754,7 +757,7 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
Diffuse horizontal irradiance. [Wm⁻²]

dni : numeric
Direct normal irradiance. [Wm⁻²]
Direct normal irradiance, see :term:`dni`. [Wm⁻²]

dni_extra : numeric
Extraterrestrial normal irradiance. [Wm⁻²]
Expand Down