Getting Started

Installation

smash can be installed with pip on Linux, Windows or from source and supports Python versions 3.9 to 3.11.

Note

We strongly recommend using smash on Linux, particularly if you are using it on a large dataset, as Fortran parallel computation is not supported on Windows.

If you already have Python, you can install smash with:

pip install hydro-smash

Note

If you have any incompatibility issue with your system, we recommand using a virtual environment such as Anaconda.

To install smash follow the commands:

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

Import

To access smash and its functions import it in your Python code like this:

import smash

Because of a name conflict on PyPI, the distribution name (i.e. the name used in pip install, hydro-smash) is not the same as the package name (i.e. the name used to import, smash).

Tutorials

For a brief user guide to get started with smash, you can refer to the Quickstart section in the User Guide. Other in-depth functionalities and advanced optimization techniques are also included in this User Guide.

For detailed descriptions of the smash API, you can visit the API Reference section.

Additionally, if you’re interested in the mathematical and numerical documentation of the hydrological model operators and the tools for its calibration, including optimization tools, you can refer to the Math/Num Documentation section.