setup_cds_credentials: Configure CDS credentials for ERA5 data access

View source: R/download.R

SetupCdsCredentialsR Documentation

Configure CDS credentials for ERA5 data access

Description

This function configures the Copernicus Climate Data Store (CDS) credentials for ERA5 downloads. The function examines the credentials in this order:

  1. The key argument that you give directly

  2. CDS_API_KEY environment variable

  3. ⁠~/.cdsapirc⁠ file

Usage

SetupCdsCredentials(...)

setup_cds_credentials(key = NULL)

Arguments

...

Arguments passed to the main function (used by aliases).

key

Your CDS API key (UUID format). If NULL, the function tries to read the key from the CDS_API_KEY environment variable or the ~/.cdsapirc file.

Value

Invisibly, TRUE once the key has been registered with 'ecmwfr'. Errors if no key can be found.

Examples


setup_cds_credentials()


varunayan documentation built on Oct. 30, 2026, 1:07 a.m.