ecmwf/earthkit-hydro

earthkit-hydro

DISCLAIMER This project is BETA and will be Experimental for the foreseeable future. Interfaces and functionality are likely to change, and the project itself may be scrapped. DO NOT use this software in any project/software that is operational.

earthkit-hydro is a home for hydrological functions that take numpy arrays as inputs and return numpy arrays as outputs.

License

Copyright 2022, 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.

earthkit-hydro's Issues

list of candidate hydrological functions

A list of hydrological functions to review with the subject matter experts (SMEs) on the team. See these two legacy files for details..

• hydrostats.py
• eval_reanalysis.py

Add dev setup instructions like earthkit-data

• conda environment
• git hooks (scripts that run automatically when certain git events occur
• pre-commit (framework for managing git hooks)
• pyproject.toml (describes the earthkit-hydro python package)
• developer instructions

Developer instructions might be something like this (thanks @sandorkertesz )

1. mamba env create -f environment.yml
2. pre-commit install
3. pip install -e . --no-deps

The third instruction will install the python package in the current directory in editable mode (i.e. hot reloading any local changes without needing to reload the package) the no-deps flags asks pip not to install dependencies of the current directory package.