From 99e355d2b6784357910118db5c3911140a658975 Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Sun, 26 May 2024 21:00:04 +0100 Subject: [PATCH] Run formatter --- docs/index.rst | 64 ++++++++++++++++-------------------- docs/installing.rst | 38 ++++++++++----------- docs/modules/checkpoints.rst | 11 +++---- docs/modules/config.rst | 11 +++---- docs/modules/dates.rst | 11 +++---- docs/modules/grib.rst | 11 +++---- docs/modules/humanize.rst | 11 +++---- docs/modules/provenance.rst | 11 +++---- docs/modules/text.rst | 11 +++---- 9 files changed, 82 insertions(+), 97 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 3752c16..cf1660f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,57 +2,51 @@ .. _index-page: -#################################### - Welcome to Anemoi's documentation! -#################################### +Welcome to Anemoi's documentation! +================================== .. warning:: - This documentation is work in progress. + This documentation is work in progress. -*Anemoi* is a framework for developing machine learning weather -forecasting models. It comprises of components or packages for preparing -training datasets, conducting ML model training and a registry for -datasets and trained models. *Anemoi* provides tools for operational -inference, including interfacing to verification software. As a -framework it seeks to handle many of the complexities that -meteorological organisations will share, allowing them to easily train -models from existing recipes but with their own data. +*Anemoi* is a framework for developing machine learning weather forecasting models. It +comprises of components or packages for preparing training datasets, conducting ML model +training and a registry for datasets and trained models. *Anemoi* provides tools for +operational inference, including interfacing to verification software. As a framework it +seeks to handle many of the complexities that meteorological organisations will share, +allowing them to easily train models from existing recipes but with their own data. -This package provides a series of utility functions for used by the rest -of the *Anemoi* packages. +This package provides a series of utility functions for used by the rest of the *Anemoi* +packages. -- :doc:`installing` +- :doc:`installing` .. toctree:: - :maxdepth: 1 - :hidden: + :maxdepth: 1 + :hidden: - installing + installing -********* - Modules -********* +Modules +------- .. toctree:: - :maxdepth: 1 - :glob: + :maxdepth: 1 + :glob: - modules/* + modules/* -***************** - Anemoi packages -***************** +Anemoi packages +--------------- -- :ref:`anemoi-utils ` -- :ref:`anemoi-datasets ` -- :ref:`anemoi-models ` -- :ref:`anemoi-training ` -- :ref:`anemoi-inference ` +- :ref:`anemoi-utils ` +- :ref:`anemoi-datasets ` +- :ref:`anemoi-models ` +- :ref:`anemoi-training ` +- :ref:`anemoi-inference ` -********* - License -********* +License +------- *Anemoi* is available under the open source `Apache License`__. diff --git a/docs/installing.rst b/docs/installing.rst index d06080a..5e79ea7 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -1,34 +1,32 @@ -############ - Installing -############ +Installing +========== To install the package, you can use the following command: -.. code:: bash +.. code-block:: bash - pip install anemoi-utils[...options...] + pip install anemoi-utils[...options...] The options are: -- ``dev``: install the development dependencies -- ``all``: install all the dependencies -- ``text``: install the dependencies for text processing -- ``provenance``: install the dependencies for provenance tracking -- ``grib``: install the dependencies for looking up GRIB parameters +- ``dev``: install the development dependencies +- ``all``: install all the dependencies +- ``text``: install the dependencies for text processing +- ``provenance``: install the dependencies for provenance tracking +- ``grib``: install the dependencies for looking up GRIB parameters -************** - Contributing -************** +Contributing +------------ -.. code:: bash +.. code-block:: bash - git clone ... - cd anemoi-utils - pip install .[dev] - pip install -r docs/requirements.txt + git clone ... + cd anemoi-utils + pip install .[dev] + pip install -r docs/requirements.txt You may also have to install pandoc on MacOS: -.. code:: bash +.. code-block:: bash - brew install pandoc + brew install pandoc diff --git a/docs/modules/checkpoints.rst b/docs/modules/checkpoints.rst index 8253018..69c52ab 100644 --- a/docs/modules/checkpoints.rst +++ b/docs/modules/checkpoints.rst @@ -1,8 +1,7 @@ -############# - checkpoints -############# +checkpoints +=========== .. automodule:: anemoi.utils.checkpoints - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/config.rst b/docs/modules/config.rst index 1890808..f5d81c4 100644 --- a/docs/modules/config.rst +++ b/docs/modules/config.rst @@ -1,8 +1,7 @@ -######## - config -######## +config +====== .. automodule:: anemoi.utils.config - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/dates.rst b/docs/modules/dates.rst index e2686a5..6623ad4 100644 --- a/docs/modules/dates.rst +++ b/docs/modules/dates.rst @@ -1,8 +1,7 @@ -####### - dates -####### +dates +===== .. automodule:: anemoi.utils.dates - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/grib.rst b/docs/modules/grib.rst index 2ebfc6c..95ed53c 100644 --- a/docs/modules/grib.rst +++ b/docs/modules/grib.rst @@ -1,8 +1,7 @@ -###### - grib -###### +grib +==== .. automodule:: anemoi.utils.grib - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/humanize.rst b/docs/modules/humanize.rst index c54522e..3242eb8 100644 --- a/docs/modules/humanize.rst +++ b/docs/modules/humanize.rst @@ -1,8 +1,7 @@ -########## - humanize -########## +humanize +======== .. automodule:: anemoi.utils.humanize - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/provenance.rst b/docs/modules/provenance.rst index dbea096..e175e56 100644 --- a/docs/modules/provenance.rst +++ b/docs/modules/provenance.rst @@ -1,8 +1,7 @@ -############ - provenance -############ +provenance +========== .. automodule:: anemoi.utils.provenance - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/modules/text.rst b/docs/modules/text.rst index f5a4429..8e5d21f 100644 --- a/docs/modules/text.rst +++ b/docs/modules/text.rst @@ -1,8 +1,7 @@ -###### - text -###### +text +==== .. automodule:: anemoi.utils.text - :members: - :no-undoc-members: - :show-inheritance: + :members: + :no-undoc-members: + :show-inheritance: