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.

Sign up for GitHub

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

Jump to bottom

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ccef46
initial test
RDaxini Sep 29, 2024
a7ba8ea
Update irradiance.py
RDaxini Sep 29, 2024
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
15 changes: 15 additions & 0 deletions docs/sphinx/source/user_guide/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. glossary:

Glossary
========

.. glossary::

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.

surface_tilt
Panel tilt from horizontal [°]. For example, a surface facing up = 0°,
surface facing horizon = 90°.
1 change: 1 addition & 0 deletions docs/sphinx/source/user_guide/index.rst
View file
Open in desktop
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
singlediode
faq
16 changes: 13 additions & 3 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,9 +734,9 @@ 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,
:term:`Direct Normal Irradiance<dni>`, extraterrestrial irradiance, sun
zenith angle, and sun azimuth angle.

Parameters
----------
Expand All @@ -745,6 +745,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`.

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 @@ -756,6 +760,12 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
dni : numeric
Direct normal irradiance. [Wm⁻²]

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

dni : numeric
:term:`Direct Normal Irradiance<dni>` [Wm⁻²]

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

Expand Down
Loading