Getting Started

Installation

smash can be installed via pip on Linux, macOS, or Windows, and supports Python versions 3.9 to 3.12. It can also be installed directly from its source repository on GitHub.

Note

We strongly recommend using smash on Linux or macOS, especially when working with large datasets, as Fortran parallel computation is not supported on Windows.

To install the latest released version, run:

pip install hydro-smash

To install the latest development version directly from the current main branch of the GitHub repository, use:

pip install git+https://github.com/DassHydro/smash.git

Note

If you encounter any compatibility issues with your system, we recommend using a virtual environment such as Anaconda.

To install smash with the highest supported Python version, run the following commands:

conda create -n smash python=3.12
conda activate smash
pip install hydro-smash

Import

To use smash in your Python code, import it as follows:

import smash

Note that the package name for importing (smash) differs from the distribution name used for installation (hydro-smash) due to a naming conflict on PyPI.

Tutorials

To quickly get started with smash, refer to the Quickstart section in the User Guide. This User Guide also includes examples of classical uses, in-depth functionalities and advanced optimization techniques.

For comprehensive details about the smash API, visit the API Reference section.

If you’re interested in the mathematical and numerical foundations of the hydrological model operators, as well as tools for calibration and optimization, see the Math/Num Documentation section.