From 696c96c344dd3918987398f62464a8820bb965ac Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Fri, 29 Mar 2024 12:32:44 +0000 Subject: [PATCH] update documentation --- docs/using/configuration.rst | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-) diff --git a/docs/using/configuration.rst b/docs/using/configuration.rst index 9da30ab8..35d01f16 100644 --- a/docs/using/configuration.rst +++ b/docs/using/configuration.rst @@ -4,26 +4,12 @@ Configuration ############### -.. - The configuration file is a YAML +When the ``open_dataset`` function is called with a string that does +not ends with ``.zarr`` or ``.zip``, it is considered a dataset name and not +a path or a URL. -.. - file that contains a list of datasets. Each dataset is a dictionary with - -.. - a `name` key and a `path` key. The `name` key is a string that - -.. - identifies the dataset, and the `path` key is a string that contains the - -.. - path to the dataset. The `open_dataset` function looks for the dataset - -.. - name in the configuration file and opens the dataset with the - -.. - corresponding path. +In that case, the *Anemoi* configuration is read from ``~/.anemoi.toml``. Below is an +example of such a configuration: .. literalinclude:: configuration.toml :language: toml