From c99a1357d9b3b3c9d71a70b6d3c8fa4a338a3725 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin <rdelaportemathurin@gmail.com> Date: Wed, 6 Nov 2024 12:50:15 -0500 Subject: [PATCH] added fenicsx installation instructions --- docs/source/installation.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 5a653a9f6..ade78d74b 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -72,4 +72,22 @@ To upgrade FESTIM to the latest version, run:: To uninstall FESTIM, run:: - pip uninstall FESTIM \ No newline at end of file + 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