Metadata-Version: 2.4
Name: mergeplg
Version: 0.2.0
Summary: A great package.
License: BSD-3-Clause
License-File: LICENSE
Author: Christian Chwala
Author-email: christian.chwala@kit.edu
Requires-Python: >=3.10,<4.0.0
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: test
Requires-Dist: docutils (!=0.21.post1) ; extra == "docs"
Requires-Dist: furo (>=2023.8.17) ; extra == "docs"
Requires-Dist: h5py (<=3.14)
Requires-Dist: ipython ; extra == "docs"
Requires-Dist: myst_parser (>=0.13) ; extra == "docs"
Requires-Dist: nbmake (>=1.4.6) ; extra == "test" or extra == "dev"
Requires-Dist: nbsphinx ; extra == "docs"
Requires-Dist: netcdf4 (<1.7.3)
Requires-Dist: numba
Requires-Dist: numpy (>=2.0.1)
Requires-Dist: pandas (>=2.2.2)
Requires-Dist: poligrain (>=0.3.0)
Requires-Dist: pykrige (>=1.7.2)
Requires-Dist: pytest (>=6) ; extra == "test" or extra == "dev"
Requires-Dist: pytest-cov (>=3) ; extra == "test" or extra == "dev"
Requires-Dist: scikit-gstat (>=1.0.17)
Requires-Dist: scikit-learn (>=1.5.1)
Requires-Dist: scipy (>=1.14.0)
Requires-Dist: sphinx (>=7.0) ; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
Requires-Dist: sphinx_copybutton (>=0.3.0) ; extra == "docs"
Requires-Dist: wradlib (>=2.0.3)
Requires-Dist: xarray (>=2024.6.0)
Project-URL: Homepage, https://github.com/OpenSenseAction/mergeplg
Project-URL: Repository, https://github.com/OpenSenseAction/mergeplg
Description-Content-Type: text/markdown

# mergeplg

[![Actions Status][actions-badge]][actions-link]
[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI version][pypi-version]][pypi-link]
[![Conda-Forge][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

<!-- SPHINX-START -->

`mergeplg` is a collection of methods to merge rainfall observations from
sensors with different geometries into a single rainfall field. Typically the
sensors are rain gauges (point), commercial microwave links / CML (line) and
weather radar or satellites (grid).

## Features

- **Interpolation** of point (gauge) and line (CML) observations onto a grid
  using [IDW](https://en.wikipedia.org/wiki/Inverse_distance_weighting) or
  [kriging](https://en.wikipedia.org/wiki/Kriging), with support for ordinary
  kriging, kriging with external drift (KED) and block kriging.
- **Radar adjustment** that combines radar fields with gauge and CML
  observations, either additively (interpolating the difference) or
  multiplicatively (interpolating the ratio), using any of the interpolation
  methods above, or directly via KED.
- **Line geometry handling** that treats CMLs correctly: radar values along a
  link are obtained via grid intersection for computing differences, and
  (optional) block kriging uses the full line geometry rather than just the
  midpoint.

## Installation

```bash
pip install mergeplg
```

## Documentation

See the [documentation](https://mergeplg.readthedocs.io/) for usage examples and
the API reference.

## License

Distributed under the terms of the
[BSD-3-Clause](https://opensource.org/license/bsd-3-clause) license.

<!-- prettier-ignore-start -->
[actions-badge]:            https://github.com/OpenSenseAction/mergeplg/workflows/CI/badge.svg
[actions-link]:             https://github.com/OpenSenseAction/mergeplg/actions
[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/mergeplg
[conda-link]:               https://github.com/conda-forge/mergeplg-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]:  https://github.com/OpenSenseAction/mergeplg/discussions
[pypi-link]:                https://pypi.org/project/mergeplg/
[pypi-platforms]:           https://img.shields.io/pypi/pyversions/mergeplg
[pypi-version]:             https://img.shields.io/pypi/v/mergeplg
[rtd-badge]:                https://readthedocs.org/projects/mergeplg/badge/?version=latest
[rtd-link]:                 https://mergeplg.readthedocs.io/en/latest/?badge=latest

<!-- prettier-ignore-end -->

