hydro-smash

An open-source Python library interfacing the Fortran Spatially distributed Modeling and ASsimilation for Hydrology platform.

https://github.com/dasshydro/smash

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 17 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

An open-source Python library interfacing the Fortran Spatially distributed Modeling and ASsimilation for Hydrology platform.

Basic Info
Statistics
  • Stars: 23
  • Watchers: 2
  • Forks: 15
  • Open Issues: 27
  • Releases: 0
Created almost 3 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md


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.

  • Documentation: https://smash.recover.inrae.fr
  • Source code: https://github.com/DassHydro/smash
  • Contributing: https://smash.recover.inrae.fr/contributor_guide
  • Citations and related papers: https://smash.recover.inrae.fr/citations
  • Scientific references: https://smash.recover.inrae.fr/bibliography
  • Bug reports: https://github.com/DassHydro/smash/issues

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.

  • Tapenade website: https://team.inria.fr/ecuador/en/tapenade
  • Tapenade article: https://doi.org/10.1145/2450153.2450158
  • Tapenade source code: https://gitlab.inria.fr/tapenade/tapenade.git

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. EGUsphere, 2025, 1–36. https://doi.org/10.5194/egusphere-2025-690.

BibTeX entry:

bibtex @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 = {EGUsphere}, volume = {2025}, year = {2025}, pages = {1--36}, doi = {10.5194/egusphere-2025-690} }

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

  • Hybrid physics-AI framework for learning regionalization and refining internal water fluxes of algebraic or ordinary differential equations (ODEs)-based solvers:

    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.

    Huynh, N. N. T., Garambois, P.-A., Colleoni, F., and Monnier, J. (2025). Hybrid Physics-AI and Neural ODE Approaches for Spatially Distributed Hydrological Modeling. EGUsphere, 2025, 1–24. https://doi.org/10.5194/egusphere-2025-2797.

  • 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.

Owner

  • Name: DassHydro
  • Login: DassHydro
  • Kind: organization

Data Assimilation in Hydrology

Citation (CITATIONS.rst)

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. 
    EGUsphere, 2025, 1–36. 
    `<https://doi.org/10.5194/egusphere-2025-690>`_.

BibTeX entry:

.. code-block:: bibtex

    @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 = {EGUsphere},
        volume  = {2025},
        year    = {2025},
        pages   = {1--36},
        doi     = {10.5194/egusphere-2025-690}
    }

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

- Hybrid physics-AI framework for learning regionalization and refining internal water fluxes of algebraic or ordinary differential equations (ODEs)-based solvers:

    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>`_.

    Huynh, N. N. T., Garambois, P.-A., Colleoni, F., and Monnier, J. (2025). 
    Hybrid Physics-AI and Neural ODE Approaches for Spatially Distributed Hydrological Modeling. 
    EGUsphere, 2025, 1–24. 
    `<https://doi.org/10.5194/egusphere-2025-2797>`_.

