Installation¶

TOAD can be installed via PyPI (recommended) or directly from the GitHub repository.

PyPI Installation (Recommended)¶

The easiest way to install TOAD is using pip:

pip install tipmip-toad

This will install TOAD along with all required dependencies.

To install the latest development version directly from GitHub:

git clone https://github.com/tipmip-methods/toad.git
cd toad
pip install .

If you plan to modify TOAD or contribute to the project, install in editable mode with development dependencies:

git clone https://github.com/tipmip-methods/toad.git
cd toad
pip install -e .[dev]

The -e flag installs the package in “editable” mode, meaning changes to the source code are immediately reflected without needing to reinstall.

TOAD requires:

Python: 3.10 or higher
Dependencies: NumPy, SciPy, scikit-learn, xarray, matplotlib, cartopy, pandas, and others (see pyproject.toml for complete list)

All dependencies are automatically installed when installing via pip.

To verify that TOAD is installed correctly, try importing it:

>>> import toad
>>> print(toad.__version__)

Once installed, proceed to the Quick Start guide to run your first TOAD analysis.