docs: Improve installation docs (ecmwf#91)

* docs: Improve installation docs

Author: HCookie

graphs/docs/index.rst

@@ -77,14 +77,9 @@ To install the package, you can use the following command:
 
 .. code:: bash
 
-   pip install anemoi-graphs[...options...]
+   pip install anemoi-graphs
 
-The options are:
-
--  ``dev``: install the development dependencies
--  ``docs``: install the dependencies for the documentation
--  ``test``: install the dependencies for testing
--  ``all``: install all the dependencies
+Get more information in the :ref:`installing <installing>` section.
 
 **************
  Contributing
@@ -136,6 +131,7 @@ You may also have to install pandoc on MacOS:
 
    overview
    cli/introduction
+   installing
 
 .. toctree::
    :maxdepth: 1

graphs/docs/installing.rst

@@ -0,0 +1,67 @@
+############
+ Installing
+############
+
+****************
+ Python Version
+****************
+
+-  Python (> 3.9)
+
+We require at least Python 3.9.
+
+**************
+ Installation
+**************
+
+Environments
+============
+
+We currently do not provide a conda build of anemoi-graphs so the
+suggested installation is through Python virtual environments.
+
+For linux the process to make and use a venv is as follows,
+
+.. code:: bash
+
+   python -m venv /path/to/my/venv
+   source /path/to/my/venv/bin/activate
+
+Instructions
+============
+
+To install the package, you can use the following command:
+
+.. code:: bash
+
+   python -m pip install anemoi-graphs
+
+We also maintain other dependency sets for different subsets of
+functionality:
+
+.. code:: bash
+
+   python -m pip install "anemoi-graphs[docs]" # Install optional dependencies for generating docs
+
+.. literalinclude:: ../../pyproject.toml
+   :language: toml
+   :start-at: [project.optional-dependencies.all]
+   :end-before: [project.urls.Changelog]
+
+**********************
+ Development versions
+**********************
+
+To install the most recent development version, install from github:
+
+.. code::
+
+   $ python -m pip install git+https://github.com/ecmwf/anemoi-core.git#subdirectory=graphs
+
+*********
+ Testing
+*********
+
+To run the test suite after installing anemoi-graphs, install (via pypi)
+`py.test <https://pytest.org>`__ and run ``pytest`` in the ``graphs``
+directory of the anemoi-core repository.

models/docs/installing.rst

@@ -2,25 +2,66 @@
  Installing
 ############
 
-To install the package, you can use the following command:
+****************
+ Python Version
+****************
 
-.. code:: bash
+-  Python (> 3.9)
 
-   pip install anemoi-models
+We require at least Python 3.9.
 
 **************
- Contributing
+ Installation
 **************
 
+Environments
+============
+
+We currently do not provide a conda build of anemoi-models so the
+suggested installation is through Python virtual environments.
+
+For linux the process to make and use a venv is as follows,
+
+.. code:: bash
+
+   python -m venv /path/to/my/venv
+   source /path/to/my/venv/bin/activate
+
+Instructions
+============
+
+To install the package, you can use the following command:
+
 .. code:: bash
 
-   git clone ...
-   cd anemoi-models
-   pip install .[dev]
-   pip install -r docs/requirements.txt
+   python -m pip install anemoi-models
 
-You may also have to install pandoc on MacOS:
+We also maintain other dependency sets for different subsets of
+functionality:
 
 .. code:: bash
 
-   brew install pandoc
+   python -m pip install "anemoi-models[docs]" # Install optional dependencies for generating docs
+
+.. literalinclude:: ../../pyproject.toml
+   :language: toml
+   :start-at: [project.optional-dependencies.all]
+   :end-before: [project.urls.Changelog]
+
+**********************
+ Development versions
+**********************
+
+To install the most recent development version, install from github:
+
+.. code::
+
+   $ python -m pip install git+https://github.com/ecmwf/anemoi-core.git#subdirectory=models
+
+*********
+ Testing
+*********
+
+To run the test suite after installing anemoi-models, install (via pypi)
+`py.test <https://pytest.org>`__ and run ``pytest`` in the ``models``
+directory of the anemoi-core repository.

training/docs/start/installing.rst

@@ -2,8 +2,68 @@
  Installing
 ############
 
+****************
+ Python Version
+****************
+
+-  Python (3.9 to 3.12)
+
+We require at least Python 3.9, and currently do not support >3.12. This
+is due to an issue with one of the required dependencies.
+
+**************
+ Installation
+**************
+
+Environments
+============
+
+We currently do not provide a conda build of anemoi-training so the
+suggested installation is through Python virtual environments.
+
+For linux the process to make and use a venv is as follows,
+
+.. code:: bash
+
+   python -m venv /path/to/my/venv
+   source /path/to/my/venv/bin/activate
+
+Instructions
+============
+
 To install the package, you can use the following command:
 
 .. code:: bash
 
-   pip install anemoi-training
+   python -m pip install anemoi-training
+
+We also maintain other dependency sets for different subsets of
+functionality:
+
+.. code:: bash
+
+   python -m pip install "anemoi-training[profile]" # Install optional dependencies for profiling gpu usage
+   python -m pip install "anemoi-training[docs]" # Install optional dependencies for generating docs
+
+.. literalinclude:: ../../pyproject.toml
+   :language: toml
+   :start-at: [project.optional-dependencies.all]
+   :end-before: [project.urls.Changelog]
+
+**********************
+ Development versions
+**********************
+
+To install the most recent development version, install from github:
+
+.. code::
+
+   $ python -m pip install git+https://github.com/ecmwf/anemoi-core.git#subdirectory=training
+
+*********
+ Testing
+*********
+
+To run the test suite after installing anemoi-training, install (via
+pypi) `py.test <https://pytest.org>`__ and run ``pytest`` in the
+``training`` directory of the anemoi-core repository.

training/pyproject.toml

@@ -63,12 +63,10 @@ dependencies = [
 ]
 
 optional-dependencies.all = [  ]
-
 optional-dependencies.dev = [
   "anemoi-training[docs,tests,all]",
   "pre-commit>=3.3.3",
 ]
-
 optional-dependencies.docs = [
   "nbsphinx",
   "pandoc",
@@ -82,9 +80,7 @@ optional-dependencies.profile = [
   "rich>=13.6",
   "tabulate>=0.9",
 ]
-
 optional-dependencies.tests = [ "hypothesis", "pytest", "pytest-mock" ]
-
 urls.Changelog = "https://github.com/ecmwf/anemoi-training/CHANGELOG.md"
 urls.Documentation = "https://anemoi-training.readthedocs.io/"
 urls.Homepage = "https://github.com/ecmwf/anemoi-training/"