work on documentation

anemoi/datasets/__init__.py

@@ -5,4 +5,9 @@
 # granted to it by virtue of its status as an intergovernmental organisation
 # nor does it submit to any jurisdiction.
 
+from .data import MissingDateError
+from .data import open_dataset
+
 __version__ = "0.1.0"
+
+__all__ = ["open_dataset", "MissingDateError"]

anemoi/datasets/commands/compare.py

@@ -8,7 +8,7 @@
 # nor does it submit to any jurisdiction.
 #
 
-from anemoi.datasets.data import open_dataset
+from anemoi.datasets import open_dataset
 
 from . import Command
 

anemoi/datasets/commands/inspect/zarr.py

@@ -16,7 +16,7 @@
 import semantic_version
 import tqdm
 
-from anemoi.datasets.data import open_dataset
+from anemoi.datasets import open_dataset
 from anemoi.datasets.data.stores import open_zarr
 from anemoi.datasets.utils.humanize import bytes
 from anemoi.datasets.utils.humanize import number

anemoi/datasets/create/loaders.py

@@ -14,7 +14,7 @@
 import numpy as np
 import zarr
 
-from anemoi.datasets.data import open_dataset
+from anemoi.datasets import open_dataset
 from anemoi.datasets.utils.dates.groups import Groups
 
 from .check import DatasetName

docs/examples.rst

@@ -4,8 +4,6 @@
  Examples
 ##########
 
-Here is a list of example notebooks to illustrate how to access data,
-create plots, and do machine learning using CliMetLab.
 
 .. toctree::
    :maxdepth: 2

docs/using/combining.rst

@@ -22,6 +22,8 @@ chronological order with no gaps between them.
 
 .. code:: python
 
+   from anemoi.datasets import open_dataset
+
    ds = open_dataset(
        "aifs-ea-an-oper-0001-mars-o96-1940-1978-1h-v2",
        "aifs-ea-an-oper-0001-mars-o96-1979-2022-1h-v2",
@@ -70,12 +72,16 @@ Please note that you can join more than two ``zarr`` files.
 
 .. code:: python
 
-   open_dataset(ensembles=[dataset1, dataset2, ...])
+   from anemoi.datasets import open_dataset
+
+   ds = open_dataset(ensembles=[dataset1, dataset2, ...])
 
 *******
  grids
 *******
 
 .. code:: python
 
-   open_dataset(grids=[dataset1, dataset2, ...], method=...)
+   from anemoi.datasets import open_dataset
+
+   ds = open_dataset(grids=[dataset1, dataset2, ...], method=...)

docs/using/introduction.rst

@@ -21,7 +21,7 @@ To open a dataset, you can use the `open_dataset` function.
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset("path/to/dataset.zarr")
 
@@ -43,7 +43,7 @@ to subset or combine datasets.
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset("path/to/dataset.zarr", start=2000, end=2020)
 
@@ -53,7 +53,7 @@ the `open_dataset` function:
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset("path/to/dataset1.zarr", "path/to/dataset2.zarr")
 

docs/using/opening.rst

@@ -6,15 +6,15 @@
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset("path/to/dataset.zarr", option1=value1, option2=value2, ...)
 
 or
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset(combine=["path/to/dataset1.zarr",
                               "path/to/dataset2.zarr", ...])
@@ -23,7 +23,7 @@ or
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset(combine=["path/to/dataset1.zarr",
                               "path/to/dataset2.zarr", ...],
@@ -38,7 +38,7 @@ The term `combine` is one of `join`, `concat`, `ensembles`, etc. See
 
 .. code:: python
 
-   from anemoi_datasets import open_dataset
+   from anemoi.datasets import open_dataset
 
    ds = open_dataset(combine=[{"dataset": "path/to/dataset1.zarr",
                                "option1"=value1, "option2"=value2, ...},

tests/create/test_create.py

@@ -19,8 +19,8 @@
 import requests
 from climetlab import load_source
 
+from anemoi.datasets import open_dataset
 from anemoi.datasets.create import Creator
-from anemoi.datasets.data import open_dataset
 from anemoi.datasets.data.stores import open_zarr
 
 TEST_DATA_ROOT = "https://object-store.os-api.cci1.ecmwf.int/ml-tests/test-data/anemoi-datasets/create/"

tests/test_data.py

@@ -13,7 +13,7 @@
 import numpy as np
 import zarr
 
-from anemoi.datasets.data import open_dataset
+from anemoi.datasets import open_dataset
 from anemoi.datasets.data.concat import Concat
 from anemoi.datasets.data.ensemble import Ensemble
 from anemoi.datasets.data.grids import Grids