diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 94d512037..f95f2f3aa 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -2,17 +2,42 @@ 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 ----------------- -FESTIM requires FEniCS to run. - 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 `_. -First `install Anaconda `_ then run the following commands:: +In order to use the Anaconda distribution on Windows, +use the `Windows Subsystem for Linux `_. + +.. tip:: + You can install `WSL `_ by running + :code:`wsl --install` on a command prompt window. + To launch into WSL, simply enter :code:`wsl`. + + `Visual Studio Code `_ is the recommended IDE to + use with Windows due to the + `WSL extension `_. + +First `install Anaconda `_, + +.. tip:: + + You can install Anaconda on most Linux distributions by entering:: + + curl -O https://repo.anaconda.com/archive/Anaconda3-2024.06-1-Linux-x86_64.sh + bash ./Anaconda3-2024.06-1-Linux-x86_64.sh + + You can install other versions by replacing :code:`Anaconda3-2024.06-1-Linux-x86_64.sh` + with another from `the official repository `_. + +then run the following commands:: conda create -n festim-env - conda activate festim-env + conda activate festim-env conda install -c conda-forge fenics numpy=1.24 Alternatively, It can be installed using `Docker `_::