Installation¶

Supported Platforms¶

If you need support for an unsupported platform, please create an issue.

Install μfem package¶

To install μfem you ensure that your platform is supported with Python and pip installed. We also recommend that you first create a separate Python virtual environment with:

    python -m venv ~/mufem-env

Here we assume that the environment data will be stored in the mufem-env folder in your home directory. To activate the newly created Python environment run the following command:

    source ~/mufem-env/activate

μfem provides a Python package hosted on PyPI which can be installed using pip:

    pip install mufem

It is also highly recommended to install some additional Python libraries (e.g. required to run the validation suite) with:

   pip install numpy matplotlib gmsh

Once the installation has been completed a case file can be executed using the following command:

   pymufem case.py

The command pymufem will launch the case in parallel mode using MPI. If you want to launch it in serial mode, you can use python3 case.py command.