- 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>`_.

Related papers
==============

Additional **smash**-related publications:

    Garambois, P.A., Colleoni, F., Huynh, N. N. T., Akhtari, A., Nguyen, N. B., El Baz, A., Jay-Allemand, M., and Javelle, P. (2025). 
    Spatially distributed gradient-based calibration and parametric sensitivity of a spatialized hydrological model over 235 French catchments. 
    J. Hydrol. : Reg. Stud., 60, 102485. 
    `<https://doi.org/10.1016/j.ejrh.2025.102485>`_.
    
    Ettalbi, M., Garambois, P.A., Huynh, N. N. T., Arnaud, P., Ferreira, E., and Baghdadi, N. (2025). 
    Improving parameter regionalization learning for spatialized differentiable hydrological models by assimilation of satellite-based soil moisture data. 
    J. Hydrol., 660, 133300. 
    `<https://doi.org/10.1016/j.jhydrol.2025.133300>`_.

    Jay‐Allemand, M., Demargne, J., Garambois, P.‐A., Javelle, P., Gejadze, I., Colleoni, F., Organde, D., Arnaud, P., and Fouchier, C. (2024). 
    Spatially distributed calibration of ahydrological model with variational optimization constrained by physiographic maps for flash flood forecasting in France. 
    Proceedings of IAHS, 385, 281–290. 
    `<https://doi.org/10.5194/piahs-385-281-2024>`_.

    Evin, G., Le Lay, M., Fouchier, C., Penot, D., Colleoni, F., Mas, A., Garambois, P.-A., Laurantin, O. (2024).
    Evaluation of hydrological models on small mountainous catchments: impact of the meteorological forcings. 
    Hydrol. Earth Syst. Sci., 28, 261–281. 
    `<https://doi.org/10.5194/hess-28-261-2024>`__.

    Huynh, N. N. T., Garambois, P.‐A., Colleoni, F., Renard, B., and Roux, H. (2023). 
    Multi‐gauge hydrological variational data assimilation:Regionalization learning with spatial gradients using multilayer perceptron and Bayesian‐guided multivariate regression. 
    Colloque SHF 2023 - Prévision des crues et des inondations. 
    `<https://doi.org/10.48550/arXiv.2307.02497>`_.

Download smash references
=========================

:download:`smash.bib <javascript:downloadFile('https://raw.githubusercontent.com/DassHydro/smash/main/smash.bib', 'smash.bib')>`

.. raw:: html

   <script>
   function downloadFile(url, filename) {
     fetch(url)
       .then(response => response.blob())
       .then(blob => {
         const link = document.createElement('a');
         link.href = URL.createObjectURL(blob);
         link.download = filename;
         document.body.appendChild(link);
         link.click();
         document.body.removeChild(link);
       });
     return false;
   }
   </script>

GitHub Events

Total
  • Create event: 23
  • Release event: 3
  • Issues event: 40
  • Watch event: 10
  • Delete event: 21
  • Member event: 3
  • Issue comment event: 61
  • Push event: 111
  • Pull request review comment event: 151
  • Pull request review event: 136
  • Pull request event: 152
  • Fork event: 7
Last Year
  • Create event: 23
  • Release event: 3
  • Issues event: 40
  • Watch event: 10
  • Delete event: 21
  • Member event: 3
  • Issue comment event: 61
  • Push event: 111
  • Pull request review comment event: 151
  • Pull request review event: 136
  • Pull request event: 152
  • Fork event: 7

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 20
  • Total pull requests: 67
  • Average time to close issues: 3 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 7
  • Total pull request authors: 8
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.27
  • Merged pull requests: 47
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 18
  • Pull requests: 67
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 4 days
  • Issue authors: 5
  • Pull request authors: 8
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.27
  • Merged pull requests: 47
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • nghi-truyen (30)
  • inoelloc (27)
  • pag13 (12)
  • asjeb (7)
  • benRenard (6)
  • maximejay (5)
  • juliedemargnehydris (2)
  • CatherineFouchier (1)
  • leobpujol (1)
  • didierorgande (1)
  • Mou31ad (1)
  • ThomasdeFournas (1)
  • pierrejavelle (1)
Pull Request Authors
  • nghi-truyen (80)
  • inoelloc (78)
  • asjeb (25)
  • maximejay (20)
  • pag13 (3)
  • ngocbao1022 (3)
  • benRenard (2)
  • ahmad-3100 (2)
Top Labels
Issue Labels
enhancement (29) bug (25) maintenance (16) documentation (15)
Pull Request Labels
documentation (51) enhancement (48) maintenance (44) bug (32) backport (22)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,104 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
  • Total maintainers: 3
pypi.org: hydro-smash

An open-source Python library interfacing the Fortran Spatially distributed Modeling and ASsimilation for Hydrology platform.

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,104 Last month
Rankings
Dependent packages count: 9.5%
Average: 35.9%
Dependent repos count: 62.4%
Maintainers (3)
Last synced: 7 months ago