From 13ea4e6183b711a81e84d929cc51af84fe5264d6 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 19:44:27 -0600 Subject: [PATCH 1/9] Update CAMS documentation --- pvlib/iotools/sodapro.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index 0aba3c26b3..fb9c34f7ae 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -62,6 +62,12 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', 66° in latitude and -66° to 180° in longitude for CAMS Radiation. See [3]_ for a map of the geographical coverage. + For studies involving large geospatial areas, CAMS offers a gridded dataset + [4]_, which is a post-processed compilation of many pre-calculated CAMS + time series on a pre-defined grid over land and coastal areas. Note, that + this dataset may therefore not yet include the most recent data coverage + and may not be based on the most recent version. + Parameters ---------- latitude: float @@ -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) From 5b2cc320b359e9bb2495252cb5e61aa7c5e86035 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 19:50:55 -0600 Subject: [PATCH 2/9] Update v0.12.1.rst --- docs/sphinx/source/whatsnew/v0.12.1.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 856e5fa5d7..670b618052 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -43,6 +43,8 @@ Documentation :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.iotools.get_cams` and :py:func`~pvlib.iotools.read_cams` + (:issue:`2427`, :pull:`2457`) Requirements ~~~~~~~~~~~~ From 33c6a46ac66fcee8193917ca1d754a6cd1b12111 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 19:58:47 -0600 Subject: [PATCH 3/9] Move gridded dataset description to notes --- pvlib/iotools/sodapro.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index fb9c34f7ae..cad7820413 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -62,12 +62,6 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', 66° in latitude and -66° to 180° in longitude for CAMS Radiation. See [3]_ for a map of the geographical coverage. - For studies involving large geospatial areas, CAMS offers a gridded dataset - [4]_, which is a post-processed compilation of many pre-calculated CAMS - time series on a pre-defined grid over land and coastal areas. Note, that - this dataset may therefore not yet include the most recent data coverage - and may not be based on the most recent version. - Parameters ---------- latitude: float @@ -149,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 studies involving large geospatial areas, CAMS offers a pre-calculated + gridded dataset [4]_ over land and coastal areas. Note, that this dataset + may therefore not yet include the most recent data coverage and may not be + based on the most recent version. This dataset is not available through + pvlib. + See Also -------- pvlib.iotools.read_cams, pvlib.iotools.parse_cams From acda3c9d2dc22c702614dd5ed2b202f214b8a45e Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 19:59:44 -0600 Subject: [PATCH 4/9] Fix whatsnew entry --- docs/sphinx/source/whatsnew/v0.12.1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 670b618052..393daf7d1b 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -41,9 +41,9 @@ 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` +* Update references in :py:func:`~pvlib.irradiance.get_extra_radiation` (:issue:`2333`, :pull:`2347`) -* Update references in :py:func`~pvlib.iotools.get_cams` and :py:func`~pvlib.iotools.read_cams` +* Update references in :py:func:`~pvlib.iotools.get_cams` and :py:func:`~pvlib.iotools.read_cams` (:issue:`2427`, :pull:`2457`) Requirements From 2b205de20fbfb62173166b9ae66707b3bf143abc Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 20:01:33 -0600 Subject: [PATCH 5/9] FIx previous whatsnew entry --- docs/sphinx/source/whatsnew/v0.12.1.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 393daf7d1b..0b366626ee 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -42,7 +42,7 @@ Documentation * 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`) + (:issue:`2333`, :pull:`2437`) * Update references in :py:func:`~pvlib.iotools.get_cams` and :py:func:`~pvlib.iotools.read_cams` (:issue:`2427`, :pull:`2457`) @@ -69,3 +69,4 @@ Contributors * Will Holmgren (:ghuser:`wholmgren`) * Muhammad Rebaal (:ghuser:`Muhammad-Rebaal`) * omahs (:ghuser:`omahs`) +* Adam R. Jensen (:ghuser:`AdamRJensen`) From 6346625e95c976da6b3b3a5d84830f4d19f35676 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 19 May 2025 20:03:33 -0600 Subject: [PATCH 6/9] Add Marion to Whatsnew --- docs/sphinx/source/whatsnew/v0.12.1.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/whatsnew/v0.12.1.rst b/docs/sphinx/source/whatsnew/v0.12.1.rst index 0b366626ee..ac9ad784c5 100644 --- a/docs/sphinx/source/whatsnew/v0.12.1.rst +++ b/docs/sphinx/source/whatsnew/v0.12.1.rst @@ -70,3 +70,4 @@ Contributors * Muhammad Rebaal (:ghuser:`Muhammad-Rebaal`) * omahs (:ghuser:`omahs`) * Adam R. Jensen (:ghuser:`AdamRJensen`) +* Marion Schroedter-Homscheidt (:ghuser:`mschroedter`) From 69d8990e0c9b89e5ccabd78348636116231b43ea Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Thu, 22 May 2025 18:48:54 -0600 Subject: [PATCH 7/9] Update pvlib/iotools/sodapro.py Co-authored-by: Cliff Hansen --- pvlib/iotools/sodapro.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index cad7820413..e3a6aaaa35 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -143,9 +143,9 @@ 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 studies involving large geospatial areas, CAMS offers a pre-calculated - gridded dataset [4]_ over land and coastal areas. Note, that this dataset - may therefore not yet include the most recent data coverage and may not be + 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 version. This dataset is not available through pvlib. From a27b90013bfd01d97ab5d17155c6dfe00f96ac7a Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Thu, 22 May 2025 18:49:38 -0600 Subject: [PATCH 8/9] Update pvlib/iotools/sodapro.py --- pvlib/iotools/sodapro.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index e3a6aaaa35..0f3cc0055e 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -146,8 +146,8 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', 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 version. This dataset is not available through - pvlib. + based on the most recent CAMS version. This dataset is not available + through pvlib. See Also -------- From 08fbb841fcb5c8bb38abb15d33f1ac06ff085dde Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 22 May 2025 21:13:44 -0400 Subject: [PATCH 9/9] Update pvlib/iotools/sodapro.py --- pvlib/iotools/sodapro.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/iotools/sodapro.py b/pvlib/iotools/sodapro.py index 0f3cc0055e..292c8b477a 100644 --- a/pvlib/iotools/sodapro.py +++ b/pvlib/iotools/sodapro.py @@ -144,7 +144,7 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear', the complete mapping. For large geospatial areas, CAMS offers a pre-calculated - gridded dataset [4]_over land and coastal areas. This dataset + 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.