Itzï
A powerful, open-source hydrologic and hydraulic modeling platform that makes flood simulation accessible to everyone.
https://github.com/itzimodel/itzi
Category: Climate Change
Sub Category: Natural Hazard and Storms
Last synced: about 23 hours ago
JSON representation
Repository metadata
A dynamic GIS flood model
- Host: GitHub
- URL: https://github.com/itzimodel/itzi
- Owner: ItziModel
- License: gpl-2.0
- Created: 2020-05-16T14:16:04.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-05-11T19:43:13.000Z (21 days ago)
- Last Synced: 2026-05-15T14:04:40.655Z (17 days ago)
- Language: Python
- Homepage: https://www.itzi.org
- Size: 3.83 MB
- Stars: 57
- Watchers: 2
- Forks: 24
- Open Issues: 34
- Releases: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Agents: AGENTS.md
README.md
Itzï 🌊
Effortless flood modeling with seamless GIS integration
Itzï is a powerful, open-source hydrologic and hydraulic modeling platform that makes flood simulation accessible to everyone.
Built with GRASS GIS integration at its core, Itzï eliminates the complexity of traditional flood modeling workflows, allowing you to focus on what matters most: understanding and predicting water flow patterns.
🚀 Why Choose Itzï?
🎯 GIS-Native Design
- No data wrestling: Work directly with your existing GIS data
- Resolution flexibility: Change model resolution with a single command, no matter the resolution of your input data
- Seamless workflow: From data preparation to results visualization, all within your familiar GIS environment
⚡ Advanced Capabilities
- 2D surface flow modeling with a damped partial inertia numerical scheme
- Drainage inflow and overflow with integrated SWMM coupling
- Space-time variability of inputs: Easily model rainfall fields from weather radar or satellite data 📡
🔧 User-Friendly
- Simple configuration: Text-based parameter file
- Flexible boundaries: Easy setup of inflows, outflows, and boundary conditions
- Rich outputs: Generate animations, time series, and detailed flood maps
📦 Quick Installation
Prerequisites
Itzï requires GRASS GIS 8.4 or above. Install GRASS first, then proceed with Itzï installation.
Recommended Installation (using uv)
We recommend using uv for the best installation experience:
# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install Itzï
uv tool install itzi
# Verify installation
itzi version
itzi run -h
Alternative Installation Methods
# Using pip
pip install itzi
# Using pipx
pipx install itzi
Updating
# Update to latest version
uv tool upgrade itzi
🎯 Quick Start
- Prepare your data in GRASS (DEM, rainfall, friction data)
- Create a parameter file defining your simulation setup
- Run the simulation:
itzi run your_config.ini - Visualize and analyze results using GRASS tools, or export for external analysis
Check out our comprehensive tutorial for a step-by-step walkthrough using real-world data.
🌟 Key Features
- Dynamic 2D Surface Flow: Simulate complex surface water movement on regular grids
- Drainage network integration: Model culverts, storm drains, and urban drainage infrastructure with SWMM
- Map time series as input and output: Generate detailed spatiotemporal analysis of flood events
- Mass balance monitoring: Automatic detection of instabilities, no more garbage output
- Hydrology: Space-time rainfall and Green-Ampt infiltration
- Cross-platform: Runs on Linux, Windows, and macOS
📚 Documentation & Support
- 📖 Documentation: itzi.readthedocs.io
- 🌐 Website: itzi.org
- 💻 Source Code: GitHub Repository
- 🐛 Issues: Report bugs or request features
📄 Citation
If you use Itzï in your research, please cite:
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.
https://doi.org/10.5194/gmd-10-1835-2017
🤝 Contributing
We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help makes Itzï better for everyone.
- Contributing Guide: See CONTRIBUTING.md
- Code of Conduct: See CODE_OF_CONDUCT.md
📜 License
Itzï is released under the GPL license. See LICENSE for details.
Ready to model floods with ease? Get started with our tutorial and join the growing community of Itzï users worldwide!
Owner metadata
- Name: ItziModel
- Login: ItziModel
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/65320729?v=4
- Repositories: 1
- Last ynced at: 2023-02-28T18:21:59.714Z
- Profile URL: https://github.com/ItziModel
GitHub Events
Total
- Release event: 2
- Delete event: 7
- Pull request event: 63
- Fork event: 1
- Issues event: 62
- Watch event: 17
- Issue comment event: 43
- Push event: 71
- Create event: 8
Last Year
- Delete event: 7
- Pull request event: 63
- Issues event: 51
- Watch event: 12
- Issue comment event: 20
- Push event: 33
- Create event: 7
Committers metadata
Last synced: 7 days ago
Total Commits: 829
Total Committers: 1
Avg Commits per committer: 829.0
Development Distribution Score (DDS): 0.0
Commits in past year: 64
Committers in past year: 1
Avg Commits per committer in past year: 64.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Laurent Courty | l****t@g****m | 829 |
Issue and Pull Request metadata
Last synced: 11 days ago
Total issues: 45
Total pull requests: 29
Average time to close issues: about 2 years
Average time to close pull requests: about 9 hours
Total issue authors: 11
Total pull request authors: 2
Average comments per issue: 1.13
Average comments per pull request: 0.0
Merged pull request: 17
Bot issues: 0
Bot pull requests: 4
Past year issues: 31
Past year pull requests: 29
Past year average time to close issues: 18 days
Past year average time to close pull requests: about 9 hours
Past year issue authors: 3
Past year pull request authors: 2
Past year average comments per issue: 0.39
Past year average comments per pull request: 0.0
Past year merged pull request: 17
Past year bot issues: 0
Past year bot pull requests: 4
Top Issue Authors
- lrntct (34)
- vitduck (2)
- wuxuedaifu (1)
- Caesar05 (1)
- ldesousa (1)
- honglioslo (1)
- JSUNFGH (1)
- cam1331 (1)
- geoendemics (1)
- wanghai1988 (1)
- AlisterH (1)
Top Pull Request Authors
- lrntct (25)
- dependabot[bot] (4)
Top Issue Labels
- enhancement (5)
- critical (3)
- minor (1)
- documentation (1)
- major (1)
- good first issue (1)
- bug (1)
Top Pull Request Labels
- minor (4)
- python:uv (4)
- dependencies (4)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 292 last-month
- Total docker downloads: 40
- Total dependent packages: 0
- Total dependent repositories: 2
- Total versions: 13
- Total maintainers: 1
pypi.org: itzi
A distributed dynamic flood model.
- Homepage: http://www.itzi.org
- Documentation: https://itzi.readthedocs.io
- Licenses: GPL-2.0-or-later
- Latest release: 25.8 (published 10 months ago)
- Last Synced: 2026-05-25T19:03:32.631Z (7 days ago)
- Versions: 13
- Dependent Packages: 0
- Dependent Repositories: 2
- Downloads: 292 Last month
- Docker Downloads: 40
-
Rankings:
- Dependent packages count: 10.02%
- Dependent repos count: 11.608%
- Average: 18.075%
- Downloads: 32.598%
- Maintainers (1)
Dependencies
- sphinx-argparse *
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- pypa/cibuildwheel v2.23.2 composite
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- bmipy >=2.0.1
- numpy ==2.2.*
- pyinstrument ==5.*
- pyswmm >=2.0.1
Score: 10.327970666480054