| Title: | Client for CAMS Radiation Service |
|---|---|
| Description: | Copernicus Atmosphere Monitoring Service (CAMS) Radiation Service provides time series of global, direct, and diffuse irradiations on horizontal surface, and direct irradiation on normal plane for the actual weather conditions as well as for clear-sky conditions. The geographical coverage is the field-of-view of the Meteosat satellite, roughly speaking Europe, Africa, Atlantic Ocean, Middle East. The time coverage of data is from 2004-02-01 up to 2 days ago. Data are available with a time step ranging from 15 min to 1 month. For license terms and to create an account, please see <http://www.soda-pro.com/web-services/radiation/cams-radiation-service>. |
| Authors: | Lukas Lundstrom [aut, cre] |
| Maintainer: | Lukas Lundstrom <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.3.0.9001 |
| Built: | 2024-08-29 23:16:11 UTC |
| Source: | https://github.com/ropensci/camsRad |
API client for CAMS radiation service
cams_api(lat, lng, date_begin, date_end, alt = -999, time_step = "PT01H", time_ref = "UT", verbose = FALSE, service = "get_cams_radiation", format = "application/csv", filename = "")cams_api(lat, lng, date_begin, date_end, alt = -999, time_step = "PT01H", time_ref = "UT", verbose = FALSE, service = "get_cams_radiation", format = "application/csv", filename = "")
lat |
Latitude, in decimal degrees. Required |
lng |
Longitude, in decimal degrees. Required |
date_begin |
Start date as 'yyyy-mm-dd' string. Required |
date_end |
End date as 'yyyy-mm-dd' string. Required |
alt |
Altitude in meters, use -999 to let CAMS decide. Default -99 |
time_step |
Aggregation: 'PT01M' for minutes, 'PT15M' for 15 minutes, 'PT01H' for hourly, 'P01D' for daily, 'P01M' for monthly. Deafult 'PT01H' |
time_ref |
Time reference:'UT' for universal time, 'TST' for true solar time. Default 'UT' |
verbose |
TRUE for verbose output. Default "FALSE" |
service |
'get_mcclear' for CAMS McClear data, 'get_cams_radiation' for CAMS radiation data. Default 'get_cams_radiation' |
format |
'application/csv', 'application/json', 'application/x-netcdf' or 'text/csv'. Default 'application/csv' |
filename |
path to file on disk to write to. If empty, data is kept in memory. Default empty |
list(ok=TRUE/FALSE, response=response). If ok=TRUE, response is the response from httr::GET. If ok=FALSE, response holds exception text
## Not run: library(ncdf4) filename <- paste0(tempfile(), ".nc") # API call to CAMS r <- cams_api( 60, 15, # latitude=60, longitude=15 "2016-06-01", "2016-06-10", # for 2016-06-01 to 2016-06-10 time_step="PT01H", # hourly data service="get_cams_radiation", # CAMS radiation format="application/x-netcdf",# netCDF format filename=filename) # file to save to # Access the on disk stored ncdf4 file nc <- nc_open(filename) # list names of available variables names(nc$var) # create data.frame with timestamp and global horizontal irradiation df <- data.frame(datetime=as.POSIXct(nc$dim$time$vals, "UTC", origin="1970-01-01"), GHI = ncvar_get(nc, "GHI")) plot(df, type="l") nc_close(nc) ## End(Not run)## Not run: library(ncdf4) filename <- paste0(tempfile(), ".nc") # API call to CAMS r <- cams_api( 60, 15, # latitude=60, longitude=15 "2016-06-01", "2016-06-10", # for 2016-06-01 to 2016-06-10 time_step="PT01H", # hourly data service="get_cams_radiation", # CAMS radiation format="application/x-netcdf",# netCDF format filename=filename) # file to save to # Access the on disk stored ncdf4 file nc <- nc_open(filename) # list names of available variables names(nc$var) # create data.frame with timestamp and global horizontal irradiation df <- data.frame(datetime=as.POSIXct(nc$dim$time$vals, "UTC", origin="1970-01-01"), GHI = ncvar_get(nc, "GHI")) plot(df, type="l") nc_close(nc) ## End(Not run)
Retrieve McClear clear sky solar radiation data
cams_get_mcclear(lat, lng, date_begin, date_end, time_step = "PT01H", alt = -999, verbose = FALSE)cams_get_mcclear(lat, lng, date_begin, date_end, time_step = "PT01H", alt = -999, verbose = FALSE)
lat |
Latitude, in decimal degrees. Required |
lng |
Longitude, in decimal degrees. Required |
date_begin |
Start date as 'yyyy-mm-dd' string. Required |
date_end |
End date as 'yyyy-mm-dd' string. Required |
time_step |
Aggregation: 'PT01M' for minutes, 'PT15M' for 15 minutes, 'PT01H' for hourly, 'P01D' for daily, 'P01M' for monthly. Deafult 'PT01H' |
alt |
Altitude in meters, use -999 to let CAMS decide. Default -99 |
verbose |
TRUE for verbose output. Default "FALSE" |
A data frame with requested solar data
## Not run: df <- cams_get_mcclear( lat=60, lng=15, date_begin="2016-01-01", date_end="2016-01-15") print(head(df)) ## End(Not run)## Not run: df <- cams_get_mcclear( lat=60, lng=15, date_begin="2016-01-01", date_end="2016-01-15") print(head(df)) ## End(Not run)
Retrieve CAMS solar radiation data
cams_get_radiation(lat, lng, date_begin, date_end, time_step = "PT01H", alt = -999, verbose = FALSE)cams_get_radiation(lat, lng, date_begin, date_end, time_step = "PT01H", alt = -999, verbose = FALSE)
lat |
Latitude, in decimal degrees. Required |
lng |
Longitude, in decimal degrees. Required |
date_begin |
Start date as 'yyyy-mm-dd' string. Required |
date_end |
End date as 'yyyy-mm-dd' string. Required |
time_step |
Aggregation: 'PT01M' for minutes, 'PT15M' for 15 minutes, 'PT01H' for hourly, 'P01D' for daily, 'P01M' for monthly. Deafult 'PT01H' |
alt |
Altitude in meters, use -999 to let CAMS decide. Default -99 |
verbose |
TRUE for verbose output. Default "FALSE" |
A data frame with requested solar data
## Not run: # Get hourly solar radiation data df <- cams_get_radiation( lat=60, lng=15, date_begin="2016-06-01", date_end="2016-06-15") head(df) # Get daily solar radiation data df <- cams_get_radiation( lat=60, lng=15, date_begin="2016-06-01", date_end="2016-06-15", time_step="P01D") head(df) ## End(Not run)## Not run: # Get hourly solar radiation data df <- cams_get_radiation( lat=60, lng=15, date_begin="2016-06-01", date_end="2016-06-15") head(df) # Get daily solar radiation data df <- cams_get_radiation( lat=60, lng=15, date_begin="2016-06-01", date_end="2016-06-15", time_step="P01D") head(df) ## End(Not run)
Set username used for authentication by CAMS radiation service
cams_set_user(username)cams_set_user(username)
username |
Email registered at soda-pro.com. Required |
## Not run: # cams_set_user("[email protected]") # An email registered at soda-pro.com ## End(Not run)## Not run: # cams_set_user("[email protected]") # An email registered at soda-pro.com ## End(Not run)
CAMS radiation service provides time series of global, direct, and diffuse irradiations on horizontal surface, and direct irradiation on normal plane for the actual weather conditions as well as for clear-sky conditions. The geographical coverage is the field-of-view of the Meteosat satellite, roughly speaking Europe, Africa, Atlantic Ocean, Middle East (-66 to 66 degrees in both latitudes and longitudes). The time coverage of data is from 2004-02-01 up to 2 days ago. Data are available with a time step ranging from 15 min to 1 month.