Sovereign 8s.is mirror of standardgalactic/smash
  • Fortran 70.9%
  • Python 20.8%
  • C 7.5%
  • Meson 0.3%
  • Shell 0.2%
  • Other 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Francois Colleoni e374353a1e
Some checks failed
Code Checks / Code checks ubuntu-latest (push) Has been cancelled
Documentation / Documentation ubuntu-latest (push) Has been cancelled
Unit Tests / Unit tests ubuntu-latest py-3.10) (push) Has been cancelled
Unit Tests / Unit tests ubuntu-latest py-3.11) (push) Has been cancelled
Unit Tests / Unit tests ubuntu-latest py-3.12) (push) Has been cancelled
Unit Tests / Unit tests ubuntu-latest py-3.13) (push) Has been cancelled
Wheels / Build wheel cp310-macosx arm64 (push) Has been cancelled
Wheels / Build wheel cp311-macosx arm64 (push) Has been cancelled
Wheels / Build wheel cp312-macosx arm64 (push) Has been cancelled
Wheels / Build wheel cp313-macosx arm64 (push) Has been cancelled
Wheels / Build wheel cp310-manylinux x86_64 (push) Has been cancelled
Wheels / Build wheel cp311-manylinux x86_64 (push) Has been cancelled
Wheels / Build wheel cp312-manylinux x86_64 (push) Has been cancelled
Wheels / Build wheel cp313-manylinux x86_64 (push) Has been cancelled
Wheels / Build wheel cp310-win AMD64 (push) Has been cancelled
Wheels / Build wheel cp311-win AMD64 (push) Has been cancelled
Wheels / Build wheel cp312-win AMD64 (push) Has been cancelled
Wheels / Build wheel cp313-win AMD64 (push) Has been cancelled
MAINT: Update cibuildwheel actions from v3.1.4 to v3.4.0 (#531)
2026-03-24 08:09:09 +01:00
.github/workflows MAINT: Update cibuildwheel actions from v3.1.4 to v3.4.0 (#531) 2026-03-24 08:09:09 +01:00
doc MAINT: Update json version for release 1.2.2 (#527) 2026-03-20 09:37:05 +01:00
f90wrap MAINT: f90wrap 0.3.0 compatibility (#494) 2025-12-19 17:39:06 +01:00
smash ENH: add transformation method for descriptors (#525) 2026-03-18 12:26:11 +01:00
tapenade ENH: Add support for Windows wheel 2024-05-02 13:54:47 +02:00
.gitattributes ENC: Add a versioneer 2022-11-27 03:59:44 -08:00
.gitignore MAINT: directly remove generated files when compiling doc (#390) 2025-02-18 15:22:14 +01:00
CITATIONS.rst DOC: replace neural ODE by UDE and add doi for UDE paper (#504) 2026-02-09 10:55:37 +01:00
Dockerfile MAINT: Support Python 3.13 and drop 3.9 (#495) 2025-12-19 18:38:08 +01:00
environment-dev.yml MAINT: Support Python 3.13 and drop 3.9 (#495) 2025-12-19 18:38:08 +01:00
generate_version.py MAINT: update ruff format with new version (#386) 2025-02-13 14:24:39 +01:00
LICENSE DOC: how to cite smash (#410) 2025-05-16 21:16:59 +02:00
Makefile MAINT: Add tests folder to package to solve module import (#514) 2026-02-09 15:34:51 +01:00
meson.build MAINT: Add tests folder to package to solve module import (#514) 2026-02-09 15:34:51 +01:00
meson.options ENH: Add support for Windows wheel 2024-05-02 13:54:47 +02:00
pyproject.toml MAINT: Pin compile and run time version of f90wrap to 0.3.0 (#505) 2026-02-08 23:09:30 +01:00
README.md DOC: replace neural ODE by UDE and add doi for UDE paper (#504) 2026-02-09 10:55:37 +01:00
requirements-dev.txt MAINT: Remove sphinx-autosummary-accessors from smash dependencies (#395) 2025-02-19 17:45:46 +01:00
setup.py ENH: Add Ruff Formatter and Linter 2024-02-17 03:36:12 +01:00
smash.bib DOC: replace neural ODE by UDE and add doi for UDE paper (#504) 2026-02-09 10:55:37 +01:00
venv_install.sh Rebase of MJA pull request on main (#241) 2024-07-11 16:48:27 +02:00
versioneer.py MAINT: minor fix typos for smash doc (#408) 2025-04-15 20:55:52 +02:00


PyPI DOI

smash (Spatially distributed Modeling and ASsimilation for Hydrology) is a Python library, interfaced with an efficient Fortran computational engine, that provides user-friendly routines for both hydrological research and operational applications.

The platform enables the combination of vertical and lateral flow operators through either process-based conceptual models or hybrid physics-AI approaches incorporating Artificial Neural Networks (ANNs). It is designed to simulate discharge hydrographs and hydrological states at any spatial location within a basin, and to reproduce the hydrological responses of contrasting catchments by leveraging spatially distributed meteorological forcings, physiographic data, and hydrometric observations.

smash offers a range of advanced calibration techniques, including Variational Data Assimilation (VDA), Bayesian estimation for uncertainty quantification, and machine learning methods, all within a spatialized and differentiable modeling framework. This is enabled by a numerical adjoint model automatically generated using the Tapenade differentiation tool, which provides accurate gradients for high-dimensional, non-linear optimization and efficient model learning.

Whether you are managing water resources or conducting research in hydrological modeling, smash can provide an easy-to-use yet powerful solution to support your work. Refer to the Getting Started guide for installation instructions and an introduction to its features.

How to cite smash

For smash software use, please cite:

Colleoni, F., Huynh, N. N. T., Garambois, P.-A., Jay-Allemand, M., Organde, D., Renard, B., De Fournas, T., El Baz, A., Demargne, J., and Javelle, P. (2025). SMASH v1.0: a differentiable and regionalizable high-resolution hydrological modeling and data assimilation framework. Geosci. Model Dev., 18, 7003–7034. https://doi.org/10.5194/gmd-18-7003-2025.

BibTeX entry:

@article{Colleoni2025smash,
    author  = {Colleoni, François and Huynh, Ngo Nghi Truyen and Garambois, Pierre-André and Jay-Allemand, Maxime and Organde, Didier and Renard, Benjamin and De Fournas, Thomas and El Baz, Apolline and Demargne, Julie and Javelle, Pierre},
    title   = {SMASH v1.0: a differentiable and regionalizable high-resolution hydrological modeling and data assimilation framework},
    journal = {Geoscientific Model Development},
    volume  = {18},
    year    = {2025},
    number  = {19},
    pages   = {7003--7034},
    doi     = {10.5194/gmd-18-7003-2025}
}

Please also cite the relevant references corresponding to the algorithms and methods used:

  • Hybrid physics–AI frameworks embedding neural networks for internal flux correction into (i) a universal differential equations (UDE) solver or (ii) algebraic models solving analytical solutions of time-integrated ordinary differential equations (ODEs):

    Huynh, N. N. T., Garambois, P.-A., Colleoni, F., and Monnier, J. (2026). A hybrid physics–AI approach using universal differential equations with state-dependent neural networks for learnable, regionalizable, spatially distributed hydrological modeling. Geosci. Model Dev., 19, 1055–1074. https://doi.org/10.5194/gmd-19-1055-2026.

    Huynh, N. N. T., Garambois, P.-A., Renard, B., Colleoni, F., Monnier, J., and Roux, H. (2025). A distributed hybrid physics–AI framework for learning corrections of internal hydrological fluxes and enhancing high-resolution regionalized flood modeling. Hydrol. Earth Syst. Sci., 29, 3589–3613. https://doi.org/10.5194/hess-29-3589-2025.

  • Learning regionalization of spatially distributed hydrological pararameters (Hybrid Data Assimilation and Parameter Regionalization, HDA-PR, approach):

    Huynh, N. N. T., Garambois, P.-A., Colleoni, F., Renard, B., Roux, H., Demargne, J., Jay-Allemand, M., and Javelle, P. (2024). Learning Regionalization Using Accurate Spatial Cost Gradients Within a Differentiable High-Resolution Hydrological Model: Application to the French Mediterranean Region. Water Resour. Res., 60, e2024WR037544. https://doi.org/10.1029/2024WR037544.

  • Signatures, multi-criteria calibration, hydrograph segmentation algorithm:

    Huynh, N. N. T., Garambois, P.-A., Colleoni, F., and Javelle, P. (2023). Signatures-and-sensitivity-based multi-criteria variational calibration for distributed hydrological modeling applied to Mediterranean floods. J. Hydrol., 625, 129992. https://doi.org/10.1016/j.jhydrol.2023.129992.

  • Fully distributed variational calibration:

    Jay-Allemand, M., Javelle, P., Gejadze, I., Arnaud, P., Malaterre, P.-O., Fine, J.-A., and Organde, D. (2020). On the potential of variational calibration for a fully distributed hydrological model: application on a Mediterranean catchment. Hydrol. Earth Syst. Sci., 24, 5519–5538. https://doi.org/10.5194/hess-24-5519-2020.