Metadata-Version: 2.2
Name: unravel
Version: 1.3.4
Summary: A dealiasing technique for Doppler radar velocity.
Home-page: https://github.com/vlouf/dealias
Author: Valentin Louf
Author-email: valentin.louf@bom.gov.au
Project-URL: Bug Reports, https://github.com/vlouf/dealias/issues
Project-URL: Source, https://github.com/vlouf/dealias/
Keywords: radar weather meteorology dealiasing Doppler
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: arm_pyart
Requires-Dist: pyodim
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: requires-dist
Dynamic: summary

[![DOI](https://zenodo.org/badge/119326382.svg)](https://zenodo.org/badge/latestdoi/119326382)

# UNRAVEL

UNRAVEL (UNfold RAdar VELocity) is an open-source modular Doppler velocity dealiasing algorithm for weather radars. This algorithm does not require external reference velocity data, making it highly versatile and easily applicable across various contexts. UNRAVEL consists of eleven core modules and two dealiasing strategies, enabling iterative processing. It starts with the strictest continuity tests in azimuth and range, progressively relaxing the parameters to include more results from a growing number of reference points. Additionally, UNRAVEL includes modules for performing 3D continuity checks. This modular design allows for the expansion of dealiasing strategies to optimize results further.

## Changelog:

Version 1.2.5:
- New box check using a fast and robust striding window algorithm, up to 10x faster for that function call.
Version 1.2.0:
- Multiprocessing using `unravel_3D_pyart_multiproc`
- Various optimization and speed up.

## Installation

UNRAVEL is available on [PyPI](https://pypi.org/project/unravel/). The easiest method for installing UNRAVEL is to use pip:

```pip install unravel```

## Dependencies

Mandatory dependencies:
- [numpy][1]
- [numba][2]
- [Py-ART][3] 

[1]: http://www.scipy.org/
[2]: http://numba.pydata.org
[3]: https://github.com/ARM-DOE/pyart

# References:

Louf, V., Protat, A., Jackson, R. C., Collis, S. M., & Helmus, J. (2020). UNRAVEL: A Robust Modular Velocity Dealiasing Technique For Doppler Radar. Journal of Atmospheric and Oceanic Technology, 4(1), 741–758. [https://doi.org/10.1175/jtech-d-19-0020.1]
