Metadata-Version: 2.1
Name: hydamo_validation
Version: 1.3.1
Summary: Validation module for HyDAMO data
Author-email: Daniel Tollenaar <daniel@d2hydro.nl>
License: MIT
Project-URL: Source, https://github.com/HetWaterschapshuis/HyDAMOValidatieModule
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geopandas
Requires-Dist: pandas>=2
Requires-Dist: pyogrio
Requires-Dist: rasterio
Requires-Dist: shapely>=2
Requires-Dist: rasterstats
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"

# The HyDAMO Validation Module: hydamo_validation

Validation Module for HyDAMO data.

## Installation

### Python installation
Make sure you have an Miniconda or Anaconda installation. You can download these here:
 - https://www.anaconda.com/products/individual
 - https://docs.conda.io/en/latest/miniconda.html

During installation, tick the box "Add Anaconda to PATH", ignore the red remarks

### Create the `validatietool` environment
Use the `env/environment.yml` in the repository to create the conda environment: `validatietool`

```
conda env create -f environment.yml
```

After installation you can activate your environment in command prompt

```
conda activate validatietool
```

### Install hydamo_validation
Simply install the module in the activated environment:

```
pip install hydamo_validation
```

### Develop-install hydamo_validation
Download or clone the repository. Now simply install the module in the activated environment:

```
pip install .
```

## Run an example
A working example with data can be found in `notebooks/test_wrij.ipynb`. In the activated environment launch jupyter notebook by:

```
jupyter notebook
```

Select `test_wrij.ipynb` read and run it.
