Metadata-Version: 2.4
Name: hydromt_fiat
Version: 0.5.10
Author-email: Dirk Eilander <dirk.eilander@deltares.nl>, Frederique de Groen <frederique.degroen@deltares.nl>, Mario Fuentes Monjaraz <mario.fuentesmonjaraz@deltares.nl>, Luis Rodriguez Galvez <luis.rodriguez@deltares.nl>, Lieke Meijer <lieke.meijer@deltares.nl>, Sarah Rautenbach <sarah.rautenbach@deltares.nl>
License: GPL-3.0
Project-URL: Documentation, https://deltares.github.io/hydromt_fiat/
Project-URL: Source, https://github.com/Deltares/hydromt_fiat
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: hydromt<1.0
Requires-Dist: geopandas
Requires-Dist: geopy
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: pyogrio
Requires-Dist: tomli-w
Requires-Dist: tomli
Requires-Dist: xarray
Requires-Dist: pydantic
Requires-Dist: osmnx<3,>=2
Requires-Dist: census
Requires-Dist: us
Requires-Dist: xarray-spatial
Requires-Dist: tqdm
Requires-Dist: pycountry-convert
Requires-Dist: pyarrow
Requires-Dist: dask
Requires-Dist: pint
Provides-Extra: test
Requires-Dist: testpath; extra == "test"
Requires-Dist: responses; extra == "test"
Requires-Dist: pytest>=2.7.3; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Requires-Dist: ruff==0.6.8; extra == "doc"
Dynamic: license-file

HydroMT-FIAT: HydroMT plugin for Delft-FIAT
############################################

.. image:: https://codecov.io/gh/Deltares/hydromt_fiat/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/Deltares/hydromt_fiat

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
    :target: https://deltares.github.io/hydromt_fiat/latest
    :alt: Latest developers docs

.. image:: https://img.shields.io/badge/docs-stable-brightgreen.svg
    :target: https://deltares.github.io/hydromt_fiat/stable
    :alt: Stable docs last release

.. image:: https://badge.fury.io/py/hydromt_fiat.svg
    :target: https://pypi.org/project/hydromt_fiat/
    :alt: Latest PyPI version

.. image:: https://mybinder.org/badge_logo.svg
    :target: https://mybinder.org/v2/gh/Deltares/hydromt_fiat/main?urlpath=lab/tree/examples


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.


.. _hydromt: https://deltares.github.io/hydromt
.. _Delft-FIAT: https://www.deltares.nl/en/software-and-data/products/delft-fiat-flood-impact-assessment-tool


.. Installation
.. ------------


.. HydroMT-FIAT is available from pypi and will be added to conda-forge (in progress).

.. To install hydromt_fiat for usage, do:

.. .. code-block:: console

..   pip install hydromt_fiat

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:

.. code-block:: console

    conda create -n hydromt_fiat python=3.11.*

2. Activate the environment:

.. code-block:: console

    conda activate hydromt_fiat

3. Install conda-forge gdal.

.. code-block:: console

    conda install -c conda-forge gdal

4. 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:

.. code-block:: console

    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:

.. code-block:: console

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


Installation as a Developer
---------------------------
For developing on HydroMT-FIAT, do:

.. code-block:: console

  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 <https://deltares.github.io/hydromt_fiat/>`_

Contributing
------------

You can find information about contributing to HydroMT at our `Contributing page <https://deltares.github.io/hydromt/latest/dev/contributing>`_.
