Merge pull request festim-dev#959 from RemDelaporteMathurin/conda-install-docs

Conda install in docs

Author: RemDelaporteMathurin

docs/source/installation.rst

@@ -2,25 +2,8 @@
 Installation
 ============
 
-FESTIM is installed in two steps:
-    1. `Installing FEniCS`_ through Anaconda or Docker
-    2. `Installing FESTIM`_ through pip on the FEniCS environment
-
-Installing FEniCS
------------------
-
-FEniCS can be installed with Anaconda on MacOs and Linux. 
-In order to use the Anaconda distribution on Windows, 
-use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_. 
-
-.. tip::
-    You can install `WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_ by running
-    :code:`wsl --install` on a command prompt window.
-    To launch into WSL, simply enter :code:`wsl`.
-
-    `Visual Studio Code <https://code.visualstudio.com/>`_ is the recommended IDE to 
-    use with Windows due to the 
-    `WSL extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl>`_.
+Installing FESTIM with Conda
+----------------------------
 
 First `install Anaconda <https://docs.continuum.io/anaconda/install>`_,
 
@@ -34,27 +17,56 @@ First `install Anaconda <https://docs.continuum.io/anaconda/install>`_,
     You can install other versions by replacing :code:`Anaconda3-2024.06-1-Linux-x86_64.sh` 
     with another from `the official repository <https://repo.anaconda.com/archive/>`_.
 
-then run the following commands::
+FESTIM can be installed with Anaconda on MacOs and Linux::
 
     conda create -n festim-env
     conda activate festim-env       
-    conda install -c conda-forge fenics numpy=1.24
+    conda install -c conda-forge festim
 
-Alternatively, It can be installed using `Docker <https://www.docker.com/>`_::
+.. tip::
 
-    docker run -ti -v $(pwd):/home/fenics/shared quay.io/fenicsproject/stable:latest
+    You can install the latest version of FESTIM by running::
 
-.. note::
-    :code:`$(pwd)` needs to be replaced by :code:`${PWD}` on Windows
+        conda install -c conda-forge festim
+
+    To install a specific version, run::
+
+        conda install -c conda-forge festim==[version]
 
+    with the desired version tag.  For example::
 
-For more information on how to install FEniCS, see `Download <https://fenicsproject.org/download/archive/>`_ on the FEniCS website.
+        conda install -c conda-forge festim==0.9
 
+    To upgrade FESTIM to the latest version, run::
 
-Installing FESTIM
------------------
+        conda install -c conda-forge festim --update-deps
 
-FESTIM can then be installed using pip::
+    To uninstall FESTIM, run::
+
+        conda uninstall festim
+
+Windows Subsystem for Linux
+----------------------------
+In order to use the Anaconda distribution on Windows, 
+use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_. 
+
+.. tip::
+    You can install `WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_ by running
+    :code:`wsl --install` on a command prompt window.
+    To launch into WSL, simply enter :code:`wsl`.
+
+    `Visual Studio Code <https://code.visualstudio.com/>`_ is the recommended IDE to 
+    use with Windows due to the 
+    `WSL extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl>`_.
+
+
+Installing FESTIM with pip
+--------------------------
+
+.. note::
+    FEniCS is required for the pip install to work. Consider installing it either with Conda, Docker, or from source.
+
+FESTIM can be installed using pip::
 
     pip install FESTIM
 
@@ -74,20 +86,35 @@ To uninstall FESTIM, run::
 
     pip uninstall FESTIM
 
+Using Docker
+------------
 
-Installing the ``fenicsx`` branch version
--------------------------------------------
+Alternatively, FESTIM can be installed using `Docker <https://www.docker.com/>`_.
 
-This version of FESTIM is under development and is not yet available on PyPI.
+First create a docker container based on the FEniCS docker image::
+
+    docker run -ti -v $(pwd):/home/fenics/shared quay.io/fenicsproject/stable:latest
+
+.. note::
+    :code:`$(pwd)` needs to be replaced by :code:`${PWD}` on Windows
+
+.. note::
+    For more information on how to install FEniCS, see `Download <https://fenicsproject.org/download/archive/>`_ on the FEniCS website.
+
+Then install FESTIM using pip (see the `Installing FESTIM with pip`_ section above).
+
+
+Installing the ``2.0-alpha`` version
+------------------------------------
+
+This version of FESTIM is not production-ready but available as an alpha version.
+This version is developed on the ``fenicsx`` branch of the FESTIM repository.
 It runs on ``dolfinx`` instead of ``fenics`` and can be installed on Linux and MacOS.
 If you are on Windows, you can use the Windows Subsystem for Linux (simply follow the instructions above).
 
-Create a conda environment with ``dolfinx``::
+Install it with Conda::
 
     conda create -n festim-env
     conda activate festim-env       
-    conda install -c conda-forge fenics-dolfinx
-
-Install the correct FESTIM version with::
+    conda install -c conda-forge festim=2.0a0
 
-    pip install git+https://github.com/FESTIM-dev/FESTIM@fenicsx