Installation guide

Prerequisites

You’ll need Python 3.11, 3.12, or 3.13 and a package manager. We recommend using pixi.

Installation

HydroMT-FIAT is available from pypi and conda-forge, but we recommend installing from conda-forge using the pixi package manager.

Install HydroMT-FIAT

Tip

This is our recommended way of installing HydroMT!

To make the HydroMT cli available anywhere on the system using pixi execute the command:

$ pixi global install hydromt_fiat

This will create a new isolated environment and install hydromt into it. To test whether the installation was successful you can run hydromt --plugins and the output should look approximately like the one below:

$ hydromt --plugins
    Model plugins:
            - model (hydromt 1.0.1)
            - fiat_model (hydromt_fiat 1.0.0.dev0)
    Component plugins:
            - ConfigComponent (hydromt 1.0.1)
            - DatasetsComponent (hydromt 1.0.1)
            - GeomsComponent (hydromt 1.0.1)
            - GridComponent (hydromt 1.0.1)
            - MeshComponent (hydromt 1.0.1)
            - SpatialDatasetsComponent (hydromt 1.0.1)
            - TablesComponent (hydromt 1.0.1)
            - VectorComponent (hydromt 1.0.1)
    Driver plugins:
            - dataset_xarray (hydromt 1.0.1)
            - geodataframe_table (hydromt 1.0.1)
            - geodataset_vector (hydromt 1.0.1)
            - geodataset_xarray (hydromt 1.0.1)
            - pandas (hydromt 1.0.1)
            - pyogrio (hydromt 1.0.1)
            - raster_xarray (hydromt 1.0.1)
            - rasterio (hydromt 1.0.1)
            - osm (hydromt_fiat 1.0.0.dev0)
    Catalog plugins:
            - deltares_data (hydromt 1.0.1)
            - artifact_data (hydromt 1.0.1)
            - aws_data (hydromt 1.0.1)
            - gcs_cmip6_data (hydromt 1.0.1)
    Uri_resolver plugins:
            - convention (hydromt 1.0.1)
            - raster_tindex (hydromt 1.0.1)
            - osm_resolver (hydromt_fiat 1.0.0.dev0)

Installing HydroMT-FIAT in a python environment

If you wish to use hydromt-fiat through it’s Python API, you can use pixi to create an environment for this too. If you do not have a pyproject.toml yet you can make one by executing the command:

$ pixi init --format pyproject

Which will create it for you. After this simply add HydroMT-FIAT as a dependency with the following command:

$ pixi add hydromt_fiat

Once you have your new (or existing pyproject.toml) file install the pixi environment and activate it with the following commands to be able to start using it:

$ pixi install
$ pixi shell activate