<p align="center">
<img src="https://github.com/uobwatergroup/towerpy/blob/main/towerpy/towerpy_logosd.png?raw=true" alt="[towerpylogo]"/>
</p>
# :satellite: TOWERPY
Towerpy is an open-source toolbox designed for reading, processing and displaying polarimetric weather radar data.
<p align="left">
<img alt="Platforms" src="https://img.shields.io/badge/ =   OS    =-critical?style=for-the-badge" />
<img alt="linux" src="https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black"/>
<img alt="wdw" src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white"/>
</p>
<p align="left">
<img alt="tools" src="https://img.shields.io/badge/= Tools =-critical?style=for-the-badge" />
<img alt="plang1" src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white"/>
<img alt="plang2" src="https://img.shields.io/badge/C-00599C?style=for-the-badge&logo=c&logoColor=white"/>
<img alt="pt1" src="https://img.shields.io/badge/conda-342B029.svg?&style=for-the-badge&logo=anaconda&logoColor=white"/>
<img alt="pt5" src="https://img.shields.io/badge/Numpy-777BB4?style=for-the-badge&logo=numpy&logoColor=white"/>
<img alt="pt6" src="https://img.shields.io/badge/SciPy-654FF0?style=for-the-badge&logo=SciPy&logoColor=white"/>
</p>
<p align="left">
<img alt="info" src="https://img.shields.io/badge/=  Info =-critical?style=for-the-badge"/>
<a href="https://github.com/uobwatergroup/towerpy/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPL%20v3.0-yellow.svg?style=for-the-badge&logo=gnuprivacyguard"/></a>
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/uobwatergroup/towerpy?style=for-the-badge">
<a href="https://doi.org/10.1016/j.envsoft.2023.105746"><img src="https://img.shields.io/badge/DOI-10.1016/j.envsoft.2023.105746-important?style=for-the-badge&logo=creativecommons"/></a>
</p>
# :books: Documentation
[](https://towerpy.readthedocs.io/en/latest/?badge=latest)
You can find more details about _Towerpy_ [here](https://towerpy.readthedocs.io/en/latest/).
# :speech_balloon: Citing
If you find _towerpy_ useful for a scientific publication, please consider citing the [towerpy paper](https://doi.org/10.1016/j.envsoft.2023.105746):
BibTeX:
@article{sanchezrivas2023, title = {{Towerpy: An open-source toolbox for processing polarimetric weather radar data}},
journal = {Environmental Modelling & Software}, pages= {105746}, year = {2023}, issn = {1364-8152},
doi = {https://doi.org/10.1016/j.envsoft.2023.105746}, author = {Daniel Sanchez-Rivas and Miguel Angel Rico-Ramirez},
keywords = {Weather radar, Polarimetry, Radar QPE, Radar research applications, Open source}}
# :hammer: Installing towerpy
To ensure a smooth installation of towerpy, we strongly recommend using **conda**, the open-source Python package management system. [Download](https://www.anaconda.com/) and install Anaconda to get conda and other essential data science and machine learning packages.
Once Anaconda is installed and working, we recommend adding the [conda-forge channel](https://conda-forge.org/) to the top of the channel list::
conda config --add channels conda-forge
Strict channel priority can dramatically speed up conda operations and also reduce package incompatibility problems. We recommend setting channel priority to "strict" using::
conda config --set channel_priority strict
Create a new environment to install towerpy::
conda create -n towerpy python=3.10
Activate the new environment::
conda activate towerpy
Install the latest version of Towerpy by choosing ONE of the following options:
(1) Downloading and installing Towerpy from Anaconda.org::
conda install -c towerpy towerpy
(2) Downloading and installing Towerpy from GitHub (here we have the latest release)::
python -m pip install --upgrade git+https://github.com/uobwatergroup/towerpy.git@main
(3) Downloading and installing Towerpy from the Python Package Index (PyPI)::
python -m pip install towerpy-rd
Finally, install other additional dependencies helpful for scientific computing::
conda install -c conda-forge ipython jupyter sympy spyder scikit-learn wradlib
## Installing from source
Optionally, you can get the towerpy source code from the [GitHub repository](https://github.com/uobwatergroup/towerpy).
Either download and unpack the zip file of the source code or use git to clone the repository::
git clone https://github.com/uobwatergroup/towerpy.git
Once inside the folder where _towerpy_ was downloaded, it can be installed by using pip::
python -m pip install .
Or install Towerpy in “editable” mode::
python -m pip install -e .
# :snake: Dependencies
## The following dependencies are required to work with _towerpy_:
Package | Required
------------ | -------------
NumPy | v1.21+
SciPy | v1.7.1+
Matplotlib | v3.5.2+
Cartopy | v0.19+
netCDF4 | vv1.5.8+
\*Some modules within _towerpy_ run using shared objects/dynamic link libraries (.so, .dll). These libraries are automatically installed during the _towerpy_ installation.
# :thought_balloon: Missing a specific feature? Found a bug?
Feel free to post a message to our [discussions page](https://github.com/uobwatergroup/towerpy/discussions) or have a look at our [contribution guidelines](.github/CONTRIBUTING.md) to find out about our coding standards.
# :construction_worker: Team
Towerpy is created and maintained by
[Daniel Sanchez-Rivas](https://scholar.google.com/citations?user=NQSB5-8AAAAJ&hl=en)<a itemprop="sameAs" content="https://orcid.org/0000-0001-9356-6641" href="https://orcid.org/0000-0001-9356-6641" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"><img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon"></a></div> and [Miguel A Rico-Ramirez](https://research-information.bris.ac.uk/en/persons/miguel-a-rico-ramirez)<a itemprop="sameAs" content="https://orcid.org/0000-0002-8885-4582" href="https://orcid.org/0000-0002-8885-4582" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"><img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon"></a></div>
<p align="center">
<img alt="GitHub User's stars" src="https://img.shields.io/github/stars/uobwatergroup?style=social"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/uobwatergroup/towerpy">
</p>
[](https://stars.medv.io/uobwatergroup/towerpy)
Raw data
{
"_id": null,
"home_page": "https://github.com/uobwatergroup/towerpy",
"name": "towerpy-rd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Daniel Sanchez-Rivas and Miguel A Rico-Ramirez",
"author_email": "Daniel Sanchez-Rivas <towerpy@icloud.com>, Miguel A Rico-Ramirez <M.A.Rico-Ramirez@bristol.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/b1/ab/6e05c0a7f08704ea810c107c643ea043819d2781096a94e536d372cc60f6/towerpy-rd-1.0.5.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/uobwatergroup/towerpy/blob/main/towerpy/towerpy_logosd.png?raw=true\" alt=\"[towerpylogo]\"/>\n</p>\n\n# :satellite: TOWERPY\nTowerpy is an open-source toolbox designed for reading, processing and displaying polarimetric weather radar data.\n\n<p align=\"left\">\n <img alt=\"Platforms\" src=\"https://img.shields.io/badge/ =   OS    =-critical?style=for-the-badge\" />\n <img alt=\"linux\" src=\"https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black\"/>\n <img alt=\"wdw\" src=\"https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white\"/>\n</p>\n<p align=\"left\">\n <img alt=\"tools\" src=\"https://img.shields.io/badge/= Tools =-critical?style=for-the-badge\" />\n <img alt=\"plang1\" src=\"https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white\"/>\n <img alt=\"plang2\" src=\"https://img.shields.io/badge/C-00599C?style=for-the-badge&logo=c&logoColor=white\"/>\n <img alt=\"pt1\" src=\"https://img.shields.io/badge/conda-342B029.svg?&style=for-the-badge&logo=anaconda&logoColor=white\"/> \n <img alt=\"pt5\" src=\"https://img.shields.io/badge/Numpy-777BB4?style=for-the-badge&logo=numpy&logoColor=white\"/>\n <img alt=\"pt6\" src=\"https://img.shields.io/badge/SciPy-654FF0?style=for-the-badge&logo=SciPy&logoColor=white\"/>\n</p>\n<p align=\"left\">\n <img alt=\"info\" src=\"https://img.shields.io/badge/=  Info =-critical?style=for-the-badge\"/>\n <a href=\"https://github.com/uobwatergroup/towerpy/blob/main/LICENSE\"><img src=\"https://img.shields.io/badge/License-GPL%20v3.0-yellow.svg?style=for-the-badge&logo=gnuprivacyguard\"/></a>\n <img alt=\"GitHub release (latest SemVer)\" src=\"https://img.shields.io/github/v/release/uobwatergroup/towerpy?style=for-the-badge\">\n <a href=\"https://doi.org/10.1016/j.envsoft.2023.105746\"><img src=\"https://img.shields.io/badge/DOI-10.1016/j.envsoft.2023.105746-important?style=for-the-badge&logo=creativecommons\"/></a>\n \n</p>\n\n\n# :books: Documentation\n[](https://towerpy.readthedocs.io/en/latest/?badge=latest)\n\nYou can find more details about _Towerpy_ [here](https://towerpy.readthedocs.io/en/latest/).\n\n# :speech_balloon: Citing\nIf you find _towerpy_ useful for a scientific publication, please consider citing the [towerpy paper](https://doi.org/10.1016/j.envsoft.2023.105746):\n\nBibTeX:\n\n @article{sanchezrivas2023, title = {{Towerpy: An open-source toolbox for processing polarimetric weather radar data}},\n journal = {Environmental Modelling & Software}, pages= {105746}, year = {2023}, issn = {1364-8152},\n doi = {https://doi.org/10.1016/j.envsoft.2023.105746}, author = {Daniel Sanchez-Rivas and Miguel Angel Rico-Ramirez},\n keywords = {Weather radar, Polarimetry, Radar QPE, Radar research applications, Open source}}\n\n# :hammer: Installing towerpy\nTo ensure a smooth installation of towerpy, we strongly recommend using **conda**, the open-source Python package management system. [Download](https://www.anaconda.com/) and install Anaconda to get conda and other essential data science and machine learning packages.\n\nOnce Anaconda is installed and working, we recommend adding the [conda-forge channel](https://conda-forge.org/) to the top of the channel list::\n\n conda config --add channels conda-forge\n\nStrict channel priority can dramatically speed up conda operations and also reduce package incompatibility problems. We recommend setting channel priority to \"strict\" using::\n\n conda config --set channel_priority strict\n\nCreate a new environment to install towerpy::\n \n conda create -n towerpy python=3.10\n\nActivate the new environment::\n\n conda activate towerpy\n\nInstall the latest version of Towerpy by choosing ONE of the following options:\n\n(1) Downloading and installing Towerpy from Anaconda.org::\n \n conda install -c towerpy towerpy\n\n(2) Downloading and installing Towerpy from GitHub (here we have the latest release):: \n\n python -m pip install --upgrade git+https://github.com/uobwatergroup/towerpy.git@main\n\n(3) Downloading and installing Towerpy from the Python Package Index (PyPI)::\n \n python -m pip install towerpy-rd\n\nFinally, install other additional dependencies helpful for scientific computing::\n\n conda install -c conda-forge ipython jupyter sympy spyder scikit-learn wradlib\n\n\n## Installing from source\n\nOptionally, you can get the towerpy source code from the [GitHub repository](https://github.com/uobwatergroup/towerpy). \n\nEither download and unpack the zip file of the source code or use git to clone the repository::\n\n git clone https://github.com/uobwatergroup/towerpy.git\n\nOnce inside the folder where _towerpy_ was downloaded, it can be installed by using pip::\n\n python -m pip install .\n\nOr install Towerpy in \u201ceditable\u201d mode::\n\n python -m pip install -e .\n\n# :snake: Dependencies\n\n## The following dependencies are required to work with _towerpy_:\n\nPackage | Required\n------------ | -------------\nNumPy | v1.21+\nSciPy | v1.7.1+\nMatplotlib | v3.5.2+\nCartopy | v0.19+\nnetCDF4 | vv1.5.8+\n\n\\*Some modules within _towerpy_ run using shared objects/dynamic link libraries (.so, .dll). These libraries are automatically installed during the _towerpy_ installation.\n\n\n# :thought_balloon: Missing a specific feature? Found a bug?\nFeel free to post a message to our [discussions page](https://github.com/uobwatergroup/towerpy/discussions) or have a look at our [contribution guidelines](.github/CONTRIBUTING.md) to find out about our coding standards.\n\n# :construction_worker: Team\nTowerpy is created and maintained by \n[Daniel Sanchez-Rivas](https://scholar.google.com/citations?user=NQSB5-8AAAAJ&hl=en)<a itemprop=\"sameAs\" content=\"https://orcid.org/0000-0001-9356-6641\" href=\"https://orcid.org/0000-0001-9356-6641\" target=\"orcid.widget\" rel=\"me noopener noreferrer\" style=\"vertical-align:top;\"><img src=\"https://orcid.org/sites/default/files/images/orcid_16x16.png\" style=\"width:1em;margin-right:.5em;\" alt=\"ORCID iD icon\"></a></div> and [Miguel A Rico-Ramirez](https://research-information.bris.ac.uk/en/persons/miguel-a-rico-ramirez)<a itemprop=\"sameAs\" content=\"https://orcid.org/0000-0002-8885-4582\" href=\"https://orcid.org/0000-0002-8885-4582\" target=\"orcid.widget\" rel=\"me noopener noreferrer\" style=\"vertical-align:top;\"><img src=\"https://orcid.org/sites/default/files/images/orcid_16x16.png\" style=\"width:1em;margin-right:.5em;\" alt=\"ORCID iD icon\"></a></div>\n\n<p align=\"center\">\n <img alt=\"GitHub User's stars\" src=\"https://img.shields.io/github/stars/uobwatergroup?style=social\"><img alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/uobwatergroup/towerpy\">\n</p>\n\n[](https://stars.medv.io/uobwatergroup/towerpy)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Towerpy: an open-source toolbox for processing polarimetric radar data",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/uobwatergroup/towerpy",
"article": "https://doi.org/10.1016/j.envsoft.2023.105746",
"documentation": "https://towerpy.readthedocs.io/en/latest/",
"repository": "https://github.com/uobwatergroup/towerpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69ac6f754a7e13f929e9bbe34dd7392ca452b17e893c1b38aa3aaeab46b1d26d",
"md5": "3c3358e94bc98be7711227b9aae89083",
"sha256": "eae24e7d18afb672ad85b998d5e5b9a6ea2054f123507290bac47a088ae98b89"
},
"downloads": -1,
"filename": "towerpy_rd-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c3358e94bc98be7711227b9aae89083",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2433760,
"upload_time": "2024-08-26T16:41:53",
"upload_time_iso_8601": "2024-08-26T16:41:53.732692Z",
"url": "https://files.pythonhosted.org/packages/69/ac/6f754a7e13f929e9bbe34dd7392ca452b17e893c1b38aa3aaeab46b1d26d/towerpy_rd-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1ab6e05c0a7f08704ea810c107c643ea043819d2781096a94e536d372cc60f6",
"md5": "d87151d0ff0b3c105daa348852e17999",
"sha256": "ab87adf719150bb27d45f5c8b9afc32cb28936876e161cc1da11ed6c84d61885"
},
"downloads": -1,
"filename": "towerpy-rd-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d87151d0ff0b3c105daa348852e17999",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17868488,
"upload_time": "2024-08-26T16:42:02",
"upload_time_iso_8601": "2024-08-26T16:42:02.205005Z",
"url": "https://files.pythonhosted.org/packages/b1/ab/6e05c0a7f08704ea810c107c643ea043819d2781096a94e536d372cc60f6/towerpy-rd-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 16:42:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uobwatergroup",
"github_project": "towerpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "towerpy-rd"
}
JSON
