Skip to main content

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

Description

Itzï allows to simulate surface flows from direct rainfall or user-given point inflows. It 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 uses of radar rainfall or varying friction coefficient.

In Itzï, the simulation time information could be represented in two ways. First, the time could relative, i.e given as a number of hours, minutes and seconds, whatever the actual date is. Alternatively, the user can provide a start date and time, together with a duration or a end time. This second way is useful to simulate historical events with a known date, especially with input data with such time representation, for example rainfall. To be able to use this functionality, the time-series given as entry data should use the same temporal reference system.

Superficial flow model

Itzï implements a partial inertia, finite-difference numerical scheme described in:

De Almeida, G. a M. et al., 2012. Improving the stability of a simple formulation of the shallow water equations for 2-D flood modeling. Water Resources Research, 48(5), pp.1–14.

De Almeida, G. a M. & Bates, P., 2013. Applicability of the local inertial approximation of the shallow water equations to flood modeling. Water Resources Research, 49(8), pp.4833–4844.

As well as a simple rain routing method inspired by:

Sampson, C.C. et al., 2013. An automated routing methodology to enable direct rainfall in high resolution shallow water models. Hydrological Processes, 27(3), pp.467–476.

Infiltration model

Itzï can simulate the infiltration on two different ways:
  • Green-Ampt infiltration model.

  • User given infiltration rate in mm/h

Usage

Simulations parameters are given through a file written in a style similar to the Microsoft Windows INI files.

Simulation time

Simulation duration could be given by a combination of start time, end time and duration. If only the duration is given, the results will be written as relative time STRDS. In case start time is given, the simulation will use a absolute temporal type. record_step is the time-step at which results are written to the disk.

Input data

Itzï does not support Lat-Long coordinates. A projected location should be used. The inputs maps could be given either as STRDS or single maps. First, the module try to load a STRDS of the given name. If unsuccessful, it will load the given map, and stop with an error if the name does not correspond to either a map or a STRDS.

The following raster maps are necessary:

  • Digital elevation model in meters

  • Friction, expressed as Manning’s n

The following space-time raster datasets are optional:

  • rain map in mm/h

  • point inflow in m/s (vertical velocity, i.e for 20 m3/s on a 10x10 cell, the velocity is 0.2 m/s)

  • fixed infiltration rate in mm/h

  • Green-Ampt infiltration parameters

  • boundary condition type: an integer map (see below)

  • boundary condition value: a map for boundary conditions using user-given value

Boundary conditions

The boundary type is defined by the following cell values:

  1. closed: flow = 0

  2. open: velocity at the boundary is equal to the velocity inside the domain

  3. fixed-depth: not implemented yet

  4. user-defined water depth inside the domain

The boundary value map is used in the case of types 3 and 4 boundary condition. The open boundary condition is experimental and not well tested.

Output data

The user can choose to output the following:

  • water depth

  • water surface elevation (depth + DEM)

  • velocity magnitude in m/s and direction in degrees

  • x and y flows in m3/s

  • statistical maps of boundaries, infiltration, rainfall and/or point inflow

A raster space-time dataset is created for each selected output. Maps are written using the STRDS name as a prefix. Flows values are the values at E and S boundaries of the given cell, respectively. Values of statistical maps corresponds to the average value during the last record interval.

Installation

Itzï depends on GRASS GIS 7 and NumPy. GRASS should therefore be installed in order to use Itzï. GRASS normally depends on NumPy, so installing manually NumPy might not be necessary. All other dependencies are installed by pip.

Download and install Itzï:

$ pip install itzi

Check usage of itzi command line:

$ itzi -h

Run a simulation:

$ itzi run parameters_file.ini

Release files for itzi 17.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for itzi 17.1
File Size Uploaded
itzi-17.1.tar.gz 155.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for itzi 17.1
File Interpreter ABI Platform
itzi-17.1-cp27-cp27m-win_amd64.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-64 Details

Total release size: 461.3 kB

Release files / itzi-17.1.tar.gz

Download URL itzi-17.1.tar.gz
Size 155.8 kB
Tags Source
SHA-256 checksum
How to use checksums
fb5a2e7170736f44f715c382f6bd6c9232bf4b797c146aeb304f1d550e92f415
BLAKE2b-256 checksum
How to use checksums
132b1c0946976d50cebb70440897f780654f0cdb69e1d48c4daf62bb1d97ad89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / itzi-17.1-cp27-cp27m-win_amd64.whl

Download URL itzi-17.1-cp27-cp27m-win_amd64.whl
Size 305.6 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
665d338a731b1b45ce0d88c348b85ae160f99d2d638552b0e42a84a464116290
BLAKE2b-256 checksum
How to use checksums
ef1263f4d23557da9baec4ceaa60f23519a8be07492246e22ab7713aed0ea2e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

26.6

15 release files

25.8

15 release files

25.4

18 release files

20.5

1 release file

18.2

1 release file

17.11

1 release file

17.10

1 release file

17.8

1 release file

17.7

1 release file

This release

17.1 This release

2 release files

16.9

2 release files

16.8

1 release file

16.7

1 release file

16.6

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page