anemoi-datasets 0.5.19__tar.gz → 0.5.21__tar.gz

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/.gitignore

@@ -135,3 +135,8 @@ _version.py
 *.to_upload
 tempCodeRunnerFile.python
 Untitled-*.py
+*.zip
+*.json
+*.db
+*.tgz
+_api/

anemoi_datasets-0.5.21/.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+#  jobs:
+#    pre_build:
+#    - bash docs/scripts/api_build.sh
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

anemoi_datasets-0.5.21/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+    ".": "0.5.21"
+}

anemoi_datasets-0.5.21/03-constant-fields.rst

@@ -0,0 +1,3 @@
+########################
+ Adding constant fields
+########################

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/CHANGELOG.md

@@ -8,6 +8,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Please add your functional changes to the appropriate section in the PR.
 Keep it human-readable, your future self will thank you!
 
+## [0.5.21](https://github.com/ecmwf/anemoi-datasets/compare/0.5.20...0.5.21) (2025-04-08)
+
+
+### Features
+
+* more tests ([#277](https://github.com/ecmwf/anemoi-datasets/issues/277)) ([0ea7d46](https://github.com/ecmwf/anemoi-datasets/commit/0ea7d46a61aaa4381f8eb75b2623033bd404da5b))
+
+
+### Bug Fixes
+
+* grib-index command default ([#275](https://github.com/ecmwf/anemoi-datasets/issues/275)) ([04a37d8](https://github.com/ecmwf/anemoi-datasets/commit/04a37d8a046dc6b314e9f2376c69f1824cbfa43d))
+* pin version of numcodecs ([#285](https://github.com/ecmwf/anemoi-datasets/issues/285)) ([d86f317](https://github.com/ecmwf/anemoi-datasets/commit/d86f317981a312438a19323d5d67e1b31f80cf23))
+* update version of transform ([#284](https://github.com/ecmwf/anemoi-datasets/issues/284)) ([e72cdde](https://github.com/ecmwf/anemoi-datasets/commit/e72cddedd8160a27a9e63e2581f4fcc1a91cd8b6))
+
+
+### Documentation
+
+* some cleanup ([#276](https://github.com/ecmwf/anemoi-datasets/issues/276)) ([496b82a](https://github.com/ecmwf/anemoi-datasets/commit/496b82a5e10119c1fd27a58a85d5964fcad3c7bb))
+* time interpolation example ([#274](https://github.com/ecmwf/anemoi-datasets/issues/274)) ([9d19bd6](https://github.com/ecmwf/anemoi-datasets/commit/9d19bd6bc3c8e0c25718a05d670357936ec99a8b))
+* update documentation ([#271](https://github.com/ecmwf/anemoi-datasets/issues/271)) ([85ea386](https://github.com/ecmwf/anemoi-datasets/commit/85ea38690e7e8fab4dbac5c5b4d10eafdabde766))
+
+## [0.5.20](https://github.com/ecmwf/anemoi-datasets/compare/0.5.19...0.5.20) (2025-03-31)
+
+
+### Features
+
+* interpolate nearest spatial ([#260](https://github.com/ecmwf/anemoi-datasets/issues/260)) ([e6c9af4](https://github.com/ecmwf/anemoi-datasets/commit/e6c9af48dca7292940a8b10f2804e9d456b6bccc))
+* new data sources ([#258](https://github.com/ecmwf/anemoi-datasets/issues/258)) ([708c816](https://github.com/ecmwf/anemoi-datasets/commit/708c816b80ae30781f42442e0e9d8d70fed2371c))
+* save opened anemoi_dataset ([#259](https://github.com/ecmwf/anemoi-datasets/issues/259)) ([4759dd9](https://github.com/ecmwf/anemoi-datasets/commit/4759dd9da67ece246e691eb6be4637ef6bc0b157))
+
+
+### Bug Fixes
+
+* Remove hardcoded indices and get pressure levels from keys directly ([#257](https://github.com/ecmwf/anemoi-datasets/issues/257)) ([777fbac](https://github.com/ecmwf/anemoi-datasets/commit/777fbac9fb09afd6e77ee13f8442ccbb3efb73f8))
+
+
+### Documentation
+
+* Add API Docs ([#255](https://github.com/ecmwf/anemoi-datasets/issues/255)) ([be13424](https://github.com/ecmwf/anemoi-datasets/commit/be1342400552f520b64f4f0fdb29d39ee51d81fe))
+
 ## [0.5.19](https://github.com/ecmwf/anemoi-datasets/compare/0.5.18...0.5.19) (2025-03-27)
 
 

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anemoi-datasets
-Version: 0.5.19
+Version: 0.5.21
 Summary: A package to hold various functions to support training of ML models on ECMWF data.
 Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
 License:                                  Apache License
@@ -205,6 +205,7 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
+Project-URL: Changelog, https://github.com/ecmwf/anemoi-datasets/CHANGELOG.md
 Project-URL: Documentation, https://anemoi-datasets.readthedocs.io/
 Project-URL: Homepage, https://github.com/ecmwf/anemoi-datasets/
 Project-URL: Issues, https://github.com/ecmwf/anemoi-datasets/issues
@@ -224,17 +225,22 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
 License-File: LICENSE
-Requires-Dist: anemoi-transform>=0.1.4
-Requires-Dist: anemoi-utils[provenance]>=0.4.16
+Requires-Dist: anemoi-transform>=0.1.9
+Requires-Dist: anemoi-utils[provenance]>=0.4.19
 Requires-Dist: cfunits
+Requires-Dist: numcodecs<0.16
 Requires-Dist: numpy
 Requires-Dist: pyyaml
 Requires-Dist: semantic-version
 Requires-Dist: tqdm
 Requires-Dist: zarr<=2.18.4
 Provides-Extra: all
-Requires-Dist: anemoi-datasets[create,remote,xarray]; extra == "all"
+Requires-Dist: anemoi-datasets[comparelam,create,remote,xarray]; extra == "all"
+Provides-Extra: comparelam
+Requires-Dist: prettytable; extra == "comparelam"
+Requires-Dist: termcolor; extra == "comparelam"
 Provides-Extra: create
+Requires-Dist: cachetools; extra == "create"
 Requires-Dist: earthkit-data[mars]>=0.12.4; extra == "create"
 Requires-Dist: earthkit-geo>=0.3; extra == "create"
 Requires-Dist: earthkit-meteo>=0.3; extra == "create"
@@ -244,6 +250,7 @@ Requires-Dist: pyproj>=3; extra == "create"
 Provides-Extra: dev
 Requires-Dist: anemoi-datasets[all,docs,tests]; extra == "dev"
 Provides-Extra: docs
+Requires-Dist: anemoi-datasets[all]; extra == "docs"
 Requires-Dist: nbsphinx; extra == "docs"
 Requires-Dist: pandoc; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/Makefile

@@ -19,4 +19,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	bash $(SOURCEDIR)/scripts/api_build.sh
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

anemoi_datasets-0.5.21/docs/_templates/apidoc/package.rst.jinja

@@ -0,0 +1,55 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- pkgname.split(".")[1:] | join(".") | e | heading }}
+{% else %}
+{{- pkgname.split(".")[1:] | join(" ") | e | heading }}
+{% endif %}
+
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(["anemoi", pkgname] | join("."), [""]) }}
+{% endif %}
+
+{%- if subpackages %}
+Subpackages
+-----------
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- submodule.split(".")[2:] | join(".") | e | heading(2) }}
+{% endif %}
+{{ automodule(["anemoi", submodule] | join("."), automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}

anemoi_datasets-0.5.21/docs/cli/compare-lam.rst

@@ -0,0 +1,51 @@
+.. _compare_lam_command:
+
+Compare-LAM Command
+===================
+
+Compare statistics of two datasets.
+This command compares the statistics of each variable in two datasets **only in the overlapping area** between the two.
+
+Example use cases:
+------------------
+- **Stretched Grid**
+- **Boundary LAM**
+
+In both cases, it is necessary to check the alignment between the variables of the local dataset and those of the global dataset.
+Both datasets will coexist on the same grid, and statistical coherence is essential for training stability.
+
+The `compare-lam` command outputs a table comparing dataset statistics in **HTML format**.
+Additionally, a plot of the dataset grids can be displayed and saved if requested.
+
+Usage:
+******
+.. code:: console
+
+   $ anemoi-datasets compare-lam dataset1 dataset2 -D num_dates -O outpath -R round_ndigits --selected-vars var1 var2 ... [--save-plots]
+
+Arguments:
+----------
+
+- **dataset1**: Path to the first dataset (the global dataset).
+- **dataset2**: Path to the second dataset (the LAM dataset).
+- **-D, --num-of-dates**: Number of time steps (datapoints) to compare. *(default: 10)*
+- **-O, --outpath**: Path to store the output table (and optional plots). *(default: "./")*
+- **-R, --round-of-digits**: Number of decimal places to round values to. *(default: 4)*
+- **--selected-vars**: List of variables to compare between the datasets. *(default: ["10u", "10v", "2d", "2t"])*
+- **--save-plots (optional)**: Enable this flag to save an image of the dataset grids.
+
+Example:
+--------
+
+.. code:: console
+
+   $ compare-lam aifs-ea-an-oper-0001-mars-n320-1979-2022-6h-v6.zarr metno-meps-archive-det-opendap-2p5km-2020-2023-6h-v1.zarr -D 10 -O "./" -R 4 --selected-vars 2t msl --save-plots
+
+Argparse integration:
+---------------------
+
+.. argparse::
+    :module: anemoi.datasets.__main__
+    :func: create_parser
+    :prog: anemoi-datasets
+    :path: compare-lam

anemoi_datasets-0.5.21/docs/cli/grib-index.rst

@@ -0,0 +1,24 @@
+.. _grib-index_command:
+
+Grib-index Command
+============
+
+The `grib-index` command is used to create an index file for GRIB files. The index file is then used
+by the `grib-index` :ref:`source <grib-index_source>`.
+
+The command will recursively scan the directories provided and open all the GRIB files found. It will
+then create an index file for each GRIB file, which will be used to read the data.
+
+.. code:: bash
+
+    anemoi-datasets grib-index --index index.db /path1/to/grib/files /path2/to/grib/files
+
+
+See :ref:`grib_flavour` for more information about GRIB flavours.
+
+
+.. argparse::
+    :module: anemoi.datasets.__main__
+    :func: create_parser
+    :prog: anemoi-datasets
+    :path: grib-index

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/cli/introduction.rst

@@ -20,3 +20,4 @@ The commands are:
 - :ref:`Inspect Command <Inspect_command>`
 - :ref:`Compare Command <compare_command>`
 - :ref:`Scan Command <scan_command>`
+- :ref:`Compare LAM Command <compare_lam_command>`

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/filters/orog_to_z.rst

@@ -2,7 +2,7 @@
  orog_to_z
 ###########
 
-The ``orog_to_z`` filter converts orography (in meters) to surface
+The ``orog_to_z`` filter converts orography (in metres) to surface
 geopotential height (m^2/s^2) using the equation:
 
 .. math::
@@ -10,7 +10,7 @@ geopotential height (m^2/s^2) using the equation:
    z &= g \cdot \textrm{orog}\\
    g &= 9.80665\ m \cdot s^{-1}
 
-This filter needs to follow a source that provides orography, which is
+This filter must follow a source that provides orography, which is
 replaced by surface geopotential height.
 
 .. literalinclude:: yaml/orog_to_z.yaml

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/filters/regrid.rst

@@ -3,23 +3,22 @@
 ########
 
 When building a dataset for a specific model, it is possible that the
-source grid or resolution doesn't fit the needs. In that case, it is
+source grid or resolution does not fit the needs. In that case, it is
 possible to add a filter to interpolate the data to a target grid. The
 filter is part of the ``anemoi-transform`` package. It will call the
 ``interpolate`` function from `earthkit-regrid
 <https://earthkit-regrid.readthedocs.io/en/latest/interpolate.html>`_ if
-the keys ``method``, ``in_grid`` and ``out_grid`` are provide and if a
+the keys ``method``, ``in_grid`` and ``out_grid`` are provided and if a
 `pre-generated matrix
 <https://earthkit-regrid.readthedocs.io/en/latest/inventory/index.html>`_
-exist for this tranformation. Otherwise it is possible to provide a
-``regrid matrix`` previously generate with ``anemoi-transform
-make-regrid-matrix``. The generated matrix is a NPZ file containing the
-input/output coordinates, the indices and the weights of the
+exists for this transformation. Otherwise, it is possible to provide a
+``regrid matrix`` previously generated with ``anemoi-transform
+make-regrid-matrix``. The generated matrix is an NPZ file containing the
+input/output coordinates, the indices, and the weights of the
 interpolation.
 
-``regrid`` is a :ref:`filter <filters>` that needs to follow a
-:ref:`source <sources>` or another filter in a :ref:`building-pipe`
-operation.
+``regrid`` is a :ref:`filter <filters>` that must follow a :ref:`source
+<sources>` or another filter in a :ref:`building-pipe` operation.
 
 .. literalinclude:: yaml/regrid1.yaml
    :language: yaml

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/filters/rename.rst

@@ -3,10 +3,10 @@
 ########
 
 When combining several sources, it is common to have different values
-for a given attribute to represents the same concept. For example,
+for a given attribute to represent the same concept. For example,
 ``temperature_850hPa`` and ``t_850`` are two different ways to represent
-the temperature at 850 hPa. The ``rename`` filter allows to rename a key
-to another key. It is a :ref:`filter <filters>` that needs to follow a
+the temperature at 850 hPa. The ``rename`` filter allows renaming a key
+to another key. It is a :ref:`filter <filters>` that must follow a
 :ref:`source <sources>` or another filter in a :ref:`building-pipe`
 operation.
 
@@ -15,6 +15,6 @@ operation.
 
 .. note::
 
-   The ``rename`` filter was mostly designed to rename the ``param``
+   The ``rename`` filter was primarily designed to rename the ``param``
    attribute, but any key can be renamed. The ``rename`` filter can take
    several renaming keys.

anemoi_datasets-0.5.21/docs/datasets/building/filters/sum.rst

@@ -0,0 +1,13 @@
+#####
+ sum
+#####
+
+The ``sum`` filter computes the sum over multiple variables. This can be
+useful for computing total precipitation from its components (snow,
+rain) or summing the components of total column-integrated water. This
+filter must follow a source that provides the list of variables to be
+summed up. These variables are removed by the filter and replaced by a
+single summed variable.
+
+.. literalinclude:: yaml/sum.yaml
+   :language: yaml

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/filters/wz_to_w.rst

@@ -4,8 +4,8 @@
 
 The ``wz_to_w`` filter converts geometric vertical velocity (provided in
 m/s) to vertical velocity in pressure coordinates (Pa/s). This filter
-needs to follow a source that provides geometric vertical velocity.
-Geometric vertical velocity is removed by the filter and pressure
+must follow a source that provides geometric vertical velocity.
+Geometric vertical velocity is removed by the filter, and pressure
 vertical velocity is added.
 
 .. literalinclude:: yaml/wz_to_w.yaml

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/orog_to_z.yaml

@@ -0,0 +1,11 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+      # Must load an orography variable
+
+  - orog_to_z:
+      orog: orog # Name of orography (input) variable
+      z: z # Name of z (output) variable

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/regrid1.yaml

@@ -0,0 +1,11 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+
+  - regrid:
+      method: nearest
+      in_grid: o32
+      out_grid: o48

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/regrid2.yaml

@@ -0,0 +1,9 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+
+  - regrid:
+      matrix: /path/to/regrid/matrix.npz

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/rename.yaml

@@ -0,0 +1,13 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+
+  - rename:
+      param:
+        # Map old `param` names to new ones
+        temperature_2m: 2t
+        temperature_850hPa: t_850
+        # ...

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/sum.yaml

@@ -0,0 +1,15 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+      # Must load the variables to be summed
+
+  - sum:
+      params:
+      # List of input variables
+      - variable1
+      - variable2
+      - variable3
+      output: variable_total # Name of output variable

anemoi_datasets-0.5.21/docs/datasets/building/filters/yaml/wz_to_w.yaml

@@ -0,0 +1,11 @@
+input:
+  pipe:
+  - source:
+      # mars, grib, netcdf, etc.
+      # source attributes here
+      # ...
+      # Must load geometric vertical velocity
+
+  - wz_to_w:
+      wz: wz # Name of geometric vertical velocity (input) variable
+      x: z # Name of pressure vertical velocity (output) variable

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/filters.rst

@@ -6,7 +6,7 @@
 
 .. warning::
 
-   This is still a work in progress. Some of the filters may be renamed
+   This is still a work-in-progress. Some of the filters may be renamed
    later.
 
 Filters are used to modify the data or metadata in a dataset.

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/handling-missing-dates.rst

@@ -6,7 +6,8 @@ By default, the package will raise an error if there are missing dates.
 
 Missing dates can be handled by specifying a list of dates in the
 configuration file. The dates should be in the same format as the dates
-in the time series. The missing dates will be filled ``np.nan`` values.
+in the time series. The missing dates will be filled with ``np.nan``
+values.
 
 .. literalinclude:: ../yaml/missing_dates.yaml
    :language: yaml

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/handling-missing-values.rst

@@ -9,8 +9,8 @@ complete data in all fields.
 
 However, there are scenarios where `NaNs` naturally occur, such as with
 variables only relevant on land or at sea. This happens for sea surface
-temperature (`sst`), for example. In such cases, the default behavior is
-to reject data with `NaNs` as invalid. To accommodate `NaNs` and
+temperature (`sst`), for example. In such cases, the default behaviour
+is to reject data with `NaNs` as invalid. To accommodate `NaNs` and
 accurately compute statistics based on them, you can include the
 ``allow_nans`` key in the configuration.
 

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/incremental.rst

@@ -54,7 +54,7 @@ concurrent writes.
 
 Once you have loaded all the parts, you can finalise the dataset with
 the `finalise` command. This will write the metadata and the attributes
-to the dataset, and consolidate the statistics and cleanup some
+to the dataset, and consolidate the statistics and clean up some
 temporary files.
 
 .. code:: bash

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/introduction.rst

@@ -11,7 +11,7 @@ fields as well as the operations to perform on them, before they are
 written to a zarr file. The input of the process is a range of dates and
 some options to control the layout of the output. Statistics will be
 computed as the dataset is built, and stored in the metadata, with other
-information such as the the locations of the grid points, the list of
+information such as the locations of the grid points, the list of
 variables, etc.
 
 .. figure:: ../../_static/schemas/recipe.png
@@ -27,7 +27,7 @@ date
    not just a date. A training dataset covers a continuous range of
    dates with a given frequency. Missing dates are still part of the
    dataset, but missing data are marked as such using NaNs. Dates are
-   always in UTC, and refer to date at which the data is valid. For
+   always in UTC, and refer to the date at which the data is valid. For
    accumulations and fluxes, that would be the end of the accumulation
    period.
 
@@ -44,9 +44,9 @@ field
 
 source
    The `source` is a software component that, given a list of dates and
-   variables will return the corresponding fields. An example of source
-   is ECMWF's MARS archive, a collection of GRIB or NetCDF files, a
-   database, etc. See :ref:`sources` for more information.
+   variables, will return the corresponding fields. An example of a
+   source is ECMWF's MARS archive, a collection of GRIB or NetCDF files,
+   a database, etc. See :ref:`sources` for more information.
 
 filter
    A `filter` is a software component that takes as input the output of
@@ -69,13 +69,13 @@ join
 pipe
    The pipe is the process of transforming fields using filters. The
    first step of a pipe is typically a source, a join, or another pipe.
-   This can subsequently followed by more filters.
+   This can subsequently be followed by more filters.
 
 concat
    The concatenation is the process of combining different sets of
    operations that handle different dates. This is typically used to
    build a dataset that spans several years, when several sources are
-   involved, each providing data for different period.
+   involved, each providing data for a different period.
 
 Each operation is considered as a :ref:`source <sources>`, therefore
 operations can be combined to build complex datasets.

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/naming-conventions.rst

@@ -5,17 +5,17 @@
 ############################
 
 A dataset name is a string used to identify a dataset. It is designed to
-be human readable and is *not* designed to be parsed and splitted into
+be human-readable and is *not* designed to be parsed and split into
 parts.
 
 To ensure consistency, a dataset name should follow the following rules:
 
    -  All lower case.
-   -  Only letters and numbers and dashes ``-`` are allowed.
-   -  No underscore ``_`` and no dot ``.`` and no upper case letter and
-      no other special character (``@``, ``#``, ``*`` etc.).
+   -  Only letters, numbers, and dashes ``-`` are allowed.
+   -  No underscores ``_``, no dots ``.``, no uppercase letters, and no
+      other special characters (``@``, ``#``, ``*``, etc.).
 
-Additionlly, a dataset name is built from different parts joined with
+Additionally, a dataset name is built from different parts joined with
 ``-`` as follows (each part can contain additional ``-``):
 
 .. code::
@@ -24,12 +24,12 @@ Additionlly, a dataset name is built from different parts joined with
 
 .. note::
 
-   This is the current naming conventions for datasets in the Anemoi
+   This is the current naming convention for datasets in the Anemoi
    registry. It will need to be updated and adapted as more datasets are
    added. The part **purpose** is especially difficult to define for
    some datasets and may be revisited.
 
-The tables below provides more details and some examples.
+The tables below provide more details and some examples.
 
 .. list-table:: Dataset naming conventions
    :widths: 20 80
@@ -41,7 +41,7 @@ The tables below provides more details and some examples.
    -  -  **purpose**
 
       -  Can be `aifs` because the data is used to train the AIFS model.
-         Is also sometime `metno` for data from the Norwegian
+         It is also sometimes `metno` for data from the Norwegian
          Meteorological Institute. This definition may need to be
          revisited.
 
@@ -69,7 +69,7 @@ The tables below provides more details and some examples.
    -  -  **end-year**
 
       -  2020 if the first validity time is in 2020. Notice that if the
-         dataset is from 18.04.2020 to 19.07.2020, the star-year and
+         dataset is from 18.04.2020 to 19.07.2020, the start-year and
          end-year are both 2020. For instance in
          aifs-od-an-oper-0001-mars-o96-2020-2020-6h-v5
 
@@ -88,7 +88,7 @@ The tables below provides more details and some examples.
 
       -  Experimental datasets can have additional text in the name.
          This extra string can contain additional `-`. It provides
-         additional information about the content of dataset.
+         additional information about the content of the dataset.
 
 .. list-table:: Examples
    :widths: 100

{anemoi_datasets-0.5.19 → anemoi_datasets-0.5.21}/docs/datasets/building/naming-variables.rst

@@ -1,11 +1,11 @@
 .. _naming-variables:
 
 ##################
- Naming variables
+ Naming Variables
 ##################
 
 ***************
- rename filter
+ Rename Filter
 ***************
 
 The rename filter is used to rename variables in a dataset.
@@ -13,7 +13,7 @@ The rename filter is used to rename variables in a dataset.
 .. _remapping_option:
 
 ******************
- remapping option
+ Remapping Option
 ******************
 
 TODO.