Installation

The recommended installation method is an editable installation after cloning or copying the repository. To keep dependencies clean, the use of virtual environments is encouraged. Here, we will demonstrate the process for conda/mamba and pip.

See here for detailed installation instructions for micromamba, a lightweight method to manage both python interpreters and their packages.

For example, starting from a unix-like shell, we can download micromamba:

cd /path/to/persistent/storage/
"${SHELL}" <(curl -L micro.mamba.pm/install.sh)

Maybe create a quicker alias for the micromamba binary just installed or add that to a bashrc file if using:

alias mamba=$(echo $(pwd)/micromamba/bin/micromamba)
# or:
echo "alias mamba=$(echo $(pwd)/micromamba/bin/micromamba)" >> ~/.bashrc

Now create a new environment with the project dependencies:

cd /path/to/matmdl/
mamba create -n opt python=3.11 --file requirements.txt

Then activate the new environement and install this repository in editable mode:

mamba activate opt
pip install --no-build-isolation --no-deps -e .

If you want to build the docs, install the additional dependencies, then build in the documentation folder:

pip install -e '.[doc]'
cd documentation
mkdocs build