Installation¶

You can install PyFreeFEM with pip or by cloning the sources from the gitlab repository.

Installation Requirements¶

For installing PyFreeFEM, a python executable (version >=3.6) and a recent version of FreeFEM (>=4.0) need to be installed and available from the command line.

If you don’t install PyFreeFEM with pip, you will also need to manually install the following python packages:

numpy (>=1.12.1)
scipy (>=0.19.1)
colored (>=1.3.93)
pymedit (>=1.2)

Installation with pip¶

This is the easiest way to get the latest stable version and to install python dependencies.

bash

pip install pyfreefem

Installation from the gitlab repository¶

Clone the repository using the command line prompt:

console

git clone https://gitlab.com/florian.feppon/pyfreefem.git

Then add the pyfreefem folder to your $PYTHONPATH:

bash .bashrc¶

export PYTHONPATH="$PYTHONPATH:/path/to/pyfreefem"

or install the module locally with pip:

bash

pip install -e /path/to/pyfreefem

where /path/to/pyfreefem is the directory where pyFreeFEM has been cloned.