Merge pull request #91 from ANNUBS/update_installation_docs_gcroci2

docs: add pypi installation

README.md

@@ -33,8 +33,8 @@ Please note that this software is currently in its early stages of development.
   - [Overview](#overview)
   - [Table of contents](#table-of-contents)
   - [Installation](#installation)
-    - [Repository installation](#repository-installation)
     - [Pip installation](#pip-installation)
+    - [Repository installation](#repository-installation)
   - [Get started](#get-started)
     - [Generate synthetic data](#generate-synthetic-data)
     - [Train neural networks](#train-neural-networks)
@@ -44,21 +44,29 @@ Please note that this software is currently in its early stages of development.
 
 ## Installation
 
-### Repository installation
+We advise to install the package inside a virtual environment (using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [venv](https://docs.python.org/3/library/venv.html)). Make sure to create an environment containing a Python version >=3.11 and `pip` package installer.
 
-We advise to install the package inside a virtual environment (using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [venv](https://docs.python.org/3/library/venv.html)).
+After having created and activated your environment, you have two ways for installing ANNUBeS.
 
-After having created and activated your environment, to install ANNUBeS from GitHub repository, do:
+### Pip installation
+
+This is the **recommended installation for users**.
+
+```console
+pip install annubes
+```
+
+This command will install the latest version of the package [deployed on PyPI](https://pypi.org/project/annubes/).
+
+### Repository installation
 
 ```console
 git clone git@github.com:ANNUBS/annubes.git
 cd annubes
 pip install .
 ```
 
-### Pip installation
-
-Under development.
+The above commands will install the most recent version of the repository, using the default branch (main).
 
 ## Get started
 

docs/installation.md

@@ -1,17 +1,25 @@
 # Installation
 
-## Repository installation
+We advise to install the package inside a virtual environment (using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [venv](https://docs.python.org/3/library/venv.html)). Make sure to create an environment containing a Python version >=3.11 and pip package installer.
+
+After having created and activated your environment, you have two ways for installing ANNUBeS.
 
-We advise to install the package inside a virtual environment (using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) or [venv](https://docs.python.org/3/library/venv.html)).
+## Pip installation
 
-After having created and activated your environment, to install ANNUBeS from GitHub repository, do:
+This is the **recommended installation for users**.
+
+```console
+pip install annubes
+```
+
+This command will install the latest version of the package [deployed on PyPI](https://pypi.org/project/annubes/).
+
+## Repository installation
 
 ```console
 git clone git@github.com:ANNUBS/annubes.git
 cd annubes
 pip install .
 ```
 
-## PyPI installation
-
-Under development.
+The above commands will install the most recent version of the repository, using the default branch (main).