From 15675b0994bbdae526fabde1e21a8123598a0b6a Mon Sep 17 00:00:00 2001 From: Nils Brueggemann <nils.brueggemann@mpimet.mpg.de> Date: Wed, 19 Mar 2025 11:22:56 +0100 Subject: [PATCH] doc: Introduce way to install also dependencies --- doc/doc-installation.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/doc-installation.md b/doc/doc-installation.md index 9406abb..fe2afa5 100644 --- a/doc/doc-installation.md +++ b/doc/doc-installation.md @@ -19,6 +19,12 @@ cd pyicon pip install -e . ``` +For a more complete installation that includes dependencies for testing, +debugging and compiling the documentation use: +``` +pip install -e .[full] +``` + ### On an arbitrary system pyicon is developed for python 3.8 or later. Other versions might work as well but are not supported so far. @@ -37,6 +43,12 @@ cd pyicon pip install -e . ``` +For a more complete installation that includes dependencies for testing, +debugging and compiling the documentation use: +``` +pip install -e .[full] +``` + The above instructions will provide a minimum python environment that will be sufficient for most applications. However, some more advanced features might require the installation of further python packages. For a complete list of python packages that is supposed to cover all aspects can be obtained from the latest -- GitLab