From 3ccef46a3dbeebdd61f13917865fa81eed6fbf89 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sun, 29 Sep 2024 16:53:14 +0100 Subject: [PATCH 01/21] initial test --- docs/sphinx/source/user_guide/glossary.rst | 15 +++++++++++++++ docs/sphinx/source/user_guide/index.rst | 1 + pvlib/irradiance.py | 10 ++++++++++ 3 files changed, 26 insertions(+) create mode 100644 docs/sphinx/source/user_guide/glossary.rst diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst new file mode 100644 index 0000000000..688a9d05a2 --- /dev/null +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -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°. diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 416cc0b260..ca49b4fefb 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -16,5 +16,6 @@ User Guide bifacial weather_data variables_style_rules + glossary singlediode faq diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index db62439772..c9e9d2f501 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -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, @@ -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` [Wm⁻²] + dni_extra : numeric Extraterrestrial normal irradiance. [Wm⁻²] From a7ba8eaeb620a17c8a241fe5d86830638ea0dab8 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sun, 29 Sep 2024 17:15:35 +0100 Subject: [PATCH 02/21] Update irradiance.py --- pvlib/irradiance.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index c9e9d2f501..5ab9bdc3d3 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -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`, extraterrestrial irradiance, sun + zenith angle, and sun azimuth angle. Parameters ---------- From 678d7e4655942edb5532cc6e95ae828b545f47f9 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:03:26 +0100 Subject: [PATCH 03/21] update list of terms --- docs/sphinx/source/user_guide/glossary.rst | 169 ++++++++++++++++++++- 1 file changed, 168 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 688a9d05a2..4ce2c41b12 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -5,11 +5,178 @@ 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 + + bhi + Beam/direct horizontal irradiance + + dhi + Diffuse horizontal irradiance + + dni + Direct normal irradiance dni - Direct Normal Irradiance [Wm⁻²]. Amount of radiation received per unit + 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. + + 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°. + + 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 From ef311d0c07597e4b8e4855b704c0dcc9b5940212 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:10:05 +0100 Subject: [PATCH 04/21] update dni description in irradiance.py --- pvlib/irradiance.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 5ab9bdc3d3..2545bfd035 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -757,15 +757,9 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra, dhi : numeric Diffuse horizontal irradiance. [Wm⁻²] - dni : numeric - Direct normal irradiance. [Wm⁻²] - dni : numeric Direct normal irradiance, see :term:`dni`. [Wm⁻²] - dni : numeric - :term:`Direct Normal Irradiance` [Wm⁻²] - dni_extra : numeric Extraterrestrial normal irradiance. [Wm⁻²] From 23600255aa4dd3ee809d0952ea5c737394f50522 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:14:35 +0100 Subject: [PATCH 05/21] minor edits, aoi definition --- docs/sphinx/source/user_guide/glossary.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 4ce2c41b12..19ba7b2484 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -15,10 +15,11 @@ Glossary Relative airmass albedo - Ratio of reflected solar irradiance to global horizontal irradiance, unitless + Ratio of reflected solar irradiance to global horizontal irradiance + [unitless] aoi - Angle of incidence between :math:`90\deg` and :math:`90\deg` + Angle of incidence between ±90° aoi_projection cos(aoi) @@ -37,6 +38,7 @@ Glossary dni Direct normal irradiance + dni Direct normal irradiance [Wm⁻²]. Amount of radiation received per unit area by a surface perpendicular (normal) to the sun's rays that @@ -61,7 +63,7 @@ Glossary Reference inverter efficiency g_poa_effective - Broadband plane of array effective irradiance. + Broadband plane of array effective irradiance gamma_pdc Module temperature coefficient. Typically in units of 1/C. From a68d27e8a0b1d8e03f7bad08ef475c6f28cd84d7 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:29:07 +0100 Subject: [PATCH 06/21] Update glossary.rst --- docs/sphinx/source/user_guide/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 19ba7b2484..4cb5aab31e 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -19,7 +19,7 @@ Glossary [unitless] aoi - Angle of incidence between ±90° + Angle of incidence between :math:`90\deg` and :math:`90\deg` aoi_projection cos(aoi) From 9b6f7b02b79c0c17a4d588c35bedf552d2c9e50c Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:29:29 +0100 Subject: [PATCH 07/21] Update glossary.rst --- docs/sphinx/source/user_guide/glossary.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 4cb5aab31e..41f0d011a9 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -36,9 +36,6 @@ Glossary dhi Diffuse horizontal irradiance - dni - Direct normal irradiance - dni Direct normal irradiance [Wm⁻²]. Amount of radiation received per unit area by a surface perpendicular (normal) to the sun's rays that From 4b90bd4cf7724f28e2448f3282e645c8498dc309 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:31:11 +0100 Subject: [PATCH 08/21] remove in-text dni term glossary link --- pvlib/irradiance.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 2545bfd035..5879537013 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -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, - :term:`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 ---------- From 80175c34dfe53a05c1a2535b76e186df8531a69e Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 19:25:31 +0100 Subject: [PATCH 09/21] delete one surface_tilt definition --- pvlib/irradiance.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 5879537013..939cfcccfb 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -739,11 +739,6 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra, Parameters ---------- - surface_tilt : numeric - Surface tilt angles in decimal degrees. The tilt angle is - 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`. From 34d87c41471e422e2231d0ef1990c3635acde071 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Wed, 9 Oct 2024 19:27:03 +0100 Subject: [PATCH 10/21] review: dni definition Co-Authored-By: Adam R. Jensen <39184289+adamrjensen@users.noreply.github.com> --- docs/sphinx/source/user_guide/glossary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 41f0d011a9..eb4aa8b874 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -37,9 +37,9 @@ Glossary 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. + Direct normal irradiance [Wm⁻²]. Irradiance 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 From ffa60c6fb69e4d0fa9b97532dd9f2ba22517a22e Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:32:36 +0100 Subject: [PATCH 11/21] remove old files, add general text to glossary --- docs/sphinx/source/user_guide/glossary.rst | 15 +++++ .../user_guide/variables_style_rules.rst | 25 --------- pvlib/data/variables_style_rules.csv | 56 ------------------- 3 files changed, 15 insertions(+), 81 deletions(-) delete mode 100644 docs/sphinx/source/user_guide/variables_style_rules.rst delete mode 100644 pvlib/data/variables_style_rules.csv diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index eb4aa8b874..387ec1171c 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -3,6 +3,8 @@ Glossary ======== +There is a convention on consistent variable names throughout the library: + .. glossary:: airmass @@ -179,3 +181,16 @@ Glossary wind_speed Wind speed + + +For a definition and further explanation on the variables, common symbols and +units refer to the following sources: + +* Explanation of Solar irradiation and solar geometry by `SoDa Service `_ + + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + +.. note:: These further references might not use the same terminology as + *pvlib*. But the physical process referred to is the same. diff --git a/docs/sphinx/source/user_guide/variables_style_rules.rst b/docs/sphinx/source/user_guide/variables_style_rules.rst deleted file mode 100644 index 4d3574ab4b..0000000000 --- a/docs/sphinx/source/user_guide/variables_style_rules.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _variables_style_rules: - -Variables and Symbols -===================== - -There is a convention on consistent variable names throughout the library: - -.. csv-table:: List of used Variables and Parameters - :file: ../../../../pvlib/data/variables_style_rules.csv - :delim: ; - :header-rows: 1 - :widths: 5, 5 - :stub-columns: 1 - -For a definition and further explanation on the variables, common symbols and units refer to the following sources: - - -* `IEC 61724-1:2017 -- Photovoltaic system performance - Part 1: Monitoring `_ section: 3 -- Terms and definitions; the Indian Standard referencing the withdrawn earlier global IEC standard IEC 61724:1998 is available online: `IS/IEC 61724 (1998) `_ and can provide relevant contents. -* Explanation of Solar irradiation and solar geometry by `SoDa Service `_ - - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - -.. note:: These further references might not use the same terminology as *pvlib*. But the physical process referred to is the same. diff --git a/pvlib/data/variables_style_rules.csv b/pvlib/data/variables_style_rules.csv deleted file mode 100644 index 1954e036c2..0000000000 --- a/pvlib/data/variables_style_rules.csv +++ /dev/null @@ -1,56 +0,0 @@ -variable;description -tz;timezone -latitude;latitude -longitude;longitude -dni;direct normal irradiance -dni_extra;direct normal irradiance at top of atmosphere (extraterrestrial) -dni_clear;clear sky direct normal irradiance -dhi;diffuse horizontal irradiance -bhi;beam/direct horizontal irradiance -ghi;global horizontal irradiance -ghi_extra;horizontal irradiance at top of atmosphere (extraterrestrial) -gri;ground-reflected irradiance -ape;average photon energy -aoi;angle of incidence between :math:`90\deg` and :math:`90\deg` -aoi_projection;cos(aoi) -airmass;airmass -airmass_relative;relative airmass -airmass_absolute;absolute airmass -poa_ground_diffuse;in plane ground reflected irradiation -poa_direct;direct/beam irradiation in plane -poa_diffuse;total diffuse irradiation in plane. sum of ground and sky diffuse. -poa_global;global irradiation in plane. sum of diffuse and beam projection. -poa_sky_diffuse;diffuse irradiation in plane from scattered light in the atmosphere (without ground reflected irradiation) -g_poa_effective;broadband plane of array effective irradiance. -surface_tilt;tilt angle of the surface -surface_azimuth;azimuth angle of the surface -solar_zenith;zenith angle of the sun in degrees -apparent_zenith;refraction-corrected solar zenith angle in degrees -solar_azimuth;azimuth angle of the sun in degrees East of North -temp_cell;temperature of the cell -temp_module;temperature of the module -temp_air;temperature of the air -temp_dew;dewpoint temperature -relative_humidity;relative humidity -wind_speed;wind speed -wind_direction;wind direction -pressure;atmospheric pressure -albedo;ratio of reflected solar irradiance to global horizontal irradiance, unitless -precipitable_water;total precipitable water contained in a column of unit cross section from earth to top of atmosphere -v_mp, i_mp, p_mp;module voltage, current, power at the maximum power point -v_oc;open circuit module voltage -i_sc;short circuit module current -i_x, i_xx;Sandia Array Performance Model IV curve parameters -effective_irradiance;effective irradiance -photocurrent;photocurrent -saturation_current;diode saturation current -resistance_series;series resistance -resistance_shunt;shunt resistance -transposition_factor; the gain ratio of the radiation on inclined plane to global horizontal irradiation: :math:`\frac{poa\_global}{ghi}` -pdc0; nameplate DC rating -pdc, dc; dc power -gamma_pdc; module temperature coefficient. Typically in units of 1/C. -pac, ac; ac power -eta_inv; inverter efficiency -eta_inv_ref; reference inverter efficiency -eta_inv_nom; nominal inverter efficiency From 5297a08fc231f50613701bc4553e7c59a963f6b0 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:40:25 +0100 Subject: [PATCH 12/21] remove first bullet, add colon, on SoDa line --- docs/sphinx/source/user_guide/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 387ec1171c..008cb9f6d5 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -186,7 +186,7 @@ There is a convention on consistent variable names throughout the library: For a definition and further explanation on the variables, common symbols and units refer to the following sources: -* Explanation of Solar irradiation and solar geometry by `SoDa Service `_ +Explanation of Solar irradiation and solar geometry by `SoDa Service `_: * `Acronyms, Terminology and Units `_ * `Plane orientations and radiation components `_ From 8e578e5f5879386e5af1cacadd978e1e923ed18a Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:44:24 +0100 Subject: [PATCH 13/21] Update glossary.rst --- docs/sphinx/source/user_guide/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 008cb9f6d5..031d09fc7d 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -183,8 +183,8 @@ There is a convention on consistent variable names throughout the library: Wind speed -For a definition and further explanation on the variables, common symbols and -units refer to the following sources: +For further explanation of the variables, common symbols, and +units, refer to the following sources: Explanation of Solar irradiation and solar geometry by `SoDa Service `_: From fc4d2e7e43cc9af5d9ac0ab3b514b662be473424 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Thu, 10 Oct 2024 17:31:00 +0100 Subject: [PATCH 14/21] conciseness (suggestion) --- docs/sphinx/source/user_guide/glossary.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 031d09fc7d..54403fb250 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -184,10 +184,8 @@ There is a convention on consistent variable names throughout the library: For further explanation of the variables, common symbols, and -units, refer to the following sources: +units, refer to the following sources from `SoDa Service `_: -Explanation of Solar irradiation and solar geometry by `SoDa Service `_: - * `Acronyms, Terminology and Units `_ * `Plane orientations and radiation components `_ * `Time references `_ From 816f43db7fec7594860c6ffa26252ae162972dd7 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 11:50:37 +0100 Subject: [PATCH 15/21] updated aoi definition #2247 --- docs/sphinx/source/user_guide/glossary.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 54403fb250..3cb0ef14ee 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -21,7 +21,8 @@ There is a convention on consistent variable names throughout the library: [unitless] aoi - Angle of incidence between :math:`90\deg` and :math:`90\deg` + Angle of incidence. Angle between the surface normal vector and the + vector pointing towards the sun’s center aoi_projection cos(aoi) From 7d6a0ac3dfbcb48b0d0d32bce69432332f5a544c Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 12:00:18 +0100 Subject: [PATCH 16/21] update references old variables style rules page --- docs/sphinx/source/contributing/style_guide.rst | 2 +- docs/sphinx/source/index.rst | 2 +- docs/sphinx/source/user_guide/index.rst | 1 - docs/sphinx/source/user_guide/weather_data.rst | 2 +- pvlib/iotools/midc.py | 2 +- 5 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/source/contributing/style_guide.rst b/docs/sphinx/source/contributing/style_guide.rst index 58faa59a98..a8b92af6ea 100644 --- a/docs/sphinx/source/contributing/style_guide.rst +++ b/docs/sphinx/source/contributing/style_guide.rst @@ -13,7 +13,7 @@ pvlib python generally follows the `PEP 8 -- Style Guide for Python Code is 79 characters. pvlib python uses a mix of full and abbreviated variable names. See -:ref:`variables_style_rules`. We could be better about consistency. +:ref:`glossary`. We could be better about consistency. Prefer full names for new contributions. This is especially important for the API. Abbreviations can be used within a function to improve the readability of formulae. diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index ce62c56e28..1ace32acf0 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -26,7 +26,7 @@ pvlib python that-use-pvlib-python>`_ page for inspiration and listing of your application. -There is a :ref:`variable naming convention ` to +There is a :ref:`variable naming convention ` to ensure consistency throughout the library. diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index ca49b4fefb..01b73e3bf3 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -15,7 +15,6 @@ User Guide clearsky bifacial weather_data - variables_style_rules glossary singlediode faq diff --git a/docs/sphinx/source/user_guide/weather_data.rst b/docs/sphinx/source/user_guide/weather_data.rst index 06e54d2296..9e5c144033 100644 --- a/docs/sphinx/source/user_guide/weather_data.rst +++ b/docs/sphinx/source/user_guide/weather_data.rst @@ -83,7 +83,7 @@ a :py:class:`pandas.DataFrame` of the actual dataset, plus a metadata dictionary. Most :py:mod:`pvlib.iotools` functions also have a ``map_variables`` parameter to automatically translate the column names used in the data file (which vary widely from dataset to dataset) -into standard pvlib names (see :ref:`variables_style_rules`). +into standard pvlib names (see :ref:`glossary`). Typical usage looks something like this: diff --git a/pvlib/iotools/midc.py b/pvlib/iotools/midc.py index 99b6f20680..b0aa45499f 100644 --- a/pvlib/iotools/midc.py +++ b/pvlib/iotools/midc.py @@ -193,7 +193,7 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs): See the MIDC_VARIABLE_MAP for collection of mappings by site. For a full list of pvlib variable names see the - :ref:`variables_style_rules`. + :ref:`glossary`. Be sure to check the units for the variables you will use on the `MIDC site `_. From 732939357e767562d6eff827639ca701c3fc257d Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 18:22:57 +0100 Subject: [PATCH 17/21] remove old page link from v0.3.0 whatsnew --- docs/sphinx/source/whatsnew/v0.3.0.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.3.0.txt b/docs/sphinx/source/whatsnew/v0.3.0.txt index 62cc9839f7..36db1b3b90 100644 --- a/docs/sphinx/source/whatsnew/v0.3.0.txt +++ b/docs/sphinx/source/whatsnew/v0.3.0.txt @@ -47,7 +47,7 @@ Enhancements * :ref:`installation` (:issue:`135`) * :ref:`contributing` (:issue:`46`) * :ref:`timetimezones` (:issue:`47`) - * :ref:`variables_style_rules` (:issue:`102`) + * Variables and Symbols (:issue:`102`) * Classes (:issue:`93`) (Moved to :ref:`api` in :issue:`258`) * Adds support for Appveyor, a Windows continuous integration service. From 70957f068962e71e394674ba124c068f405680ec Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 18:24:09 +0100 Subject: [PATCH 18/21] Update index.rst Co-Authored-By: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --- docs/sphinx/source/user_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 01b73e3bf3..36c67bcb69 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -15,6 +15,6 @@ User Guide clearsky bifacial weather_data - glossary singlediode + glossary faq From 65de1729ee05d99c771e430efaf8aafef03c05f0 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 18:51:30 +0100 Subject: [PATCH 19/21] Update v0.11.2.rst --- docs/sphinx/source/whatsnew/v0.11.2.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/whatsnew/v0.11.2.rst b/docs/sphinx/source/whatsnew/v0.11.2.rst index 81d36fda64..41f84026fd 100644 --- a/docs/sphinx/source/whatsnew/v0.11.2.rst +++ b/docs/sphinx/source/whatsnew/v0.11.2.rst @@ -18,6 +18,8 @@ Documentation :py:func:`~pvlib.pvsystem.dc_ohmic_losses` for clarity. (:issue:`1601`, :pull:`2229`) * Updated :py:func:`~pvlib.irradiance.reindl` to include definitions of terms and a new "notes" section (:issue:`2183`, :pull:`2193`) +* Added a new :ref:`Glossary` page in place of the Variables and Symbols + page. (:issue:`1421`, :pull:`2234`) Testing ~~~~~~~ From 21d6115f15a5337ae456065ab08eced3510f2b15 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 19 Oct 2024 21:12:09 +0100 Subject: [PATCH 20/21] Update docs/sphinx/source/user_guide/glossary.rst Co-authored-by: Kevin Anderson --- docs/sphinx/source/user_guide/glossary.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst index 3cb0ef14ee..6c5d9b8f61 100644 --- a/docs/sphinx/source/user_guide/glossary.rst +++ b/docs/sphinx/source/user_guide/glossary.rst @@ -145,9 +145,6 @@ There is a convention on consistent variable names throughout the library: 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°. From ff9383ae7af48b8a521acbd68875dfb27e4840bd Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Mon, 21 Oct 2024 22:45:32 +0100 Subject: [PATCH 21/21] Update docs/sphinx/source/contributing/style_guide.rst Co-authored-by: Cliff Hansen --- docs/sphinx/source/contributing/style_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/contributing/style_guide.rst b/docs/sphinx/source/contributing/style_guide.rst index a8b92af6ea..02d93a8494 100644 --- a/docs/sphinx/source/contributing/style_guide.rst +++ b/docs/sphinx/source/contributing/style_guide.rst @@ -13,7 +13,7 @@ pvlib python generally follows the `PEP 8 -- Style Guide for Python Code is 79 characters. pvlib python uses a mix of full and abbreviated variable names. See -:ref:`glossary`. We could be better about consistency. +:ref:`glossary`. Prefer full names for new contributions. This is especially important for the API. Abbreviations can be used within a function to improve the readability of formulae.