Skip to content

Commit d5d8ffa

Browse files
AdamRJensenAdamRJensenwholmgrenkandersolar
authored
Add sodapro.get_cams_radiation (#1175)
* Add cams.get_cams_radiation function * Revert "Add cams.get_cams_radiation function" This reverts commit d7deb80. * Add cams.get_cams_mcclear * Update v0.9.0.rst * Reference correct pull request in whatsnew * Add test file for monthly data * Create sub-functions parse and read * Fixed stickler * Update constants names * Fixed monthly integration of values * Improvement to meta-data parsing * Update test file to be during the day * Convert to get_cams to add support for CAMS Radiation * Fixed stickler issues * Update function names to just 'cams' * Update return description * Rename to cams_radiation And minor updates to the documentation * Convert print statements to warnings * Update function names * Fixed stickler * Fixed stickler * Improvements to documentation * Raise warning for unrecognized time step Co-authored-by: Will Holmgren <[email protected]> * Reworked URL formatting & comments on HTTP status * Fixed stickler * Add tests for cams.read_cams_radiation * Add tests coverage for metadata * Update docs/sphinx/source/whatsnew/v0.9.0.rst Co-authored-by: Will Holmgren <[email protected]> * Add reference to parsing function in whatsnew * Update module and function names Module name changed to sodapro instead of cams. Function names changed, e.g., get_cams instead of get_cams_radiation. * Update iotools init file with new names * update test file name * Add ".." to conftest import and update function documentation Replaced fancy quotation marks with simple ones. * Change asterisk to † in documentation * Update from master * Add mock tests * Stickler fixes and add import of requests_mock * Remove import request_mock in test_sodapro.py * Added requests-mock to setup.py and CI requirements files * Add requests-mock to ci\azure\posix.yml * Move requests-mock to pip install section * Move requests-mock to pip install section for py36 and py36-min * Add additional tests for full coverage * Update stickler * Add timeout option to get_cams * Add timeout option to get_cams * Extent tests to cover label, integrated, map_variables arguments * Fix stickler * Updates to documentation Co-authored-by: Kevin Anderson <[email protected]> * Update to documentation Co-authored-by: Kevin Anderson <[email protected]> * Reformat data inputs, set index name to None Also, includes a few minor changes addressing the review by @kanderso-nrel * Remove rounding when converting from integrated values * Minor updates to mock tests Includes match keywords for tests that asserts warning and error messages. * Remove round(4) * Change meta variable name to metadata * Change start_date/end_date to start/end * Make stickler happy Co-authored-by: AdamRJensen <[email protected]> Co-authored-by: Will Holmgren <[email protected]> Co-authored-by: Kevin Anderson <[email protected]>
1 parent 4329ac4 commit d5d8ffa

16 files changed

+913
-2
lines changed

‎ci/azure/posix.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
versionSpec: '$(python.version)'
2424

2525
- script: |
26-
pip install pytest pytest-cov pytest-mock pytest-timeout pytest-azurepipelines pytest-rerunfailures pytest-remotedata
26+
pip install pytest pytest-cov pytest-mock requests-mock pytest-timeout pytest-azurepipelines pytest-rerunfailures pytest-remotedata
2727
pip install -e .
2828
pytest pvlib --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
2929
displayName: 'Test with pytest'

‎ci/requirements-py36-min.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ dependencies:
1919
- scipy==1.2.0
2020
- pytest-rerunfailures # conda version is >3.6
2121
- pytest-remotedata # conda package is 0.3.0, needs > 0.3.1
22+
- requests-mock

‎ci/requirements-py36.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ dependencies:
1616
- pytest
1717
- pytest-cov
1818
- pytest-mock
19+
- requests-mock
1920
- pytest-rerunfailures
2021
- pytest-remotedata
2122
- pytest-timeout

‎ci/requirements-py37.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ dependencies:
1616
- pytest
1717
- pytest-cov
1818
- pytest-mock
19+
- requests-mock
1920
- pytest-timeout
2021
- pytest-rerunfailures
2122
- pytest-remotedata

‎ci/requirements-py38.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ dependencies:
1616
- pytest
1717
- pytest-cov
1818
- pytest-mock
19+
- requests-mock
1920
- pytest-timeout
2021
- pytest-rerunfailures
2122
- pytest-remotedata

‎ci/requirements-py39.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ dependencies:
1616
- pytest
1717
- pytest-cov
1818
- pytest-mock
19+
- requests-mock
1920
- pytest-timeout
2021
- pytest-rerunfailures
2122
- pytest-remotedata

‎docs/sphinx/source/api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,6 +488,9 @@ of sources and file formats relevant to solar energy modeling.
488488
iotools.get_pvgis_tmy
489489
iotools.read_pvgis_tmy
490490
iotools.read_bsrn
491+
iotools.get_cams
492+
iotools.read_cams
493+
iotools.parse_cams
491494

492495
A :py:class:`~pvlib.location.Location` object may be created from metadata
493496
in some files.

‎docs/sphinx/source/whatsnew/v0.9.0.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ Enhancements
105105
~~~~~~~~~~~~
106106
* Add :func:`~pvlib.iotools.read_bsrn` for reading BSRN solar radiation data
107107
files. (:pull:`1145`, :issue:`1015`)
108+
* Add :func:`~pvlib.iotools.get_cams`,
109+
:func:`~pvlib.iotools.parse_cams`, and
110+
:func:`~pvlib.iotools.read_cams`
111+
for retrieving, parsing, and reading CAMS Radiation and McClear time-series
112+
files. (:pull:`1175`)
108113
* In :py:class:`~pvlib.modelchain.ModelChain`, attributes which contain
109114
output of models are now collected into ``ModelChain.results``.
110115
(:pull:`1076`, :issue:`1067`)

‎pvlib/data/cams_mcclear_1min_verbose.csv

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Coding: utf-8
2+
# File format version: 4
3+
# Title: CAMS McClear v3.1 model of clear-sky irradiation.
4+
# Content: A time-series of solar radiation received on horizontal plane and plane always normal to the sun rays at ground level assuming clear sky.
5+
# Calls on the McClear clear-sky model. Returns the global, beam and diffuse irradiations integrated over a selected time step,
6+
# for a selected location (worldwide coverage) and a selected period.
7+
# The research leading to these results has received funding from the European Union within the Copernicus programme.
8+
# Provider: MINES ParisTech (France)
9+
# More information at: http://www.soda-pro.com/web-services/radiation/cams-mcclear
10+
# Date begin (ISO 8601): 2020-06-01T00:00:00.0
11+
# Date end (ISO 8601): 2020-06-03T00:00:00.0
12+
# Latitude (positive North, ISO 19115): 55.7906
13+
# Longitude (positive East, ISO 19115): 12.5251
14+
# Altitude (m): 39.00
15+
# Elevation of CAMS cell (m): 28.64
16+
# Time reference: Universal time (UT)
17+
#
18+
# Encoding partly from D2.8.III.13-14 INSPIRE Data Specification on Atmospheric Conditions and Meteorological Geographical Features - Technical Guidelines (2013-12-10) and CF (Climate and Forecast) metadata (2013-11-11)
19+
# CF Standard Names registry of ObservablePropertyValue
20+
# http://cfconventions.org/Data/cf-standard-names/27/build/cf-standard-name-table.html
21+
# urn:x-inspire:specification:DS-AC-MF:observable-property-name:cf-standard-name:1.6
22+
# ObservableProperty
23+
# basePhenomenon:"integral_of_surface_downwelling_shortwave_flux_in_air_assuming_clear_sky_wrt_time"
24+
# uom:"Wh m-2" [unit]
25+
# StatisticalMeasure
26+
# statisticalFunction: "sum"
27+
# Summarization (integration) period: 0 year 0 month 0 day 0 h 1 min 0 s
28+
# noValue: nan
29+
# File generated on: 2021-02-26
30+
#
31+
# Columns:
32+
# 1. Observation period (ISO 8601)
33+
# 2. TOA. Irradiation on horizontal plane at the top of atmosphere (Wh/m2)
34+
# 3. Clear sky GHI. Clear sky global irradiation on horizontal plane at ground level (Wh/m2)
35+
# 4. Clear sky BHI. Clear sky beam irradiation on horizontal plane at ground level (Wh/m2)
36+
# 5. Clear sky DHI. Clear sky diffuse irradiation on horizontal plane at ground level (Wh/m2)
37+
# 6. Clear sky BNI. Clear sky beam irradiation on mobile plane following the sun at normal incidence (Wh/m2)
38+
# 7. sza. Solar zenithal angle for the middle of the summarization (deg)
39+
# 8. summer/winter split. 1.0 means summer, 0.0 means winter
40+
# 9. tco3. Total column content of ozone (Dobson unit)
41+
#10. tcwv. Total column content of water vapour (kg/m2)
42+
#11. AOD BC. Partial aerosol optical depth at 550 nm for black carbon
43+
#12. AOD DU. Partial aerosol optical depth at 550 nm for dust
44+
#13. AOD SS. Partial aerosol optical depth at 550 nm for sea salt
45+
#14. AOD OR. Partial aerosol optical depth at 550 nm for organic matter
46+
#15. AOD SU. Partial aerosol optical depth at 550 nm for sulphate
47+
#16. AOD NI. Partial aerosol optical depth at 550 nm for nitrate
48+
#17. AOD AM. Partial aerosol optical depth at 550 nm for ammonium
49+
#18. alpha. Angstroem coefficient for aerosol
50+
#19. Aerosol type. Obsolete (value is always -1)
51+
#20. fiso. MODIS-like BRDF parameter fiso
52+
#21. fvol. MODIS-like BRDF parameter fvol
53+
#22. fgeo. MODIS-like BRDF parameter fgeo
54+
#23. albedo. Ground albedo
55+
#
56+
# Observation period;TOA;Clear sky GHI;Clear sky BHI;Clear sky DHI;Clear sky BNI;sza;summer/winter split;tco3;tcwv;AOD BC;AOD DU;AOD SS;AOD OR;AOD SU;AOD NI;AOD AM;alpha;Aerosol type;fiso;fvol;fgeo;albedo
57+
2020-06-01T12:00:00.0/2020-06-01T12:01:00.0;18.0699;14.1417;12.5594;1.5823;15.3380;35.0308;0.9723;341.0221;17.7962;0.0065;0.0067;0.0008;0.0215;0.0252;0.0087;0.0022;nan;-1;0.1668;0.0912;0.0267;0.1359
58+
2020-06-01T12:01:00.0/2020-06-01T12:02:00.0;18.0584;14.1311;12.5484;1.5827;15.3343;35.0828;0.9723;341.0223;17.8020;0.0065;0.0067;0.0008;0.0215;0.0253;0.0087;0.0022;nan;-1;0.1668;0.0912;0.0267;0.1359
59+
2020-06-01T12:02:00.0/2020-06-01T12:03:00.0;18.0467;14.1204;12.5372;1.5831;15.3306;35.1357;0.9723;341.0224;17.8079;0.0065;0.0067;0.0008;0.0216;0.0253;0.0087;0.0022;nan;-1;0.1668;0.0912;0.0267;0.1359
60+
2020-06-01T12:03:00.0/2020-06-01T12:04:00.0;18.0348;14.1094;12.5259;1.5835;15.3269;35.1896;0.9723;341.0226;17.8137;0.0065;0.0067;0.0008;0.0217;0.0253;0.0087;0.0022;nan;-1;0.1668;0.0912;0.0267;0.1359

‎pvlib/data/cams_mcclear_monthly.csv

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Coding: utf-8
2+
# File format version: 2
3+
# Title: CAMS McClear v3.1 model of clear-sky irradiation.
4+
# Content: A time-series of solar radiation received on horizontal plane and plane always normal to the sun rays at ground level assuming clear sky.
5+
# Calls on the McClear clear-sky model. Returns the global, beam and diffuse irradiations integrated over a selected time step,
6+
# for a selected location (worldwide coverage) and a selected period.
7+
# The research leading to these results has received funding from the European Union within the Copernicus programme.
8+
# Provider: MINES ParisTech (France)
9+
# More information at: http://www.soda-pro.com/web-services/radiation/cams-mcclear
10+
# Date begin (ISO 8601): 2020-01-01T00:00:00.0
11+
# Date end (ISO 8601): 2021-01-01T00:00:00.0
12+
# Latitude (positive North, ISO 19115): 55.7906
13+
# Longitude (positive East, ISO 19115): 12.5251
14+
# Altitude (m): 39.00
15+
# Time reference: Universal time (UT)
16+
#
17+
# Encoding partly from D2.8.III.13-14 INSPIRE Data Specification on Atmospheric Conditions and Meteorological Geographical Features - Technical Guidelines (2013-12-10) and CF (Climate and Forecast) metadata (2013-11-11)
18+
# CF Standard Names registry of ObservablePropertyValue
19+
# http://cfconventions.org/Data/cf-standard-names/27/build/cf-standard-name-table.html
20+
# urn:x-inspire:specification:DS-AC-MF:observable-property-name:cf-standard-name:1.6
21+
# ObservableProperty
22+
# basePhenomenon:"integral_of_surface_downwelling_shortwave_flux_in_air_assuming_clear_sky_wrt_time"
23+
# uom:"Wh m-2" [unit]
24+
# StatisticalMeasure
25+
# statisticalFunction: "sum"
26+
# Summarization (integration) period: 0 year 1 month 0 day 0 h 0 min 0 s
27+
# noValue: nan
28+
# File generated on: 2021-02-23
29+
#
30+
# Columns:
31+
# 1. Observation period (ISO 8601)
32+
# 2. TOA. Irradiation on horizontal plane at the top of atmosphere (Wh/m2)
33+
# 3. Clear sky GHI. Clear sky global irradiation on horizontal plane at ground level (Wh/m2)
34+
# 4. Clear sky BHI. Clear sky beam irradiation on horizontal plane at ground level (Wh/m2)
35+
# 5. Clear sky DHI. Clear sky diffuse irradiation on horizontal plane at ground level (Wh/m2)
36+
# 6. Clear sky BNI. Clear sky beam irradiation on mobile plane following the sun at normal incidence (Wh/m2)
37+
#
38+
# Observation period;TOA;Clear sky GHI;Clear sky BHI;Clear sky DHI;Clear sky BNI
39+
2020-01-01T00:00:00.0/2020-02-01T00:00:00.0;50168.9961;29424.7578;19492.6445;9932.1123;105764.1953
40+
2020-02-01T00:00:00.0/2020-03-01T00:00:00.0;91338.5234;59010.3047;40636.3008;18374.0020;140930.5781
41+
2020-03-01T00:00:00.0/2020-04-01T00:00:00.0;172855.2031;121402.9141;93124.6250;28278.2891;228798.9062
42+
2020-04-01T00:00:00.0/2020-05-01T00:00:00.0;248215.0312;180546.1406;142470.4688;38075.6680;279122.9375

0 commit comments

Comments
 (0)