Skip to content

Commit

Permalink
Doc/update doc (ecmwf#71)
Browse files Browse the repository at this point in the history
* update doc
  • Loading branch information
b8raoult authored Oct 4, 2024
1 parent 83d8d8f commit 39594dc
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/building/filters/yaml/rename.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
rename:
param:
from: "old"
to: "new"
2 changes: 2 additions & 0 deletions docs/building/sources/netcdf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@

.. literalinclude:: yaml/netcdf.yaml
:language: yaml

.. include:: xarray-based.rst
10 changes: 10 additions & 0 deletions docs/building/sources/repeated_dates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,21 @@
repeated_dates
################

The `repeated_dates` source is used to repeat a single source multiple
times, so that its data is present at multiple dates. A simple example
of this is when you have source that contains a constant field, such as
orography or bathymetry, that you want to have repeated at all the dates
of the dataset.

The generale format of the `repeated_dates` source is:

.. literalinclude:: yaml/repeated_dates1.yaml
:language: yaml

where ``source`` is any of the :ref:`operations <operations>` or
:ref:`sources <sources>` described in the previous sections. The
``mode`` parameter can be one of the following:

**********
constant
**********
Expand Down
13 changes: 13 additions & 0 deletions docs/building/sources/xarray-based.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This source uses Xarray_ internally to access the data, and assumes that
it follows the `CF conventions`_.

You specify any valid xarray.open_dataset_ arguments in the source.

.. literalinclude:: yaml/xarray-based.yaml
:language: yaml

.. _cf conventions: http://cfconventions.org/

.. _xarray: https://docs.xarray.dev/en/stable/index.html

.. _xarray.open_dataset: https://docs.xarray.dev/en/stable/generated/xarray.open_dataset.html
2 changes: 1 addition & 1 deletion docs/building/sources/xarray-kerchunk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
xarray-kerchunk
#################

.. literalinclude:: xarray-kerchunk.yaml
.. literalinclude:: yaml/xarray-kerchunk.yaml
:language: yaml

The code below is inspired by the `kerchunk tutorial`_, and makes use of
Expand Down
3 changes: 3 additions & 0 deletions docs/building/sources/yaml/xarray-based.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
input:
xarray-based-source: # netcdf, zarr, opendap, etc.
group: mygroup

0 comments on commit 39594dc

Please sign in to comment.