,
Reto Stauffer [ctb] ,
Elio Campitelli [ctb] ,
BlueGreen Labs [fnd]| Title: | Interface to 'ECMWF' and 'CDS' Data Web Services |
|---|---|
| Description: | Programmatic interface to the European Centre for Medium-Range Weather Forecasts dataset web services (ECMWF; <https://www.ecmwf.int/>) and Copernicus's Data Stores. Allows for easy downloads of weather forecasts and climate reanalysis data in R. Data stores covered include the Climate Data Store (CDS; <https://cds.climate.copernicus.eu>), Atmosphere Data Store (ADS; <https://ads.atmosphere.copernicus.eu>) and Early Warning Data Store (CEMS; <https://ewds.climate.copernicus.eu>). |
| Authors: | Koen Hufkens [aut, cre, cph] ,
Reto Stauffer [ctb] ,
Elio Campitelli [ctb] ,
BlueGreen Labs [fnd] |
| Maintainer: | Koen Hufkens <[email protected]> |
| License: | AGPL-3 |
| Version: | 2.0.4 |
| Built: | 2024-11-20 11:46:04 UTC |
| Source: | https://github.com/bluegreen-labs/ecmwfr |
Methods to deal with visualizing / printing requesting info from the archetype constructor
## S3 method for class 'ecmwfr_archetype' print(x, ...)## S3 method for class 'ecmwfr_archetype' print(x, ...)
x |
archetype object |
... |
additional parameters to pass on |
Creates a universal MARS / CDS formatting function, in ways
similar to wf_modify_request() but the added advantage
that you could code for the use of dynamic changes in the
parameters provided to the resulting custom function.
wf_archetype(request, dynamic_fields)wf_archetype(request, dynamic_fields)
request |
a MARS or CDS request as an R list object. |
dynamic_fields |
character vector of fields that could be changed. |
Contrary to a simple replacement as in wf_modify_request() the
generated functions are considered custom user written. Given the potential
for complex formulations and formatting commands NO SUPPORT for the
resulting functions can be provided. Only the generation of a valid function
will be guaranteed and tested for.
a function that takes 'dynamic_fields' as arguments and returns a request as an R list object.
## Not run: ERA <- wf_archetype( request = list( dataset_short_name = "reanalysis-era5-pressure-levels", product_type = "reanalysis", variable = "geopotential", year = "2024", month = "03", day = "01", time = "13:00", pressure_level = "1000", data_format = "grib", target = "download.grib" ), dynamic_fields = c("year", "day", "target") ) # print output of the function with below (new) parameters str(ERA(2021, 3, "new_download.grip")) ## End(Not run)## Not run: ERA <- wf_archetype( request = list( dataset_short_name = "reanalysis-era5-pressure-levels", product_type = "reanalysis", variable = "geopotential", year = "2024", month = "03", day = "01", time = "13:00", pressure_level = "1000", data_format = "grib", target = "download.grib" ), dynamic_fields = c("year", "day", "target") ) # print output of the function with below (new) parameters str(ERA(2021, 3, "new_download.grip")) ## End(Not run)
Check the validity of a data request by comparing the main dataset
to the list provided by wf_datasets
wf_check_request(request)wf_check_request(request)
request |
nested list with query parameters following the layout as specified on the ECMWF API page |
a data frame with the determined service and url service endpoint
Koen Hufkens
wf_set_key
wf_transfer,wf_request,
wf_transfer
Shows and returns detailed product information about a specific data set
(see wf_datasets). This includes the list of
sub-products in the collection as well as date and time ranges.
wf_dataset_info(dataset, simplify = TRUE)wf_dataset_info(dataset, simplify = TRUE)
dataset |
character, name of the data set for which the product information should be loaded |
simplify |
boolean, default |
Downloads a tidy data frame with product descriptions from CDS. If
simplify = FALSE a list with product details will be returned.
Reto Stauffer, Koen Hufkens
## Not run: # Return information info <- wf_dataset_info("reanalysis-era5-single-levels") names(info) ## End(Not run)## Not run: # Return information info <- wf_dataset_info("reanalysis-era5-single-levels") names(info) ## End(Not run)
Returns a list of all ECMWF datasets, covering all Data Store services
(i.e. CDS, ADS, CEMS). This function is used to validate the datasets
queried by wf_request. For optimization reasons
and limit API calls the function is cached and only called once per
session (assuming that available products and their information and
endpoints aren't updated on a regular sub-daily basis).
wf_datasets(service = c("cds", "ads", "cems"), simplify = TRUE)wf_datasets(service = c("cds", "ads", "cems"), simplify = TRUE)
service |
which service to use, one of |
simplify |
simplify the output, logical (default = |
returns a data frame with the ECMWF Data Store datasets
Koen Hufkens
## Not run: # get a list of ECMWF Data Store datasets wf_datasets() ## End(Not run)## Not run: # get a list of ECMWF Data Store datasets wf_datasets() ## End(Not run)
Deletes a staged download from the queue when not using R6 methods.
wf_delete(url, user = "ecmwfr", verbose = TRUE)wf_delete(url, user = "ecmwfr", verbose = TRUE)
url |
url to query |
user |
user, generally not set (default = "ecmwfr"), used by |
verbose |
show feedback on processing |
Koen Hufkens
wf_set_key
wf_transfer
wf_request
## Not run: # demo query using a valid request (not shown) file <- wf_request(request = request) # delete request job_url <- file$get_url() wf_delete(url = job_url) ## End(Not run)## Not run: # demo query using a valid request (not shown) file <- wf_request(request = request) # delete request job_url <- file$get_url() wf_delete(url = job_url) ## End(Not run)
Returns you token set by wf_set_key
wf_get_key(user = "ecmwfr")wf_get_key(user = "ecmwfr")
user |
user (email address) used to sign up for the ECMWF data service |
the key set using wf_set_key saved
in the keychain
Koen Hufkens
## Not run: # set key wf_set_key(key = "123") # get key wf_get_key() ## End(Not run)## Not run: # set key wf_set_key(key = "123") # get key wf_get_key() ## End(Not run)
Stage a data request, and optionally download the data to disk. Alternatively
you can only stage requests, logging the request URLs to submit download
queries later on using wf_transfer.
Note that the function will do some basic checks on the request input
to identify possible problems.
wf_request( request, user = "ecmwfr", transfer = TRUE, path = tempdir(), time_out = 3600, retry = 30, job_name, verbose = TRUE ) wf_request_batch( request_list, workers = 2, user = "ecmwfr", path = tempdir(), time_out = 3600, retry = 5, total_timeout = length(request_list) * time_out/workers )wf_request( request, user = "ecmwfr", transfer = TRUE, path = tempdir(), time_out = 3600, retry = 30, job_name, verbose = TRUE ) wf_request_batch( request_list, workers = 2, user = "ecmwfr", path = tempdir(), time_out = 3600, retry = 5, total_timeout = length(request_list) * time_out/workers )
request |
nested list with query parameters following the layout as specified on the ECMWF APIs page |
user |
user (default = "ecmwf") provided by the ECMWF data service,
used to retrieve the token set by |
transfer |
logical, download data TRUE or FALSE (default = TRUE) |
path |
path were to store the downloaded data |
time_out |
how long to wait on a download to start (default =
|
retry |
polling frequency of submitted request for downloading (default =
|
job_name |
optional name to use as an RStudio job and as output variable name. It has to be a syntactically valid name. |
verbose |
show feedback on processing |
request_list |
a list of requests that will be processed in parallel. |
workers |
maximum number of simultaneous request that will be submitted to the service. Most ECMWF services are limited to 20 concurrent requests (default = 2). |
total_timeout |
overall timeout limit for all the requests in seconds. |
the path of the downloaded (requested file) or the an R6 object with download/transfer information
Koen Hufkens
## Not run: # set key wf_set_key(key = "123") request <- list( dataset_short_name = "reanalysis-era5-pressure-levels", product_type = "reanalysis", variable = "geopotential", year = "2024", month = "03", day = "01", time = "13:00", pressure_level = "1000", data_format = "grib", target = "download.grib" ) # demo query wf_request(request = request) # Run as an RStudio Job. When finished, will create a # variable named "test" in your environment with the path to # the downloaded file. wf_request(request = request, job_name = "test") ## End(Not run)## Not run: # set key wf_set_key(key = "123") request <- list( dataset_short_name = "reanalysis-era5-pressure-levels", product_type = "reanalysis", variable = "geopotential", year = "2024", month = "03", day = "01", time = "13:00", pressure_level = "1000", data_format = "grib", target = "download.grib" ) # demo query wf_request(request = request) # Run as an RStudio Job. When finished, will create a # variable named "test" in your environment with the path to # the downloaded file. wf_request(request = request, job_name = "test") ## End(Not run)
Saves the token to your local keychain under a service called "ecmwfr".
wf_set_key(key, user = "ecmwfr")wf_set_key(key, user = "ecmwfr")
key |
token provided by ECMWF |
user |
user (email address) used to sign up for the ECMWF data service, if only a single user is needed it defaults to ("ecmwfr"). |
In systems without keychain management set the option keyring_backend to 'file' (i.e. options(keyring_backend = "file")) in order to write the keychain entry to an encrypted file. This mostly pertains to headless Linux systems. The keychain files can be found in ~/.config/r-keyring.
It invisibly returns the user.
Koen Hufkens
## Not run: # set key wf_set_key(key = "123") # get key wf_get_key() # leave user and key empty to open a browser window to the service's website # and type the key interactively wf_set_key() ## End(Not run)## Not run: # set key wf_set_key(key = "123") # get key wf_get_key() # leave user and key empty to open a browser window to the service's website # and type the key interactively wf_set_key() ## End(Not run)
Returns the contents of the requested url as a (NetCDF) file downloaded to disk or the current status of the requested transfer.
wf_transfer( url, user = "ecmwfr", path = tempdir(), filename = tempfile("ecmwfr_", tmpdir = ""), verbose = TRUE )wf_transfer( url, user = "ecmwfr", path = tempdir(), filename = tempfile("ecmwfr_", tmpdir = ""), verbose = TRUE )
url |
R6 |
user |
user (email address) used to sign up for the ECMWF data service,
used to retrieve the token set by |
path |
path were to store the downloaded data |
filename |
filename to use for the downloaded data |
verbose |
show feedback on data transfers |
Normal workflows would use the methods included in returned objects. This is for legacy support and custom scripting only.
a (netCDF) file of data on disk as specified by a
wf_request
Koen Hufkens
## Not run: # request data and grab url and try a transfer # (request not provided) r <- wf_request(request, transfer = FALSE) # check transfer, will download if available wf_transfer(r$get_url()) ## End(Not run)## Not run: # request data and grab url and try a transfer # (request not provided) r <- wf_request(request, transfer = FALSE) # check transfer, will download if available wf_transfer(r$get_url()) ## End(Not run)