Installation¶

Licensing

The Community tier is free for academic and commercial use. If you install or use mufem, you agree to the Terms of Service. See Licensing for the paid tiers.

Supported Platforms¶

Architecture	Operating System	Python Version
x86-64	Linux	3.12, 3.13, 3.14
x86-64	Windows	Unsupported
aarch64	macOS	Unsupported

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

Install mufem package¶

Before you install mufem, make sure your platform is supported. Also install Python and pip. We also recommend that you first create a separate Python virtual environment with:

    python -m venv ~/mufem-env

This stores the environment data in the mufem-env folder in your home directory. To activate the new Python environment, run this command:

    source ~/mufem-env/bin/activate

mufem is a Python package on PyPI. Install it with pip:

    pip install mufem

We also recommend that you install some more Python libraries. You need these to run the validation suite:

   pip install numpy matplotlib gmsh

After the installation completes, run a case file with this command:

   pymufem case.py

The pymufem command launches the case in parallel mode with MPI. To launch it in serial mode, use the python3 case.py command.