hydromt_wflow

Wflow plugin for HydroMT

https://github.com/deltares/hydromt_wflow

Keywords from Contributors

Repository

Wflow plugin for HydroMT

README.rst

.. _readme:

=======================================
HydroMT-Wflow: Wflow plugin for HydroMT
=======================================

|pypi| |conda_forge| |docs_latest| |docs_stable| |license| |doi| |binder| |sonarqube_coverage| |sonarqube|

What is the HydroMT-Wflow plugin
--------------------------------
HydroMT_ (Hydro Model Tools) is an open-source Python package that facilitates the process of
building and analyzing spatial geoscientific models with a focus on water system models.
It does so by automating the workflow to go from raw data to a complete model instance which
is ready to run and to analyze model results once the simulation has finished.
This plugin provides an implementation of the model API for the Wflow_ model.

Why HydroMT-Wflow?
------------------
Setting up distributed hydrological models typically requires many (manual) steps
to process input data and might therefore be time consuming and hard to reproduce.
Especially improving models based on global-local geospatial datasets, which are
rapidly becoming available at increasingly high resolutions, might be challenging.
HydroMT-Wflow aims to make the Wflow model building and updating processes **fast**, **modular** and **reproducible**
and to facilitate the analysis of the model results.

How to use HydroMT-Wflow?
-------------------------
The HydroMT-Wflow plugin can be used as a **command line** application, which provides commands to *build*,
*update* and *clip* a Wflow model with a single line, or **from python** to exploit its rich interface.
You can learn more about how to use HydroMT-Wflow in its `online documentation. `_
For a smooth installing experience we recommend installing HydroMT-Wflow and its dependencies
from conda-forge in a clean environment, see `installation guide. `_

How to cite?
------------
For publications, please cite our work using the DOI provided in the Zenodo badge |doi| that points to the latest release.

How to contribute?
-------------------
If you find any issues in the code or documentation feel free to leave an issue on the `github issue tracker. `_
You can find information about how to contribute to the HydroMT project at our `contributing page. `_

HydroMT seeks active contribution from the (hydro) geoscientific community.
So far, it has been developed and tested with a range of `Deltares `_ models, but
we believe it is applicable to a much wider set of geoscientific models and are
happy to discuss how it can be implemented for your model.

.. _Hydromt: https://deltares.github.io/hydromt/latest/
.. _Wflow: https://github.com/Deltares/Wflow.jl

.. |sonarqube| image:: https://sonarcloud.io/api/project_badges/measure?project=Deltares_hydromt_wflow&metric=alert_status
    :target: https://sonarcloud.io/summary/new_code?id=Deltares_hydromt_wflow
    :alt: SonarQube status

.. |sonarqube_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=Deltares_hydromt_wflow&metric=coverage
    :alt: Coverage
    :target: https://sonarcloud.io/summary/new_code?id=Deltares_hydromt_wflow

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

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

.. |pypi| image:: https://img.shields.io/pypi/v/hydromt_wflow.svg?style=flat
    :target: https://pypi.org/project/hydromt_wflow/
    :alt: PyPI

.. |conda_forge| image:: https://anaconda.org/conda-forge/hydromt_wflow/badges/version.svg
    :target: https://anaconda.org/conda-forge/hydromt_wflow
    :alt: Conda-Forge

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

.. |doi| image:: https://zenodo.org/badge/356210291.svg
    :alt: Zenodo
    :target: https://zenodo.org/badge/latestdoi/356210291

.. |license| image:: https://img.shields.io/github/license/Deltares/hydromt_wflow
    :alt: License
    :target: https://github.com/Deltares/hydromt_wflow/blob/main/LICENSE

Attribution
-----------
HydroMT Wflow relies on these excellent packages:

- affine
- annotated-types
- attrs
- bottleneck
- certifi
- cftime
- charset-normalizer
- click
- click-plugins
- cligj
- cloudpickle
- colorama
- crc32c
- dask
- donfig
- fsspec
- geopandas
- hydromt
- idna
- importlib-metadata
- llvmlite
- locket
- mercantile
- netcdf4
- numba
- numcodecs
- numpy
- packaging
- pandas
- partd
- platformdirs
- pooch
- pydantic
- pydantic-core
- pyflwdir
- pyogrio
- pyparsing
- pyproj
- pystac
- python-dateutil
- pytz
- pyyaml
- rasterio
- requests
- rioxarray
- scipy
- shapely
- six
- tomli
- tomli-w
- toolz
- typing-extensions
- typing-inspection
- tzdata
- universal-pathlib
- urllib3
- xarray
- xmltodict
- zarr
- zipp

Owner

GitHub Events

Committers

Last synced: about 1 year ago

Issues and Pull Requests

Last synced: 10 months ago