Skip to content

Deltares/hydromt_fiat

Repository files navigation

HydroMT-FIAT: HydroMT plugin for Delft-FIAT

Latest developers docs Stable docs last release Latest PyPI version

HydroMT is a python package, developed by Deltares, to build and analyze hydro models. It provides a generic model api with attributes to access the model schematization, (dynamic) forcing data, results and states. This plugin provides an implementation for the Delft-FIAT model.

Installation as a User

For Use HydroMT-FIAT, do: Hydromt-FIAT can be installled in an existing environment or the user can create a new environment. We recommened to create a new environment to avoid issues with other dependencies and packages.

New environment To create a new environment follow the steps below.

  1. Create a new environment:
conda create -n hydromt_fiat python=3.11.*
  1. Activate the environment:
conda activate hydromt_fiat
  1. Install conda-forge gdal.
conda install -c conda-forge gdal
  1. Install Hydromt-FIAT from Github. After creating the new environment, you need to install all dependencies from the Deltares Github repository. You can use pip install to do so:
pip install git+https://github.com/Deltares/hydromt_fiat.git

Existing environment If you want to install FIAT into an existing environment, simply activate the desired environment and run:

pip install git+https://github.com/Deltares/hydromt_fiat.git

Installation as a Developer

For developing on HydroMT-FIAT, do:

conda env create -f envs/hydromt-fiat-dev.yml
conda activate hydromt-fiat-dev
pip install -e .

Documentation

Learn more about the HydroMT-FIAT plugin in its online documentation

Contributing

You can find information about contributing to HydroMT at our Contributing page.