Installation

Requirements

MarrmotFlow requires Python 3.8 or later and depends on several scientific Python packages:

The easiest way to install MarrmotFlow is from PyPI using pip:

pip install marrmotflow

To install the latest development version from the GitHub repository:

git clone https://github.com/kasra-keshavarz/marrmotflow.git
cd marrmotflow
pip install -e .

If you plan to contribute to MarrmotFlow or want to use the latest features, install in development mode:

git clone https://github.com/kasra-keshavarz/marrmotflow.git
cd marrmotflow
pip install -e ".[dev]"

This will install additional development dependencies including:

To build the documentation locally, install the documentation dependencies:

pip install -e ".[docs]"

This includes:

It’s recommended to install MarrmotFlow in a virtual environment to avoid conflicts with other packages:

python -m venv marrmotflow-env
source marrmotflow-env/bin/activate  # On Windows: marrmotflow-env\Scripts\activate
pip install marrmotflow

To verify that MarrmotFlow is installed correctly, you can run:

import marrmotflow
print(marrmotflow.__version__)

This should print the version number without any errors.