Metadata-Version: 2.2
Name: itzi
Version: 25.4
Summary: A distributed dynamic flood model.
Author-email: Laurent Courty <lrntct@gmail.com>
License: GPL-2.0-or-later
Project-URL: Homepage, http://www.itzi.org
Project-URL: Documentation, https://itzi.readthedocs.io
Project-URL: Repository, https://github.com/ItziModel/itzi
Project-URL: Issues, https://github.com/ItziModel/itzi/issues/
Keywords: science,engineering,hydrology,flood
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Hydrology
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy==2.2.*
Requires-Dist: pyinstrument==5.*
Requires-Dist: pyswmm>=2.0.1
Requires-Dist: bmipy>=2.0.1


====
Itzï
====

|Actions| |pypi| |rtfd|

Itzï is a dynamic, fully distributed hydrologic and hydraulic model that
simulates 2D surface flows on a regular raster grid and drainage flows through the SWMM model.
It uses GRASS GIS as a back-end for entry data and result writing.

Website: http://www.itzi.org/

Documentation: http://itzi.rtfd.io/

Repository: https://github.com/ItziModel/itzi

.. |Actions| image:: https://github.com/ItziModel/itzi/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/ItziModel/itzi/actions/workflows/tests.yml
   :alt: Github Actions status

.. |pypi| image:: https://badge.fury.io/py/itzi.svg
    :target: https://badge.fury.io/py/itzi
    :alt: Pypi package version

.. |rtfd| image:: https://readthedocs.org/projects/itzi/badge/?version=latest
    :target: https://itzi.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


Description
===========

Itzï allows the simulation of surface flows from direct rainfall or user-given point inflows.
Its GIS integration simplifies the pre- and post-processing of data.
Notably, to change the resolution or the extend of the computational domain,
the user just need to change the GRASS computational region and the raster mask, if applicable.
This means that map export or re-sampling is not needed.

Itzï uses raster time-series as entry data, allowing the use of rainfall from weather radars.


Model description
=================

The surface model of Itzï is described in details in the following open-access article:

    Courty, L. G., Pedrozo-Acuña, A., & Bates, P. D. (2017).
    Itzï (version 17.1): an open-source, distributed GIS model for dynamic flood simulation.
    Geoscientific Model Development, 10(4), 1835–1847.
    http://doi.org/10.5194/gmd-10-1835-2017
