Installation
============

To install mufem you will need `Python <https://www.python.org/>`_ version 3.12 installed and pip. We also recommend that you first
create a separate Python virtual environment with:

.. code-block:: bash

   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:

.. code-block:: bash

   source ~/mufem-env/activate


`μfem <https://pypi.org/project/mufem/>`_ provides a Python package hosted on `PyPI <https://pypi.org/>`_ which can be installed using pip:

.. code-block:: bash

   pip install mufem

Note that currently only a limited subset of platforms and Python versions are supported. For details, visit
`μfem's project page <https://pypi.org/project/mufem/>`_.
It is also highly recommended to install some additional Python libraries (e.g. required to run the
`validation suite <https://github.com/Raiden-Numerics/mufem-release>`_) with:

.. code-block:: bash

   pip install numpy matplotlib


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

.. code-block:: bash

   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.

If you need support for an unsupported platform, `please create an issue <https://github.com/Raiden-Numerics/mufem-release/issues>`_.