Skip to content

Commit

Permalink
Merge pull request festim-dev#872 from rekomodo/wsl_instructions
Browse files Browse the repository at this point in the history
added WSL and Anaconda instructions
  • Loading branch information
RemDelaporteMathurin authored Aug 13, 2024
2 parents a31158c + b91960f commit c8a0c66
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
First `install Anaconda <https://docs.continuum.io/anaconda/install>`_ then run the following commands::
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>`_.

First `install Anaconda <https://docs.continuum.io/anaconda/install>`_,

.. 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 <https://repo.anaconda.com/archive/>`_.

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 <https://www.docker.com/>`_::
Expand Down

0 comments on commit c8a0c66

Please sign in to comment.