Installation#
Because the main dependency FEniCSx (dolfinx) cannot be installed natively on Windows, Windows users must use the Windows Subsystem for Linux (WSL). FEniCSx can be installed natively on MacOs and Linux.
Tip
You can install WSL by running
wsl --install on a command prompt window.
To launch into WSL, simply enter wsl.
Visual Studio Code is the recommended IDE to use with Windows due to the WSL extension.
Option 1: Conda (Recommended)#
The easiest way to install FESTIM with all its dependencies (including dolfinx) is via Conda.
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 Anaconda3-2024.06-1-Linux-x86_64.sh
with another from the official repository.
Then run the following commands to create an environment and install FESTIM:
conda create -n festim-env
conda activate festim-env
conda install -c conda-forge festim
Specific versions
To install a specific version of FESTIM, you can specify it in the installation command:
conda install -c conda-forge festim=0.9.0
To check which version of FESTIM is currently installed, run:
conda list festim
Nightly / development version
We provide a nightly conda build via our own anaconda channel. You can install it with:
# Nightly / development version
conda install -c festim-dev/label/nightly -c conda-forge festim
# Or with a pin to latest nightly
conda install -c festim-dev/label/nightly -c conda-forge festim=*=nightly_*
Option 2: Docker#
Installing the FEniCSx docker container and then installing FESTIM with pip inside it is also an option:
docker run -ti dolfinx/dolfinx:stable
pip install festim
Option 3: From Source#
When none of the above methods are possible, users can build FEniCSx from source and then install FESTIM and all dependencies manually. Please refer to the FEniCSx documentation for complete instructions on building dolfinx from source.