hydamo-validation 1.5.0

Validation module for HyDAMO data

The HyDAMO Validation Module: hydamo_validation

Validation Module for HyDAMO data.

Installation

Make sure you have Python 3.12 or 3.13 installed from the official homepage

pip install hydamo-validation

Alternatively, install with uv

uv venv
uv pip install hydamo-validation

Specify a coverage directory

To get the validator running you need some AHN data. You can find these in the data directory of this directory. We assume you copy this to your/local/ahn/dir. Now specify your coverage and init the validator in a python-script:

from hydamo_validation import validator
from pathlib import Path

coverage = {"AHN": Path("your/local/ahn/dir")}

hydamo_validator = validator(
    output_types=["geopackage", "csv", "geojson"], coverages=coverage, log_level="INFO"
)

With this validator you can validate a directory that directory should have the following structure. The name of datasets directory and ValidatorRules.json are mandatory. Within datasets you can put one or more geopackages with HyDAMO layers.

your/directory/
├─ datasets/
│  ├─ hydamo.gpkg
├─ ValidationRules.json

Now you can validate the HyDAMO layers inside your/ directory by:

directory = Path("your/directory")

datamodel, layer_summary, result_summary = hydamo_validator(
    directory=directory, raise_error=False
)