Itzi

---------

*Release date: 2020-05-26*

This version supports Python 3.7 and above, and therefore GRASS 7.8 and above.
Python 2.x is no longer supported.

**Improvements**

- Raster maps are now written in the background. This might improve the performance in some cases.

**Changes in the configuration file**

- The "effective_pororosity" option is renamed to "effective_porosity". Using the former will raise a deprecation warning.

**Corrected bugs**

- Fix the stencil for 2D friction. This do not seems to have significant real-word impact.
- Computation time display is now working correctly when running simulations with the same filename.
- The first map of input inflow series is now taken into account.
- Raster masks are now properly taken into account.

**Internals**

- Python 3.7 or above is now mandatory.
- Refactoring of the code to follow a initialize-run-finalize model.
- Inclusion of a test suite to improve quality insurance.
- Use of grass-session to set the GRASS environment.

---------

*Release date: 2018-02-19*

This new version of Itzï improves the stability of the surface-drainage coupling.
The part of the code calculating the coupling has been mostly rewritten.
The coupling flow between the surface and the drainage is calculated as follows:

- In case of drainage overflow, the orifice equation is used
- In case of surface to drainage flow, the coupling flow is calculated by using either the orifice,
free weir or submerged weir equation.
The equation is chosen according to the relative water surface elevations in the surface and the drainage, and the node crest elevation.
- If the water is entering the drainage network, the flow is limited to prevent negative depth in the surface model.
- The coupling flow cannot invert in one time-step. It must spend one time-step at zero.
This reduces the oscillations that could occur when the water elevations in both the drainage network and the surface are similar.

----------

*Release date: 2017-11-24*

**New features**

- Drainage coupling: Add the possibility to set the orifice and weir coefficients in the configuration file.
- Allow to set the raster mask and region from the input file.
- Now print an out-of-memory error message instead of a blank crash if the domain does not fit in the RAM.

**Corrected bugs**

- Drainage coupling: fix unit conversion problem in setting node fullDepth, set fullVolume at the same time.

**Code organization**

- Improve coding standard with pylint.
- Advance Python 3 support. Still limited by GRASS own incompatibility.
- Move more GRASS functions to gis.py.

----------

*Release date: 2017-10-27*

**Corrected bugs**

- Fix problems of unit conversion in the interchange between the surface and the drainage model.
- Do not write the output vector maps if not wanted by the user.
- Fix a division by zero error appearing at the beginning of the simulation.

---------

*Release date: 2017-08-08*

This is principally a bugfix release.

**New features**

- Flows interchanges when water is leaving the drainage network are always modelled with an orifice equation.
This is in accordance with [1], from where the coefficients are taken.

**Corrected bugs**

- Fix the pip installation process. Remove the cython dependency.

[1] Rubinato et al. 2017. doi:10.1016/j.jhydrol.2017.06.024

---------

*Release date: 2017-07-31*

This release adds the integration of the SWMM drainage network model.

**New features**

- Bi-directional coupling with the SWMM model
- Velocity is now calculated at the centre of the cells
- It is possible to output maps of the Froude number
- The maps of the initial state of the simulation are recorded

**Changes in the configuration file**

Some changes have been made to the configuration file in order to make the options clearer.

- In the [input] section, *drainage_capacity* is renamed *losses*
- In the [output] section, *drainage_cap* is renamed *losses*

If Itzï is run with an older option name, the user will receive a deprecation warning.
Those legacy options are set for deletion in a later release.
Please update your configuration files.

**Corrected bugs**

- Maps are recorded at the very end of the simulation
- Check if the domain is at least 3x3 cells before running a simulation.
- Itzï will check if grassdata, location and mapsets exist before running a simulation.