doc

docs/cli/datasets.rst

@@ -2,6 +2,57 @@ datasets
 ========
 
 
+The `datasets` command is used to manage datasets in the registry.
+It can be used to register or unregister a datasets, add and remove information about a dataset, and upload it to the catalogue.
+
+
+The dataset names MUST follow the naming convention documented at <TODO ADD NAMING CONVENTION URL>.
+For instance `dataset-name` can be `aifs-ea-an-oper-0001-mars-o96-1979-2022-6h-v6`.
+
+**Register**
+
+After creating locally a new dataset (using `anemoi-datasets`), registering it in the catalogue can be done as follow:
+
+.. code-block:: bash
+
+    anemoi-registry datasets /path/to/dataset-name.zarr --register
+
+Write credentials are needed to register a dataset, and should be set in the anemoi configuration file. See :ref:`configuring` for more information.
+
+When registered, the dataset will be added to the catalogue and will be available at the url `anemoi-registry datasets dataset-name --url`.
+Using the default configuration, the url is likely to be `https://anemoi.ecmwf.int/datasets/dataset-name`, read credentials are needed to read this url,
+see :ref:`configuring` for more information.
+
+**Adding metadata**
+
+Additional information should be added to the dataset, such as the recipe used to create it, the status of the dataset,
+and the location of the dataset.
+This can be done as follow:
+
+.. code-block:: bash
+
+    anemoi-registry datasets dataset-name --set-recipe ./recipe.yaml
+    anemoi-registry datasets dataset-name --set-status experimental
+
+    # alternatively the dataset name can be replaced by the dataset path
+
+    anemoi-registry datasets /path/to/dataset-name.zarr --set-recipe ./recipe.yaml
+    anemoi-registry datasets /path/to/dataset-name.zarr --set-status experimental
+
+
+**Uploading to S3**
+
+Uploading the dataset to the catalogue to S3 can be done as follow:
+
+.. code-block:: bash
+
+    anemoi-registry datasets /path/to/dataset-name.zarr --add-location ewc --upload
+
+The credentials to upload the dataset to S3 should be set in the anemoi configuration file.
+See :ref:`configuring` for more information.
+
+
+
 .. argparse::
     :module: anemoi.registry.__main__
     :func: create_parser