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

You can access the latest update of the modulo python package on PyPI using the command line:

.. code-block:: 

    pip install modulo_vki

Alternatively, you can clone the repository and install the package locally:

.. code-block::
        git clone https://github.com/mendezVKI/MODULO.git 
        cd MODULO
        python setup.py install

The package requires the following dependencies:

- "tqdm",
- "numpy",
- "scipy",
- "scikit-learn",
- "ipykernel",
- "ipython",
- "ipython-genutils",
- "ipywidgets",
- "matplotlib".

To run the Jupyter notebooks, you will also need to install the Jupyter notebook package:

.. code-block::
    pip install jupyter

and the additional packages:

- "pyvista",
- "imageio",

that are specified in the `setup.py` file as optional dependencies.