v2.0.1

A command line interface to download ERA5 data from the Copernicus Climate Data Store.

Changes since v2.0.0:

Changed:

• Threads are set to 1 by default, as the new CDS is not faster if you use multiple threads.

Fixed:

• The cdsapi changed how wants the request formatted for getting netCDF files, netCDF files weren't properly downloaded anymore.

v2.0.0

era5cli version 2.0 comes support for the new CDS API. Please check the ECMWF's documentation on the new CDS API and re-register for a new API key.

Changes since v1.4.2:

Added:

• support for Python 3.12, 3.13.

Changed:

• The splitmonths argument now defaults to True for hourly requests. To not split requests by year, add --splitmonths False.
• The 'cads-api-client' used in the 2.0 beta versions is already deprecated, the backend now uses the 'cdsapi' again, which uses "datapi".

Fixed:

• Added support for the new climate data store.

Removed:

• the deprecated orography variable. Use geopotential instead.
• the deprecated --prelimbe argument. This one has not been required anymore, as the back-extension is part of the normal dataset now.
• support for Python 3.8.

Dev changes:

• The pre-commit hook has been removed. Pre-commit does not play well with hatch: it would need to be installed system-wide. No hatch-specific hooks are available.

v2.0.0b2

Fixed:

• Pinned the version number of cads-api-client as its interface is unstable.

v2.0.0b1

Note: this is a beta release, as this transfers era5cli over to the new Climate Data Store (CDS-Beta) which is not fully stable yet.

However, the old CDS will stop working by September 3, 2024..

Changed:

• The splitmonths argument now defaults to True for hourly requests. To not split requests by year, add --splitmonths False.

Fixed:

• Added support for the beta-CDS
• For authentication, the new cads-api-client is used, instead of a dummy request. This should avoid the dummy requests appearing in the user's queue.

Removed:

• the deprecated orography variable. Use geopotential instead.
• the deprecated --prelimbe argument. This one has not been required anymore, as the back-extension is part of the normal dataset now.

Dev changes:

• The pre-commit hook has been removed. Pre-commit does not play well with hatch: it would need to be installed system-wide. No hatch-specific hooks are available.

v1.4.2

Fixed:

• Fixed a typo in the error message when an invalid area was given (#160).
• Fixed pressing Enter not working for the default input in the "Valid CDS keys found in the .cdsapirc file. Do you want to use these for era5cli? [Y/n]" prompt (#160).

Added:

• era5cli is now available for Python 3.11 (#160).

Removed:

• Support for Python 3.7 has been removed. It's end-of-life was 2023-06-27 (#160).

v1.4.1

This patch release fixes a bug that would prevent some users from configuring their login info.

Fixed:

• Fix a bug that prevented the creation of the configuration file, if the "~/.config" folder did not exist yet (#153).

Added:

• The developer documentation now contains instructions on how to maintain the conda-forge feedstock for era5cli (#150).

Changed:

• Before asking for a user input, a check is made if the code is running in an interactive terminal or not. If not (e.g. if era5cli is called through a different script and stdin is not available), the input request is skipped (#152).

Dev changes:

• A pre-commit hook has been added, to facilitate pre-commit users. Documentation on the setup is added to the developer documentation (#153).

v1.4.0 (2023-04-21)

With this era5cli release comes a new documentation and some quality-of-life improvements!
For details see the lists below:

Added:

• Add validator for user's CDS keys. This should provide better feedback to users and reduce user error (#138).
• Added --splitmonths argument for era5cli hourly. This allows users to avoid a Request Too Large error (#139).
• When a request would encounter a Request Too Large error in the CDS API, they are warned, and given a suggestion to use the new --splitmonths argument (#139).
• Added --dashed-varname argument, to produce file names where the variable name is separated using dashes. For example: soil-type vs. soil_type. For the ongoing discussion, see #53.

Changed:

• Change CDS keys from cdsapi default .cdsapirc file to .config/era5cli/cds_key.txt file (#138).
  • This will avoid conflict with e.g. ADS keys
  • The user can configure the keys using era5cli config, no need to create a file in the right location.
• When a request would encounter a Request Too Large error in the CDS API, they are warned, and given a suggestion to use --splitmonths (#139).
• If a user makes a request without --splitmonths they are warned that the behavior will change in the future, and that they have to choose between --splitmonths False and --splitmonths True
• When a file already exists and would be overwritten, the user is prompted for confirmation. This should prevent accidental overwriting of files. This check can be skipped with the --overwrite flag (#143).
• The earliest valid start year of ERA5 requests has been updated to 1940 (for ERA5-land it is still 1950) (#146).
• Usage of --prelimbe now raises a deprecation warning. It will be deprecated in a future release, as all the back extension years are now included in the main products (#147).
• The documentation has been fully overhauled, and now uses Markdown files & MkDocs (#142, #144).

Dev changes:

• cli.py has been refactored to make the structure more clear. Seperate argument builders are now in their own modules (#139).

v1.3.2 (2022-12-13)

• Elaborate the range of years that can be queried #123
• Update Readthedocs theme #125
• Fix a bug that allowed the incompatible combination of --land and --ensemble #131

v1.3.1 (2021-12-01)

• Automatic Zenodo/RSD release failed; updated contribution guidelines #106

v1.3.0 (2021-11-30)

• Fix compatibility with changed CDS variables geopotential/orography #98
• Add integration testing #102