Skip to content

Commit

Permalink
Merge pull request #194 from sjboeing/readme_changes_ralph
Browse files Browse the repository at this point in the history
Changes to the README, mostly on the CDS data store
  • Loading branch information
sjboeing authored Jan 10, 2023
2 parents baae769 + 47a4eb9 commit 767851f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## [Unreleased]

*improvements*

- Provide information on CDS and its API in the README file
[\#194](https://github.com/EUREC4A-UK/lagtraj/pull/194) @sjboeing

## [v0.1.2](https://github.com/EUREC4A-UK/lagtraj/tree/v0.1.2)

[Full Changelog](https://github.com/EUREC4A-UK/lagtraj/compare/v0.1.1...v0.1.2)
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ spatial extent that a trajectory will reach must been known before performining
a trajectory integration*, otherwise `lagtraj` will issue a warning when the
edge of the available domain is reached.

In order to download the ERA5 input data for `lagtraj`, you need an account with
the Copernicus Data Store. You will also need to install the CDS api, see the [api-howto](https://cds.climate.copernicus.eu/api-how-to).

Either create your own domain definition in `data/domains/<domain_name>.yaml` and run

```bash
Expand All @@ -131,13 +134,16 @@ Or use one of the domain definitions included with `lagtraj` (e.g.
```bash
$> python -m lagtraj.domain.download lagtraj://eurec4a_circle <start_date> <end_date>
```
the `<start_date>` and `<end_date>` should be formatted as `YYYY/MM/DD`, e.g. `2020/02/01` for the 2nd of February 2020.
the `<start_date>` and `<end_date>` should be formatted as `YYYY/MM/DD`, e.g. `2020/02/02` for the 2nd of February 2020.

An optional flag `--retry-rate <num_minutes>` causes `lagtraj` to continue
retrying download of submitted data requests every `num_minutes` minutes until
all data has been downloaded. Every time this command is run it will attempt to
download only data not yet downloaded.

You can monitor the status of your requests via the [CDS requests page](https://cds.climate.copernicus.eu).
Download times for model level data on the CDS can be somewhat variable.

## 2. Producing a trajectory

Once you have downloaded the required domain data you can either create
Expand Down

0 comments on commit 767851f

Please sign in to comment.