Metadata-Version: 2.4
Name: hydro_analysis_toolkit
Version: 0.8.1
Summary: ECMWF's Hydrological Analysis Toolkit
Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
Maintainer-email: Corentin Carton de Wiart <corentin.carton@ecmwf.int>, "Oisín M. Morrison" <oisin.morrison@ecmwf.int>
License: Apache License Version 2.0
Project-URL: repository, https://github.com/ecmwf/hat
Project-URL: documentation, https://hydro-analysis-toolkit.readthedocs.io
Project-URL: issues, https://github.com/ecmwf/hat/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: matplotlib
Requires-Dist: geopandas
Requires-Dist: typer
Requires-Dist: humanize
Requires-Dist: tqdm
Requires-Dist: ipyleaflet
Requires-Dist: ipywidgets
Requires-Dist: earthkit-data>=0.13.8
Requires-Dist: earthkit-hydro
Requires-Dist: earthkit-meteo
Requires-Dist: cfgrib
Requires-Dist: netCDF4
Requires-Dist: eccodes
Requires-Dist: plotly
Requires-Dist: floods-html
Requires-Dist: geopy
Requires-Dist: setuptools
Requires-Dist: anywidget
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Dynamic: license-file

# Hydrological Analysis Toolkit (HAT)

<p align="center">
  <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/foundation_badge.svg" alt="ECMWF Software EnginE">
  </a>
  <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/emerging_badge.svg" alt="Maturity Level">
  </a>
  <a href="https://opensource.org/licenses/apache-2-0">
    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
  </a>
  <a href="https://github.com/ecmwf/hat/releases">
    <img src="https://img.shields.io/github/v/release/ecmwf/hat?color=purple&label=Release" alt="Latest Release">
  </a>
</p>

<p align="center">
  <!-- <a href="#quick-start">Quick Start</a>
  • -->
  <a href="#installation">Installation</a>
  •
  <a href="https://hydro-analysis-toolkit.readthedocs.io">Documentation</a>
</p>

> \[!IMPORTANT\]
> This software is **Emerging** and subject to ECMWF's guidelines on [Software Maturity](https://github.com/ecmwf/codex/raw/refs/heads/main/Project%20Maturity).

The Hydrological Analysis Toolkit (HAT) is a software suite for hydrologists working with simulated and observed river discharge. HAT performs data analysis on hydrological datasets, with its main features being:
- mapping station locations into hydrological model grids
- extraction of timeseries at station locations from gridded model outputs
- statistical analysis of hydrological timeseries

### Installation

For a default installation, run

```
pip install hydro-analysis-toolkit
```

For a developer setup, run

```
conda create -n hat python=3.12
conda activate hat
git clone https://github.com/ecmwf/hat.git
cd hat
pip install -e .[dev]
pre-commit install
```

## Licence

```
Copyright 2023, European Centre for Medium Range Weather Forecasts.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

In applying this licence, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation
nor does it submit to any jurisdiction.
```
