Skip to content

Commit 57683e2

Browse files
updated installation instructions
1 parent 5a34726 commit 57683e2

File tree

1 file changed

+6
-49
lines changed

1 file changed

+6
-49
lines changed

docs/source/installation.rst

Lines changed: 6 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Installation
33
============
44

55
FESTIM is installed in two steps:
6-
1. `Installing FEniCS`_ through Anaconda or Docker
7-
2. `Installing FESTIM`_ through pip on the FEniCS environment
6+
1. `Installing FEniCSx`_ through Anaconda or Docker
7+
2. `Installing FESTIM`_ through pip in the FEniCS environment
88

9-
Installing FEniCS
9+
Installing FEniCSx
1010
-----------------
1111

12-
FEniCS can be installed with Anaconda on MacOs and Linux.
12+
FEniCSx can be installed with Anaconda on MacOs and Linux.
1313
In order to use the Anaconda distribution on Windows,
1414
use the `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_.
1515

@@ -38,56 +38,13 @@ then run the following commands::
3838

3939
conda create -n festim-env
4040
conda activate festim-env
41-
conda install -c conda-forge fenics numpy=1.24
42-
43-
Alternatively, It can be installed using `Docker <https://www.docker.com/>`_::
44-
45-
docker run -ti -v $(pwd):/home/fenics/shared quay.io/fenicsproject/stable:latest
46-
47-
.. note::
48-
:code:`$(pwd)` needs to be replaced by :code:`${PWD}` on Windows
49-
50-
51-
For more information on how to install FEniCS, see `Download <https://fenicsproject.org/download/archive/>`_ on the FEniCS website.
41+
conda install -c conda-forge fenics-dolfinx tqdm
5242

5343

5444
Installing FESTIM
5545
-----------------
5646

57-
FESTIM can then be installed using pip::
58-
59-
pip install FESTIM
60-
61-
Specific versions of FESTIM can be installed with::
62-
63-
pip install FESTIM==[version]
64-
65-
with the desired version tag. For example::
66-
67-
pip install FESTIM==0.9
68-
69-
To upgrade FESTIM to the latest version, run::
70-
71-
pip install --upgrade FESTIM
72-
73-
To uninstall FESTIM, run::
74-
75-
pip uninstall FESTIM
76-
77-
78-
Installing the ``fenicsx`` branch version
79-
-------------------------------------------
80-
8147
This version of FESTIM is under development and is not yet available on PyPI.
82-
It runs on ``dolfinx`` instead of ``fenics`` and can be installed on Linux and MacOS.
83-
If you are on Windows, you can use the Windows Subsystem for Linux (simply follow the instructions above).
84-
85-
Create a conda environment with ``dolfinx``::
86-
87-
conda create -n festim-env
88-
conda activate festim-env
89-
conda install -c conda-forge fenics-dolfinx tqdm
90-
91-
Install the correct FESTIM version with::
48+
FESTIM can then be installed using pip::
9249

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

0 commit comments

Comments
 (0)