diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 856e5fa5d7..ac9ad784c5 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -41,8 +41,10 @@ Documentation (:issue:`2423`, :pull:`2426`) * Clarify which SAPM coefficients are required by the ``module`` parameter in :py:func:`~pvlib.pvsystem.sapm` (:issue:`2392`, :pull:`2435`) -* Update references in :py:func`~pvlib.irradiance.get_extra_radiation` - (:issue:`2333`, :pull:`2347`) +* Update references in :py:func:`~pvlib.irradiance.get_extra_radiation` + (:issue:`2333`, :pull:`2437`) +* Update references in :py:func:`~pvlib.iotools.get_cams` and :py:func:`~pvlib.iotools.read_cams` + (:issue:`2427`, :pull:`2457`) Requirements ~~~~~~~~~~~~ @@ -67,3 +69,5 @@ Contributors * Will Holmgren (:ghuser:`wholmgren`) * Muhammad Rebaal (:ghuser:`Muhammad-Rebaal`) * omahs (:ghuser:`omahs`) +* Adam R. Jensen (:ghuser:`AdamRJensen`) +* Marion Schroedter-Homscheidt (:ghuser:`mschroedter`) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index 0aba3c26b3..292c8b477a 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -143,6 +143,12 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', e.g. `sza` becomes `solar_zenith`. See variable :const:`VARIABLE_MAP` for the complete mapping. + For large geospatial areas, CAMS offers a pre-calculated + gridded dataset [4]_ over land and coastal areas. This dataset + may not include the most recent data coverage and may not be + based on the most recent CAMS version. This dataset is not available + through pvlib. + See Also -------- pvlib.iotools.read_cams, pvlib.iotools.parse_cams @@ -155,13 +161,15 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', References ---------- - .. [1] `CAMS solar radiation documentation - `_ + .. [1] `CAMS solar radiation time-series documentation. Climate Data Store. + `_ .. [2] `CAMS Radiation Automatic Access (SoDa) `_ .. [3] A. R. Jensen et al., pvlib iotools — Open-source Python functions for seamless access to solar irradiance data. Solar Energy. 2023. Vol 266, pp. 112092. :doi:`10.1016/j.solener.2023.112092` + .. [4] `CAMS gridded solar radiation documentation. + `_ """ try: time_step_str = TIME_STEPS_MAP[time_step] @@ -268,8 +276,8 @@ def parse_cams(fbuf, integrated=False, label=None, map_variables=True): References ---------- - .. [1] `CAMS solar radiation documentation - `_ + .. [1] `CAMS solar radiation time-series documentation. Climate Data Store. + `_ """ metadata = {} # Initial lines starting with # contain metadata @@ -370,8 +378,8 @@ def read_cams(filename, integrated=False, label=None, map_variables=True): References ---------- - .. [1] `CAMS solar radiation documentation - `_ + .. [1] `CAMS solar radiation time-series documentation. Climate Data Store. + `_ """ with open(str(filename), 'r') as fbuf: content = parse_cams(fbuf, integrated, label, map_variables)