From b48131fd32df06b89ef971cbec22fc65bb68ae44 Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Sat, 16 Mar 2024 11:03:37 +0000 Subject: [PATCH] progress --- docs/datasets/options.rst | 70 +++++++++++++++++++++++++++++++++++++++ docs/index.rst | 2 ++ 2 files changed, 72 insertions(+) create mode 100644 docs/datasets/options.rst diff --git a/docs/datasets/options.rst b/docs/datasets/options.rst new file mode 100644 index 0000000..a2f7bed --- /dev/null +++ b/docs/datasets/options.rst @@ -0,0 +1,70 @@ +######### + Options +######### + +********* + Options +********* + +dataset +======= + +start +===== + +end +=== + +frequency +========= + +select +====== + +drop +==== + +reorder +======= + +rename +====== + +.. code:: python + + open_dataset(dataset, rename={"old_name": "new_name", ...}) + +statistics +========== + +.. code:: python + + open_dataset(dataset, statistics=other_dataset) + +thinning +======== + +.. code:: python + + open_dataset(dataset, thinning=..., method="every-nth") + +area +==== + +*********** + Combining +*********** + +ensembles +========= + +.. code:: python + + open_dataset(ensembles=[dataset1, dataset2, ...]) + +grids +===== + +.. code:: python + + open_dataset(grids=[dataset1, dataset2, ...], method=...) diff --git a/docs/index.rst b/docs/index.rst index 598bc1e..9b69a7b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -66,6 +66,7 @@ and Zarr_. - :doc:`datasets/using` - :doc:`datasets/sources` - :doc:`datasets/filters` +- :doc:`/datasets/options` .. toctree:: :maxdepth: 1 @@ -77,6 +78,7 @@ and Zarr_. datasets/using datasets/sources datasets/filters + datasets/options ********* License