From 919a92133db5180801a081e145abdf6681753d59 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 23 Apr 2025 13:10:38 -0400 Subject: [PATCH 1/6] split up iotools ref page by data provider/source --- docs/sphinx/source/reference/iotools.rst | 157 ++++++++++++++++++++--- 1 file changed, 136 insertions(+), 21 deletions(-) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index 8e2a3034d2..d4a1b042a5 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -11,21 +11,39 @@ IO Tools Functions for retrieving, reading, and writing data from a variety of sources and file formats relevant to solar energy modeling. +Public datasets +--------------- + +PVGIS +^^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.get_pvgis_tmy + iotools.read_pvgis_tmy + iotools.get_pvgis_hourly + iotools.read_pvgis_hourly + iotools.get_pvgis_horizon + + +CAMS +^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.get_cams + iotools.read_cams + iotools.parse_cams + + +NSRDB +^^^^^ + .. autosummary:: :toctree: generated/ - iotools.read_tmy2 - iotools.read_tmy3 - iotools.read_epw - iotools.parse_epw - iotools.read_srml - iotools.get_srml - iotools.read_surfrad - iotools.read_midc - iotools.read_midc_raw_data_from_nrel - iotools.read_crn - iotools.read_solrad - iotools.get_solrad iotools.get_nsrdb_psm4_aggregated iotools.get_nsrdb_psm4_tmy iotools.get_nsrdb_psm4_conus @@ -35,32 +53,129 @@ of sources and file formats relevant to solar energy modeling. iotools.get_psm3 iotools.read_psm3 iotools.parse_psm3 - iotools.get_pvgis_tmy - iotools.read_pvgis_tmy - iotools.get_pvgis_hourly - iotools.read_pvgis_hourly - iotools.get_pvgis_horizon + + +BSRN +^^^^ + +.. autosummary:: + :toctree: generated/ + iotools.get_bsrn iotools.read_bsrn iotools.parse_bsrn - iotools.get_cams - iotools.read_cams - iotools.parse_cams + + +SOLRAD +^^^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.read_solrad + iotools.get_solrad + + +SURFRAD +^^^^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.read_surfrad + + +MIDC +^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.read_midc + iotools.read_midc_raw_data_from_nrel + + +SRML +^^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.read_srml + iotools.get_srml + + +ACIS +^^^^ + +.. autosummary:: + :toctree: generated/ + iotools.get_acis_prism iotools.get_acis_nrcc iotools.get_acis_mpe iotools.get_acis_station_data iotools.get_acis_available_stations - iotools.read_panond + + +CRN +^^^ + +.. autosummary:: + :toctree: generated/ + + iotools.read_crn + + + +Commercial datasets +------------------- + + +SolarAnywhere +^^^^^^^^^^^^^ + +.. autosummary:: + :toctree: generated/ + iotools.get_solaranywhere iotools.read_solaranywhere + + +Solcast +^^^^^^^ + +.. autosummary:: + :toctree: generated/ + iotools.get_solcast_tmy iotools.get_solcast_historic iotools.get_solcast_forecast iotools.get_solcast_live + + +Solargis +^^^^^^^^ + +.. autosummary:: + :toctree: generated/ + iotools.get_solargis +Generic data file readers +------------------------- + +.. autosummary:: + :toctree: generated/ + + iotools.read_tmy2 + iotools.read_tmy3 + iotools.read_epw + iotools.parse_epw + iotools.read_panond + + A :py:class:`~pvlib.location.Location` object may be created from metadata in some files. From 7fbb9b64669229d2b56a113be21ccff0cb9232c7 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 22 May 2025 21:57:47 -0400 Subject: [PATCH 2/6] Update docs/sphinx/source/reference/iotools.rst Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --- docs/sphinx/source/reference/iotools.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index d4a1b042a5..b2148e6676 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -11,6 +11,10 @@ IO Tools Functions for retrieving, reading, and writing data from a variety of sources and file formats relevant to solar energy modeling. +.. contents:: Currently supported APIs + :depth: 3 + :local: + Public datasets --------------- From 084347d854870f5ac0704207b7a70eec89cd8f4d Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 22 May 2025 20:11:13 -0600 Subject: [PATCH 3/6] reorganize, add blurbs --- docs/sphinx/source/reference/iotools.rst | 114 +++++++++++++++-------- 1 file changed, 73 insertions(+), 41 deletions(-) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index b2148e6676..6236707bf9 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -9,17 +9,24 @@ IO Tools ======== Functions for retrieving, reading, and writing data from a variety -of sources and file formats relevant to solar energy modeling. +of sources and file formats relevant to solar energy modeling. See also +:ref:`weatherdata`. .. contents:: Currently supported APIs :depth: 3 :local: + +Gridded resource data +--------------------- + Public datasets ---------------- +^^^^^^^^^^^^^^^ PVGIS -^^^^^ +***** + +Multiple gridded irradiance and weather datasets with global coverage. .. autosummary:: :toctree: generated/ @@ -32,7 +39,10 @@ PVGIS CAMS -^^^^ +**** + +Satellite-derived irradiance data for Europe, Africa, and Asia, and +clear-sky irradiance globally. .. autosummary:: :toctree: generated/ @@ -43,7 +53,9 @@ CAMS NSRDB -^^^^^ +***** + +Satellite-derived irradiance and weather data for the Americas. .. autosummary:: :toctree: generated/ @@ -59,9 +71,48 @@ NSRDB iotools.parse_psm3 +Commercial datasets +^^^^^^^^^^^^^^^^^^^ + +SolarAnywhere +************* + +.. autosummary:: + :toctree: generated/ + + iotools.get_solaranywhere + iotools.read_solaranywhere + + +Solcast +******* + +.. autosummary:: + :toctree: generated/ + + iotools.get_solcast_tmy + iotools.get_solcast_historic + iotools.get_solcast_forecast + iotools.get_solcast_live + + +Solargis +******** + +.. autosummary:: + :toctree: generated/ + + iotools.get_solargis + + +Ground station data +------------------- + BSRN ^^^^ +A global network dedicated to high-quality monitoring of solar radiation. + .. autosummary:: :toctree: generated/ @@ -73,6 +124,8 @@ BSRN SOLRAD ^^^^^^ +A solar radiation network in the USA, run by NOAA. + .. autosummary:: :toctree: generated/ @@ -83,6 +136,8 @@ SOLRAD SURFRAD ^^^^^^^ +A solar radiation network in the USA, run by NOAA. + .. autosummary:: :toctree: generated/ @@ -92,6 +147,8 @@ SURFRAD MIDC ^^^^ +A solar radiation network in the USA, run by NREL. + .. autosummary:: :toctree: generated/ @@ -102,6 +159,8 @@ MIDC SRML ^^^^ +A solar radiation network in the northwest USA, run by the University of Oregon. + .. autosummary:: :toctree: generated/ @@ -109,9 +168,15 @@ SRML iotools.get_srml +Weather data +------------ + ACIS ^^^^ +A combination of many meteorological datasets providing temperature, +precipitation, wind speed, and other weather measurements. + .. autosummary:: :toctree: generated/ @@ -125,46 +190,13 @@ ACIS CRN ^^^ -.. autosummary:: - :toctree: generated/ - - iotools.read_crn - - - -Commercial datasets -------------------- - - -SolarAnywhere -^^^^^^^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - iotools.get_solaranywhere - iotools.read_solaranywhere - - -Solcast -^^^^^^^ - -.. autosummary:: - :toctree: generated/ - - iotools.get_solcast_tmy - iotools.get_solcast_historic - iotools.get_solcast_forecast - iotools.get_solcast_live - - -Solargis -^^^^^^^^ +A network of ground stations from NOAA. Irradiance measurements are of +relatively lower quality. .. autosummary:: :toctree: generated/ - iotools.get_solargis + iotools.read_crn Generic data file readers From f405613353ba26936ce4d0e2a4a162e757718073 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 22 May 2025 20:21:35 -0600 Subject: [PATCH 4/6] expand the blurbs --- docs/sphinx/source/reference/iotools.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index 6236707bf9..dcae9ba926 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -20,9 +20,14 @@ of sources and file formats relevant to solar energy modeling. See also Gridded resource data --------------------- +Modeled irradiance and meteorological data, available for large regions of +the world. + Public datasets ^^^^^^^^^^^^^^^ +These APIs are free to access, although some require registration. + PVGIS ***** @@ -74,6 +79,8 @@ Satellite-derived irradiance and weather data for the Americas. Commercial datasets ^^^^^^^^^^^^^^^^^^^ +Accessing these APIs typically requires payment. + SolarAnywhere ************* @@ -108,6 +115,9 @@ Solargis Ground station data ------------------- +Measurements from various networks of irradiance and meteorological +ground stations. + BSRN ^^^^ @@ -171,6 +181,8 @@ A solar radiation network in the northwest USA, run by the University of Oregon. Weather data ------------ +Meteorological datasets from a variety of modeled and measured datasets. + ACIS ^^^^ @@ -202,6 +214,8 @@ relatively lower quality. Generic data file readers ------------------------- +Functions for reading local irradiance/weather data files. + .. autosummary:: :toctree: generated/ From 1aacc49c6ebe3bc390d31640921ddc5aa9c4952f Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Fri, 23 May 2025 11:46:47 -0400 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- docs/sphinx/source/reference/iotools.rst | 26 +++++++++++++----------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index dcae9ba926..c3a7d8af88 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -17,8 +17,8 @@ of sources and file formats relevant to solar energy modeling. See also :local: -Gridded resource data ---------------------- +Gridded solar resource data +--------------------------- Modeled irradiance and meteorological data, available for large regions of the world. @@ -31,7 +31,7 @@ These APIs are free to access, although some require registration. PVGIS ***** -Multiple gridded irradiance and weather datasets with global coverage. +Multiple gridded irradiance datasets and weather data with global coverage. .. autosummary:: :toctree: generated/ @@ -112,16 +112,17 @@ Solargis iotools.get_solargis -Ground station data -------------------- +Ground station solar data +------------------------- -Measurements from various networks of irradiance and meteorological -ground stations. +Measurements from various networks of ground stations +focusing on solar irradiance. BSRN ^^^^ -A global network dedicated to high-quality monitoring of solar radiation. +A global network dedicated to high-quality monitoring of solar and +long-wave radiation. .. autosummary:: :toctree: generated/ @@ -169,7 +170,8 @@ A solar radiation network in the USA, run by NREL. SRML ^^^^ -A solar radiation network in the northwest USA, run by the University of Oregon. +A solar radiation network in the northwestern USA, run by +the University of Oregon. .. autosummary:: :toctree: generated/ @@ -181,7 +183,7 @@ A solar radiation network in the northwest USA, run by the University of Oregon. Weather data ------------ -Meteorological datasets from a variety of modeled and measured datasets. +Meteorological data from a variety of modeled and measured datasets. ACIS ^^^^ @@ -203,7 +205,7 @@ CRN ^^^ A network of ground stations from NOAA. Irradiance measurements are of -relatively lower quality. +lower quality. .. autosummary:: :toctree: generated/ @@ -214,7 +216,7 @@ relatively lower quality. Generic data file readers ------------------------- -Functions for reading local irradiance/weather data files. +Functions for reading irradiance/weather data files. .. autosummary:: :toctree: generated/ From 76d96d49f2e8c65724fe1aa19c0a603a03190c5c Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Tue, 27 May 2025 10:45:15 -0600 Subject: [PATCH 6/6] add line about commercial data spatial coverage --- docs/sphinx/source/reference/iotools.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst index dd0260e846..cbf89c71a7 100644 --- a/docs/sphinx/source/reference/iotools.rst +++ b/docs/sphinx/source/reference/iotools.rst @@ -79,6 +79,7 @@ Commercial datasets ^^^^^^^^^^^^^^^^^^^ Accessing these APIs typically requires payment. +Datasets provide near-global coverage. SolarAnywhere *************