Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wpreimes committed Oct 27, 2024
1 parent cf45bdf commit 893b4dc
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 5 deletions.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ DataFrame.
2024-04-05 00:00:00 0.350266 0.346558
2024-04-05 12:00:00 0.343994 0.344498
More programs are available to keep an exisiting image and time series record
up-to-date. Type ``era5 --help`` and ``era5land --help`` to see all available
programs.

CDS API Setup
=============
Expand Down
8 changes: 4 additions & 4 deletions docs/download.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Downloading ERA5 and ERA5-Land data
===================================
-----------------------------------

ERA5 (and ERA5-Land) data can be downloaded manually from the `Copernicus Data Store (CDS)
<https://cds.climate.copernicus.eu/#!/home>`_ or automatically via the CDS api,
Expand All @@ -25,9 +25,9 @@ resolution of the images is 6 hours by default, but can be changed using the
--variables swvl1,swvl2,swvl3,swvl4 --h_steps 0,6,18,24
The names of the variables to download can be its long names, the short names
(as in the example) or the parameter IDs. We use the file
``ecmwf_models/era5/era5_lut.csv`` and ``ecmwf_models/era5/era5-land_lut.csv``
to look up the right name for the CDS API.
(as in the example). See the :ref:`ERA5 variable table <variables_era5>`
and :ref:`ERA5-Land variable table <variables_era5land>` to look up the right
name for the CDS API.

By default, the command expects that you have set up your ``.cdsapirc`` file
to identify with the data store as described above. Alternatively you can pass
Expand Down
23 changes: 22 additions & 1 deletion docs/img2ts.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Conversion to time series format
================================
--------------------------------

For a lot of applications it is favorable to convert the image based format into
a format which is optimized for fast time series retrieval. This is what we
Expand Down Expand Up @@ -39,3 +39,24 @@ For all other option see the output up ``era5 reshuffle --help`` and

Conversion to time series is performed by the `repurpose package
<https://github.com/TUW-GEO/repurpose>`_ in the background.

Append new image data to existing time series
---------------------------------------------
Similar to the ``update_img`` program, we also provide programs to
simplify updating an existing time series record with newly downloaded
images via the ``era5 update_ts`` and ``era5land update_ts`` programs.
This will use the settings file created during the initial time series
conversion (with ``reshuffle``) and look for new image data in the same path
that is not yet available in the given time series record.

This option is ideally used together with the ``update_img`` program in, e.g.
a cron job, to first download new images, and then append them to their time
series counterpart.

.. code-block::
era5 update_ts /existing/ts/record
Alternatively, you can also use the ``reshuffle`` command, with a target path
that already contains time series. This will also append new data (but make sure
you use the same settings as before).
2 changes: 2 additions & 0 deletions docs/variables_era5.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _variables_era5:

ERA5 Variables
--------------

Expand Down
2 changes: 2 additions & 0 deletions docs/variables_era5land.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _variables_era5land:

ERA5-Land Variables
-------------------

Expand Down

0 comments on commit 893b4dc

Please sign in to comment.