From 5cedf6c8f9b735187e420bbeb78d5d245bdd60ed Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 7 Oct 2025 14:55:16 -0400 Subject: [PATCH 1/3] reorganize irradiance reference section --- .../reference/irradiance/angle-of-incidence.rst | 10 ++++++++++ .../reference/irradiance/class-methods.rst | 11 ----------- .../source/reference/irradiance/components.rst | 17 ----------------- .../irradiance/extraterrestrial-radiation.rst | 9 +++++++++ .../source/reference/irradiance/index.rst | 8 ++++---- .../irradiance/{albedo.rst => other.rst} | 7 +++++-- .../reference/irradiance/transposition.rst | 3 +++ 7 files changed, 31 insertions(+), 34 deletions(-) create mode 100644 docs/sphinx/source/reference/irradiance/angle-of-incidence.rst delete mode 100644 docs/sphinx/source/reference/irradiance/class-methods.rst delete mode 100644 docs/sphinx/source/reference/irradiance/components.rst create mode 100644 docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst rename docs/sphinx/source/reference/irradiance/{albedo.rst => other.rst} (51%) diff --git a/docs/sphinx/source/reference/irradiance/angle-of-incidence.rst b/docs/sphinx/source/reference/irradiance/angle-of-incidence.rst new file mode 100644 index 0000000000..6645648437 --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/angle-of-incidence.rst @@ -0,0 +1,10 @@ +.. currentmodule:: pvlib + +Angle of incidence +------------------ + +.. autosummary:: + :toctree: ../generated/ + + irradiance.aoi + irradiance.aoi_projection diff --git a/docs/sphinx/source/reference/irradiance/class-methods.rst b/docs/sphinx/source/reference/irradiance/class-methods.rst deleted file mode 100644 index f7fa25663b..0000000000 --- a/docs/sphinx/source/reference/irradiance/class-methods.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. currentmodule:: pvlib - -Methods for irradiance calculations ------------------------------------ - -.. autosummary:: - :toctree: ../generated/ - - pvsystem.PVSystem.get_irradiance - pvsystem.PVSystem.get_aoi - pvsystem.PVSystem.get_iam diff --git a/docs/sphinx/source/reference/irradiance/components.rst b/docs/sphinx/source/reference/irradiance/components.rst deleted file mode 100644 index ce75d9d083..0000000000 --- a/docs/sphinx/source/reference/irradiance/components.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. currentmodule:: pvlib - -Decomposing and combining irradiance ------------------------------------- - -.. autosummary:: - :toctree: ../generated/ - - irradiance.get_extra_radiation - irradiance.aoi - irradiance.aoi_projection - irradiance.beam_component - irradiance.poa_components - irradiance.get_ground_diffuse - irradiance.dni - irradiance.complete_irradiance - irradiance.diffuse_par_spitters diff --git a/docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst b/docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst new file mode 100644 index 0000000000..b08b6334e2 --- /dev/null +++ b/docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst @@ -0,0 +1,9 @@ +.. currentmodule:: pvlib + +Extraterrestrial radiation +-------------------------- + +.. autosummary:: + :toctree: ../generated/ + + irradiance.get_extra_radiation diff --git a/docs/sphinx/source/reference/irradiance/index.rst b/docs/sphinx/source/reference/irradiance/index.rst index bf503f3822..b2d5917a0e 100644 --- a/docs/sphinx/source/reference/irradiance/index.rst +++ b/docs/sphinx/source/reference/irradiance/index.rst @@ -6,10 +6,10 @@ Irradiance .. toctree:: :maxdepth: 2 - class-methods - components + decomposition transposition reverse-transposition - decomposition + angle-of-incidence clearness-index - albedo + extraterrestrial-radiation + other diff --git a/docs/sphinx/source/reference/irradiance/albedo.rst b/docs/sphinx/source/reference/irradiance/other.rst similarity index 51% rename from docs/sphinx/source/reference/irradiance/albedo.rst rename to docs/sphinx/source/reference/irradiance/other.rst index 868a065d1a..ebeecbce9f 100644 --- a/docs/sphinx/source/reference/irradiance/albedo.rst +++ b/docs/sphinx/source/reference/irradiance/other.rst @@ -1,9 +1,12 @@ .. currentmodule:: pvlib -Albedo ------- +Other +----- .. autosummary:: :toctree: ../generated/ + irradiance.dni + irradiance.complete_irradiance + irradiance.diffuse_par_spitters albedo.inland_water_dvoracek diff --git a/docs/sphinx/source/reference/irradiance/transposition.rst b/docs/sphinx/source/reference/irradiance/transposition.rst index 7b3624e692..2e15b4cafb 100644 --- a/docs/sphinx/source/reference/irradiance/transposition.rst +++ b/docs/sphinx/source/reference/irradiance/transposition.rst @@ -8,6 +8,9 @@ Transposition models irradiance.get_total_irradiance irradiance.get_sky_diffuse + irradiance.get_ground_diffuse + irradiance.beam_component + irradiance.poa_components irradiance.isotropic irradiance.perez irradiance.perez_driesse From 34c070e834aebaeb2092bcae5cdab2c319b6f0f2 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 7 Oct 2025 14:57:01 -0400 Subject: [PATCH 2/3] fix title --- docs/sphinx/source/reference/irradiance/clearness-index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/reference/irradiance/clearness-index.rst b/docs/sphinx/source/reference/irradiance/clearness-index.rst index bfc6d7bf8e..76825eaf5e 100644 --- a/docs/sphinx/source/reference/irradiance/clearness-index.rst +++ b/docs/sphinx/source/reference/irradiance/clearness-index.rst @@ -1,7 +1,7 @@ .. currentmodule:: pvlib -Clearness index models ----------------------- +Clearness and clearsky index +---------------------------- .. autosummary:: :toctree: ../generated/ From d1941ab3c81354ae5b49028914ebb572ff4dbe12 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 7 Oct 2025 15:53:00 -0400 Subject: [PATCH 3/3] fix another title --- docs/sphinx/source/reference/irradiance/decomposition.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/reference/irradiance/decomposition.rst b/docs/sphinx/source/reference/irradiance/decomposition.rst index b51529829e..cf0d355ab4 100644 --- a/docs/sphinx/source/reference/irradiance/decomposition.rst +++ b/docs/sphinx/source/reference/irradiance/decomposition.rst @@ -2,8 +2,8 @@ .. _dniestmodels: -DNI estimation models ---------------------- +Decomposition models +-------------------- .. autosummary:: :toctree: ../generated/