Skip to content

Commit

Permalink
added fenicsx installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
RemDelaporteMathurin committed Nov 6, 2024
1 parent a9d8980 commit c99a135
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,22 @@ To upgrade FESTIM to the latest version, run::

To uninstall FESTIM, run::

pip uninstall FESTIM
pip uninstall FESTIM


Installing the ``fenicsx`` branch version
-------------------------------------------

This version of FESTIM is under development and is not yet available on PyPI.
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``::

conda create -n festim-env
conda activate festim-env
conda install -c conda-forge fenics-dolfinx

Install the correct FESTIM version with::

pip install git+https://github.com/FESTIM-dev/FESTIM@fenicsx

0 comments on commit c99a135

Please sign in to comment.