From eae7536c6beb2ae6606208c20e2f156e80e393ac Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 21 Jan 2026 09:53:08 -0700 Subject: [PATCH 1/5] add aod, clearsky index --- .../source/user_guide/extras/nomenclature.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/extras/nomenclature.rst b/docs/sphinx/source/user_guide/extras/nomenclature.rst index 444b1ae5cc..e02a196e82 100644 --- a/docs/sphinx/source/user_guide/extras/nomenclature.rst +++ b/docs/sphinx/source/user_guide/extras/nomenclature.rst @@ -19,7 +19,12 @@ There is a convention on consistent variable names throughout the library: albedo Ratio of reflected solar irradiance to global horizontal irradiance [unitless] - + + aod + aerosol optical depth. Measure of aerosols (e.g., smoke + particles, desert dust) distributed within a column of air from the + instrument (Earth's surface) to the top of the atmosphere. [unitless] + aoi Angle of incidence. Angle between the surface normal vector and the vector pointing towards the sun's center. [°] @@ -43,7 +48,11 @@ There is a convention on consistent variable names throughout the library: bhi Beam/direct horizontal irradiance - + + clearsky_index + clearsky index. Ratio of actual global irradiance to modeled clearsky + global irradiance + dhi Diffuse horizontal irradiance From 83089aaa1457ccbdc4e8c517056e85193da750b7 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 21 Jan 2026 09:54:23 -0700 Subject: [PATCH 2/5] line length of various definitions --- .../source/user_guide/extras/nomenclature.rst | 40 ++++++++++--------- 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/docs/sphinx/source/user_guide/extras/nomenclature.rst b/docs/sphinx/source/user_guide/extras/nomenclature.rst index e02a196e82..20bdb90cea 100644 --- a/docs/sphinx/source/user_guide/extras/nomenclature.rst +++ b/docs/sphinx/source/user_guide/extras/nomenclature.rst @@ -38,9 +38,9 @@ There is a convention on consistent variable names throughout the library: apparent_zenith Refraction-corrected solar zenith angle. The solar - zenith angle describes the position of the sun relative to the vertical and is - defined as the angle between a vector pointed straight up and a vector pointed - at the sun, from the observer. [°] + zenith angle describes the position of the sun relative to the vertical + and is defined as the angle between a vector pointed straight up and a + vector pointed at the sun, from the observer. [°] apparent_elevation Refraction-corrected solar elevation angle. This is the complement of @@ -104,10 +104,12 @@ There is a convention on consistent variable names throughout the library: Sandia Array Performance Model IV curve parameters latitude - Latitude in decimal degrees. Positive north of equator, negative to south. + Latitude in decimal degrees. Positive north of equator, negative to + south. longitude - Longitude in decimal degrees. Positive east of prime meridian, negative to west. + Longitude in decimal degrees. Positive east of prime meridian, negative + to west. pac, ac AC power @@ -158,15 +160,16 @@ There is a convention on consistent variable names throughout the library: Diode saturation current solar_azimuth - Azimuth angle of the sun in degrees East of North. The solar azimuth angle - describes the sun’s position along the horizon relative to the observer. - The pvlib-python convention is defined as degrees East of North, so - North = 0°, East = 90°, South = 180°, West = 270°. + Azimuth angle of the sun in degrees East of North. The solar azimuth + angle describes the sun’s position along the horizon relative to the + observer. The pvlib-python convention is defined as degrees East of + North, so North = 0°, East = 90°, South = 180°, West = 270°. solar_zenith - Zenith angle of the sun in degrees. This is the angle between is between a - vector pointed straight up and a vector pointed at the sun, from the observer. - This is the complement of solar elevation (90 - elevation). [°] + Zenith angle of the sun in degrees. This is the angle between is + between a vector pointed straight up and a vector pointed at the sun, + from the observer. This is the complement of solar elevation + 90 - elevation). [°] spectra spectra_components @@ -176,16 +179,17 @@ There is a convention on consistent variable names throughout the library: is composed of direct and diffuse components. surface_azimuth - Azimuth angle of the surface in degrees East of North. This angle describes the - horizontal projection of the normal vector from the surface. The pvlib-python - convention is defined as degrees East (clockwise) of North, so North = 0°, - East = 90°, South = 180°, West = 270°. + Azimuth angle of the surface in degrees East of North. This angle + describes the horizontal projection of the normal vector from the + surface. The pvlib-python convention is defined as degrees East + (clockwise) of North, so North = 0°, East = 90°, South = 180°, + West = 270°. surface_tilt Tilt from horizontal [°]. The surface tilt angle is defined as degrees from the horizontal - such that a surface facing up would have a surface tilt of 0°, and one facing - the horizon would be 90°. [°] + such that a surface facing up would have a surface tilt of 0°, and one + facing the horizon would be 90°. [°] temp_air Temperature of the air From ff24b9ee2e2b42c237f16541c0b3c6213cbc6b64 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 21 Jan 2026 10:01:43 -0700 Subject: [PATCH 3/5] Update spectrum.rst --- docs/sphinx/source/user_guide/modeling_topics/spectrum.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst index 0747c0b295..ecfb230aca 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst @@ -51,7 +51,7 @@ Reference [2]_. | +-----------------------------+ | | | | | | | | |:term:`precipitable_water`, | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | [2]_ | | +-----------------------------+ | | | | | | | -| | aod | | | | | | | | +| | :term:`aod` | | | | | | | | +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+ | :py:func:`First Solar ` | :term:`airmass_absolute`, | | | | | | | | | +-----------------------------+ | ✓ | ✓ | | | | [3]_ | @@ -59,7 +59,7 @@ Reference [2]_. +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+ | :py:func:`JRC ` | :term:`airmass_relative`, | | | | | | | | | +-----------------------------+ | ✓ | ✓ | | | + [4]_ | -| | clearsky_index | | | | | | | | +| | :term:`clearsky_index` | | | | | | | | +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+ | :py:func:`Polo ` | :term:`precipitable_water`, | | | | | | | | | +-----------------------------+ ✓ | | ✓ | ✓ | ✓ | + [5]_ | From 296831e60a08e107138eff8e8fa962c79803152c Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 21 Jan 2026 10:45:06 -0700 Subject: [PATCH 4/5] add clarification for numbers eg aod500 --- docs/sphinx/source/user_guide/extras/nomenclature.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/extras/nomenclature.rst b/docs/sphinx/source/user_guide/extras/nomenclature.rst index 20bdb90cea..a230e49010 100644 --- a/docs/sphinx/source/user_guide/extras/nomenclature.rst +++ b/docs/sphinx/source/user_guide/extras/nomenclature.rst @@ -21,9 +21,13 @@ There is a convention on consistent variable names throughout the library: [unitless] aod + aod500 aerosol optical depth. Measure of aerosols (e.g., smoke particles, desert dust) distributed within a column of air from the - instrument (Earth's surface) to the top of the atmosphere. [unitless] + instrument (Earth's surface) to the top of the atmosphere. The AOD + value indicates the level of extinction of sunlight in this column, and + when followed by a number (e.g. AOD500), indicates the extinction at + this wavelength (500nm). [unitless] aoi Angle of incidence. Angle between the surface normal vector and the From 62e1a9b0f1864e1f9bf3c5a934019dc634869573 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 21 Jan 2026 10:45:33 -0700 Subject: [PATCH 5/5] link aod500 in spectrum.rst --- docs/sphinx/source/user_guide/modeling_topics/spectrum.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst index ecfb230aca..1ff5fa1df4 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst @@ -65,7 +65,7 @@ Reference [2]_. | +-----------------------------+ ✓ | | ✓ | ✓ | ✓ | + [5]_ | | | :term:`airmass_absolute`, | | | | | | | | | +-----------------------------+ | | | | | | | -| | aod500, | | | | | | | | +| | :term:`aod500` | | | | | | | | | +-----------------------------+ | | | | | | | | | :term:`aoi`, | | | | | | | | | +-----------------------------+ | | | | | | |