unravel


Nameunravel JSON
Version 1.3.1 PyPI version JSON
download
home_pagehttps://github.com/vlouf/dealias
SummaryA dealiasing technique for Doppler radar velocity.
upload_time2024-01-11 02:02:57
maintainer
docs_urlNone
authorValentin Louf
requires_python
license
keywords radar weather meteorology dealiasing doppler
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![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. UNRAVEL is an algorithm that does not need external reference velocity data, making it easily applicable. The proposed algorithm includes eleven core modules and two dealiasing strategies. UNRAVEL is an iterative algorithm. The goal is to build the dealiasing results starting with the strictest possible continuity tests in azimuth and range and, after each step, relaxing the parameters to include more results from a progressively growing number of reference points. UNRAVEL also has modules that perform 3D continuity checks. Thanks to this modular design, the number of dealiasing strategies can be expanded in order to optimise the dealiasing results.

## 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

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]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vlouf/dealias",
    "name": "unravel",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "radar weather meteorology dealiasing Doppler",
    "author": "Valentin Louf",
    "author_email": "valentin.louf@bom.gov.au",
    "download_url": "https://files.pythonhosted.org/packages/15/10/e3e5d959b5d53f575f921bda4860c10dc7156aa3f0eeb68208d3c550fdde/unravel-1.3.1.tar.gz",
    "platform": null,
    "description": "[![DOI](https://zenodo.org/badge/119326382.svg)](https://zenodo.org/badge/latestdoi/119326382)\n\n# UNRAVEL\n\nUNRAVEL (UNfold RAdar VELocity) is an open-source modular Doppler velocity dealiasing algorithm for weather radars. UNRAVEL is an algorithm that does not need external reference velocity data, making it easily applicable. The proposed algorithm includes eleven core modules and two dealiasing strategies. UNRAVEL is an iterative algorithm. The goal is to build the dealiasing results starting with the strictest possible continuity tests in azimuth and range and, after each step, relaxing the parameters to include more results from a progressively growing number of reference points. UNRAVEL also has modules that perform 3D continuity checks. Thanks to this modular design, the number of dealiasing strategies can be expanded in order to optimise the dealiasing results.\n\n## Changelog:\n\nVersion 1.2.5:\n- New box check using a fast and robust striding window algorithm, up to 10x faster for that function call.\nVersion 1.2.0:\n- Multiprocessing using `unravel_3D_pyart_multiproc`\n- Various optimization and speed up.\n\n## Installation\n\nThe easiest method for installing UNRAVEL is to use pip:\n\n```pip install unravel```\n\n## Dependencies\n\nMandatory dependencies:\n- [numpy][1]\n- [numba][2]\n- [Py-ART][3] \n\n[1]: http://www.scipy.org/\n[2]: http://numba.pydata.org\n[3]: https://github.com/ARM-DOE/pyart\n\n# References:\n\nLouf, 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\u2013758. [https://doi.org/10.1175/jtech-d-19-0020.1]\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A dealiasing technique for Doppler radar velocity.",
    "version": "1.3.1",
    "project_urls": {
        "Bug Reports": "https://github.com/vlouf/dealias/issues",
        "Homepage": "https://github.com/vlouf/dealias",
        "Source": "https://github.com/vlouf/dealias/"
    },
    "split_keywords": [
        "radar",
        "weather",
        "meteorology",
        "dealiasing",
        "doppler"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2f8a58a05749e1910787d88505e1e9ff471909b36e960a5752a9a07fc59bb622",
                "md5": "2df9e16b647d92aa52b791b7d3c4a04b",
                "sha256": "fe5a87d731738a3522563172ab194c330fff3389775be1407c908dbc5d4c7984"
            },
            "downloads": -1,
            "filename": "unravel-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2df9e16b647d92aa52b791b7d3c4a04b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22588,
            "upload_time": "2024-01-11T02:02:56",
            "upload_time_iso_8601": "2024-01-11T02:02:56.047464Z",
            "url": "https://files.pythonhosted.org/packages/2f/8a/58a05749e1910787d88505e1e9ff471909b36e960a5752a9a07fc59bb622/unravel-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1510e3e5d959b5d53f575f921bda4860c10dc7156aa3f0eeb68208d3c550fdde",
                "md5": "da68357e4fd31df1f057690693f0cb44",
                "sha256": "1fd0be9361dadc7fcff2faee8fea6829a8a75e34285c1755da36fe84a7eea5c6"
            },
            "downloads": -1,
            "filename": "unravel-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "da68357e4fd31df1f057690693f0cb44",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20009,
            "upload_time": "2024-01-11T02:02:57",
            "upload_time_iso_8601": "2024-01-11T02:02:57.529173Z",
            "url": "https://files.pythonhosted.org/packages/15/10/e3e5d959b5d53f575f921bda4860c10dc7156aa3f0eeb68208d3c550fdde/unravel-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-11 02:02:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vlouf",
    "github_project": "dealias",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "unravel"
}
        
Elapsed time: 0.16075s