From 919a92133db5180801a081e145abdf6681753d59 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 23 Apr 2025 13:10:38 -0400 Subject: [PATCH] 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.