Skip to content

Commit 1428092

Browse files
improved installation instructions (#1113)
1 parent 601a9d9 commit 1428092

1 file changed

Lines changed: 44 additions & 5 deletions

File tree

docs/source/installation.rst

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ Installation
33
============
44

55

6-
FEniCSx can be installed with Anaconda on MacOs and Linux.
7-
In order to use the Anaconda distribution on Windows,
8-
use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
6+
Because the main dependency FEniCSx (dolfinx) cannot be installed natively on Windows, Windows users must use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_ (WSL). FEniCSx can be installed natively on MacOs and Linux.
97

108
.. tip::
119
You can install `WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_ by running
@@ -16,6 +14,12 @@ use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/
1614
use with Windows due to the
1715
`WSL extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl>`_.
1816

17+
18+
Option 1: Conda (Recommended)
19+
-----------------------------
20+
21+
The easiest way to install FESTIM with all its dependencies (including dolfinx) is via Conda.
22+
1923
First `install Anaconda <https://docs.continuum.io/anaconda/install>`_,
2024

2125
.. tip::
@@ -28,8 +32,43 @@ First `install Anaconda <https://docs.continuum.io/anaconda/install>`_,
2832
You can install other versions by replacing :code:`Anaconda3-2024.06-1-Linux-x86_64.sh`
2933
with another from `the official repository <https://repo.anaconda.com/archive/>`_.
3034

31-
then run the following commands::
35+
Then run the following commands to create an environment and install FESTIM::
3236

3337
conda create -n festim-env
3438
conda activate festim-env
35-
conda install -c conda-forge festim>=2.0a0
39+
conda install -c conda-forge festim
40+
41+
**Specific versions**
42+
43+
To install a specific version of FESTIM, you can specify it in the installation command::
44+
45+
conda install -c conda-forge festim=0.9.0
46+
47+
To check which version of FESTIM is currently installed, run::
48+
49+
conda list festim
50+
51+
**Nightly / development version**
52+
53+
We provide a nightly conda build via our own anaconda channel. You can install it with::
54+
55+
# Nightly / development version
56+
conda install -c festim-dev/label/nightly -c conda-forge festim
57+
58+
# Or with a pin to latest nightly
59+
conda install -c festim-dev/label/nightly -c conda-forge festim=*=nightly_*
60+
61+
62+
Option 2: Docker
63+
----------------
64+
65+
Installing the FEniCSx docker container and then installing FESTIM with pip inside it is also an option::
66+
67+
docker run -ti dolfinx/dolfinx:stable
68+
pip install festim
69+
70+
71+
Option 3: From Source
72+
---------------------
73+
74+
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 <https://docs.fenicsproject.org/>`_ for complete instructions on building dolfinx from source.

0 commit comments

Comments
 (0)