https://github.com/syedhamidali/radarx
Xarray Based Radar Toolkit
https://github.com/syedhamidali/radarx
azimuth cappi plot ppi radar rhi
Last synced: 8 months ago
JSON representation
Xarray Based Radar Toolkit
- Host: GitHub
- URL: https://github.com/syedhamidali/radarx
- Owner: syedhamidali
- License: mit
- Created: 2024-09-04T20:18:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T13:19:06.000Z (9 months ago)
- Last Synced: 2025-02-01T11:11:09.582Z (8 months ago)
- Topics: azimuth, cappi, plot, ppi, radar, rhi
- Language: Python
- Homepage: https://radarx.readthedocs.io
- Size: 36.8 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Radarx
[](https://www.python.org/downloads/)
[](https://pypi.org/project/radarx/)
[](https://pypi.org/project/radarx/)
[](https://anaconda.org/conda-forge/radarx)
[](https://anaconda.org/conda-forge/radarx)
[](https://github.com/syedhamidali/radarx/actions/workflows/ci.yml)
[](https://github.com/syedhamidali/radarx/actions/workflows/upload_pypi.yml)
[](https://radarx.readthedocs.io/en/latest/?version=latest)
[](https://github.com/syedhamidali/radarx/blob/main/LICENSE)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
[](https://github.com/syedhamidali/radarx/actions/workflows/github-code-scanning/codeql)
[](https://www.codefactor.io/repository/github/syedhamidali/radarx)
[](https://codebeat.co/projects/github-com-syedhamidali-radarx-main)
[](https://codecov.io/gh/syedhamidali/radarx)
[](https://app.codacy.com/gh/syedhamidali/radarx/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
Radarx is a Python library built for radar data processing and visualization. The library integrates tightly with [xradar](https://xradar.readthedocs.io/en/latest/) and leverages [xarray](http://xarray.pydata.org/) and [DataTree](https://xarray.pydata.org/en/stable/related-projects/datree.html) structures to enable easy and efficient manipulation of radar sweeps and volume data.
[](https://www.repostatus.org/#beta)
> [!WARNING]
> **This project is currently in high development mode.**
> Features may change frequently, and some parts of the library may be incomplete or subject to change. Please proceed with caution.
## Key Features
- **Xradar Integration**: Uses [xradar](https://xradar.readthedocs.io/en/latest/) for reading radar data in different formats, providing a consistent interface for various radar types.
- **IMD Radar Data Support**: Special support for reading and processing IMD radar data in NetCDF format.
- **Volume Scanning**: Utilities to process radar sweeps and group them into complete volume scans.
- **Data Gridding**: Provides tools for converting radar data to regular Cartesian grids, supporting complex radar geometries.
- **Xarray and DataTree Structured Data**: Radar data is returned as [xarray](http://xarray.pydata.org/) datasets, organized into [DataTree](https://xarray.pydata.org/en/stable/related-projects/datree.html) structures for easy navigation and analysis.
## Installation
You can install `radarx` using conda from the `conda-forge` channel (recommended):
```bash
conda install -c conda-forge radarx
```
You can also install `radarx` via pip from PyPI:
```bash
python -m pip install radarx
```
Alternatively, you can install it from source by cloning the repository
and running:
```bash
git clone https://github.com/syedhamidali/radarx.git
cd radarx
python -m pip install .
```
## Usage
Here's a simple example of how to use Radarx with [xradar]{.title-ref}
to load and process a volume scan:
```python
import radarx as rx
# List of radar files
files = [
'radar_file1.nc',
'radar_file2.nc',
'radar_file3.nc'
]
# Read volume data using Radarx, with xradar integration
volume = rx.io.read_volume(files)
# Access a specific sweep or variable
dbz_data = volume['/volume_0']['DBZ']
```
Radarx leverages [xradar](https://xradar.readthedocs.io/en/latest/) to handle radar file formats and
integrates smoothly with [xarray](http://xarray.pydata.org/) and [DataTree](https://xarray.pydata.org/en/stable/related-projects/datree.html) for organizing and analyzing radar data.
## Xradar Integration
Radarx makes use of the powerful [xradar](https://xradar.readthedocs.io/en/latest/) library for radar data ingestion and format handling. This ensures that the package is flexible and can handle a variety of radar data formats, including ODIM_H5, Sigmet, and others. For more advanced users, [xradar](https://xradar.readthedocs.io/en/latest/) functionality can be directly accessed to extend Radarx\'s capabilities.
## Documentation
For full documentation, please visit the [Radarx
Documentation](https://github.com/syedhamidali/radarx).
## Contributing
Contributions are welcome! If you\'d like to contribute, please follow
the steps below:
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Write tests for your changes.
4. Submit a pull request.
Please ensure that your code passes the pre-commit hooks and test suite
before submitting your PR.
## License
Radarx is licensed under the MIT License. See the
[LICENSE](https://github.com/syedhamidali/radarx/blob/main/LICENSE) file
for more details.
## Authors
- Syed Hamid Ali