more doc

ecmwf · Mar 29, 2024 · 0e928d9 · 0e928d9
1 parent 696c96c
commit 0e928d9
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 10 deletions.
diff --git a/anemoi/datasets/data/misc.py b/anemoi/datasets/data/misc.py
@@ -42,7 +42,7 @@ def load_config():
         CONFIG = {}
 
     CONFIG.setdefault("datasets", {})
-    CONFIG["datasets"].setdefault("lookup", [])
+    CONFIG["datasets"].setdefault("path", [])
     CONFIG["datasets"].setdefault("named", {})
 
     return CONFIG

diff --git a/anemoi/datasets/data/stores.py b/anemoi/datasets/data/stores.py
@@ -337,7 +337,7 @@ def zarr_lookup(name):
         return config["named"][name]
 
     tried = []
-    for location in config["lookup"]:
+    for location in config["path"]:
         if not location.endswith("/"):
             location += "/"
         full = location + name + ".zarr"

diff --git a/docs/using/configuration.rst b/docs/using/configuration.rst
@@ -4,12 +4,20 @@
  Configuration
 ###############
 
-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
+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.
 
-In that case, the *Anemoi* configuration is read from ``~/.anemoi.toml``. Below is an
-example of such a configuration:
+In that case, the *Anemoi* configuration is read from
+``~/.anemoi.toml``. Below is an example of such a configuration:
 
 .. literalinclude:: configuration.toml
    :language: toml
+
+Then, the name passed to ``open_dataset`` is used to look up for a
+possible path or URL:
+
+-  If the name is listed in the ``[datasets.named]``, the corresponding
+   path is used
+-  Otherwise suffix ``.zarr`` is added to the name and the file is
+   searched at every location listed in the ``path`` list.
diff --git a/docs/using/configuration.toml b/docs/using/configuration.toml
@@ -1,5 +1,5 @@
 [datasets]
-lookup = [
+path = [
     "/home/mlx/ai-ml/datasets/stable",
     "/home/mlx/ai-ml/datasets/experimental",
     "/home/mlx/ai-ml/datasets/testing",

diff --git a/docs/using/selecting.rst b/docs/using/selecting.rst
@@ -4,8 +4,8 @@
  Selecting variables
 #####################
 
-Selecting is the action of filtering the dataset by its second dimension (variables).
-
+Selecting is the action of filtering the dataset by its second dimension
+(variables).
 
 .. _select:
 

diff --git a/docs/using/subsetting.rst b/docs/using/subsetting.rst
@@ -4,7 +4,8 @@
  Subsetting datasets
 #####################
 
-Subsetting is the action of filtering the dataset by its first dimension (dates).
+Subsetting is the action of filtering the dataset by its first dimension
+(dates).
 
 .. _start: