Skip to content
ecmwfPublic

About

Hydrological verification toolkit

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Hyve

ECMWF Software EnginE Maturity Level License: Apache 2.0 Latest Release

Installation * Development

Important

This software is Emerging and subject to ECMWF's guidelines on Software Maturity.

Hyve is a library and toolkit for hydrological verification.

Installation

pip install git+https://github.com/ecmwf/hyve.git@main

Development

Install project with uv

# (Optional) Create and activate virtual environment
uv venv .venv --python 3.10
source .venv/bin/activate

# Install hyve with development dependencies
uv pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

Troubleshooting

hyve-crps-stations: station IDs cannot be matched

hyve-crps-stations matches stations between the reanalysis, the reforecast files and the (optional) climatology by their IDs. It exits with status 1 and a one-line Error: ... message on stderr in two cases:

  • Station IDs of different kinds: one dataset has integer IDs (for example int64) and another has text IDs (for example "1") or byte-string IDs. The message names both datasets, their dtypes, station counts and a few sample IDs.
  • No stations in common: the datasets use the same kind of ID but no ID appears in both. This includes a climatology that shares no station with the reanalysis.

IDs are never converted, so integer 1 and text "1" are different stations. To fix it, make the station ID type consistent upstream (in the extraction or the dataset that holds the odd ID type) and rerun.

License

License headers

Every file declares its copyright and license with SPDX tags following the REUSE specification, as set out in ECMWF's ADR-010. Add the header to a new file with:

uvx reuse annotate \
    --copyright "European Centre for Medium-Range Weather Forecasts (ECMWF)" \
    --license Apache-2.0 \
    path/to/new_file.py

which writes, in the file's comment style and with the current year:

# SPDX-FileCopyrightText: 2026 European Centre for Medium-Range Weather Forecasts (ECMWF)
#
# SPDX-License-Identifier: Apache-2.0
  • uvx runs reuse without installing it; pip install reuse works too.
  • If reuse does not recognise the file type, pick a comment style with --style, e.g. --style python.
  • For a co-developed file, pass --copyright once per copyright holder.
  • Files that cannot carry a comment (data, generated files) are covered in REUSE.toml instead.

The reuse pre-commit hook checks that every file is covered; run the same check by hand with uvx reuse lint.

License

Hyve is licensed under the Apache License, Version 2.0; see LICENSE and NOTICE, which also carry ECMWF's intergovernmental notice.

© 2025-2026 European Centre for Medium-Range Weather Forecasts (ECMWF).

About

Hydrological verification toolkit

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages