Skip to content

Commit 00c9fcd

Browse files
committed
work on documentation
1 parent 32d2e3f commit 00c9fcd

File tree

3 files changed

+22
-6
lines changed

3 files changed

+22
-6
lines changed

docs/examples.rst

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
Examples
55
##########
66

7-
87
.. toctree::
98
:maxdepth: 2
109
:glob:

docs/using/combining.rst

+18-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,24 @@ Please note that you can join more than two ``zarr`` files.
8787
8888
from anemoi.datasets import open_dataset
8989
90-
ds = open_dataset(grids=[dataset1, dataset2, ...], method=...)
90+
ds = open_dataset(grids=[dataset1, dataset2, ...], mode=...)
91+
92+
The values for ``mode`` are:
93+
94+
concatenate
95+
===========
96+
97+
All the grid points are concatenated, in the order they are given. The
98+
`latitudes` and `longitudes` are also concatenated.
99+
100+
cutout
101+
======
102+
103+
The `cutout` mode only supports two datasets. The first dataset is the
104+
considered to be a limited area model (LAM), while the second one is
105+
considered to be a global model or boundary conditions. It is therefore
106+
expected that the bounding box of the first dataset is contained within
107+
the bounding box of the second dataset.
91108

92109
.. image:: cutout-1.png
93110
:width: 75%

docs/using/grids.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ So for 2D fields, the thinning will apply to both the latitude and
2323
longitude dimensions. For 1D fields, such as reduced Gaussian grids, the
2424
thinning will apply to the only dimension.
2525

26-
The following example shows the effect of thinning a dataset with a 1 degree
27-
resolution:
26+
The following example shows the effect of thinning a dataset with a 1
27+
degree resolution:
2828

2929
.. image:: thinning-before.png
3030
:width: 75%
3131
:align: center
3232

33-
Thinning the dataset with ``thinning=4`` will result in the following dataset:
33+
Thinning the dataset with ``thinning=4`` will result in the following
34+
dataset:
3435

3536
.. image:: thinning-after.png
3637
:width: 75%
3738
:align: center
3839

39-
4040
******
4141
area
4242
******

0 commit comments

Comments
 (0)