Installation
============

Availability
------------

The python package for Itzï is on `pypi <https://pypi.python.org/pypi/itzi>`__.
You can browse and download the source code on `GitHub <https://github.com/ItziModel/itzi>`__.

Installation on GNU/Linux
-------------------------

Itzï depends on `GRASS GIS 8.4 or above <https://grass.osgeo.org/download/>`__.
GRASS should therefore be installed in order to use Itzï.
All other dependencies are installed by pip.

You can install itzi with pip or pipx.
However, we recommend you use `uv <https://docs.astral.sh/uv>`__.
Install *uv* by following the instructions on the `uv website <https://docs.astral.sh/uv>`__.

Once you have *uv* installed, you can install Itzï with the following command:

    uv tool install itzi

This will automatically download Itzï and install it in its own python environment.

When it is time to update Itzï to its last version, you can use:

    uv tool update itzi

Installation on Windows
-------------------------

Itzï has been tested on Windows 11.
From a PowerShell terminal, the steps to install Itzï are the same as for GNU/Linux: first install *uv* then itzi.

Verification of the installation
--------------------------------

To check if everything went fine::

    itzi version
    itzi run -h