gpmmatch 1.5.4__tar.gz

gpmmatch-1.5.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Valentin Louf
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gpmmatch-1.5.4/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: gpmmatch
+Version: 1.5.4
+Summary: Volume matching of ground radar and GPM satellite data.
+Author-email: Valentin Louf <valentin.louf@bom.gov.au>
+License: Apache-2.0
+Project-URL: Documentation, https://github.com/vlouf/gpmmatch#readme
+Project-URL: Source, https://github.com/vlouf/gpmmatch
+Project-URL: Tracker, https://github.com/vlouf/gpmmatch/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software 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
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pandas
+Requires-Dist: h5py
+Requires-Dist: netCDF4
+Requires-Dist: xarray
+Requires-Dist: pyodim
+Requires-Dist: pyproj
+Dynamic: license-file
+
+# 🛰️ gpmmatch 🛰️
+
+gpmmatch is a Python library for matching satellite and ground-based radar volumes. It is primarily designed for use with GPM (Global Precipitation Measurement) data, but also supports the latest TRMM (Tropical Rainfall Measuring Mission) products.
+
+## ⚠️ Branch and Radar Format Compatibility
+
+> **Important Notice on Branch Usage and Radar Format Support**
+
+The `master` branch of this repository uses **`pyodim`** for radar data I/O and is **only compatible with ODIM HDF5 radar format**. This branch is used in **operational environments**, and **ODIM is the only officially supported radar format** for production use.
+
+If you are working with other radar formats (e.g., NEXRAD, UF, SIGMET, etc.), please use the `pyart` branch, which integrates with the **Py-ART** library and supports a wider range of radar data formats.
+
+| Branch   | Radar I/O Library | Supported Formats         | Intended Use            |
+|----------|-------------------|---------------------------|--------------------------|
+| `master` | `pyodim`          | ODIM only                 | Operational (official)   |
+| `pyart`  | `Py-ART`          | Multiple radar formats    | Research & development   |
+
+Please ensure you are using the appropriate branch and radar I/O backend for your application.
+
+---
+
+## 🚀 Installation
+
+Install gpmmatch directly from the repository:
+
+```bash
+pip install git+https://github.com/vlouf/gpmmatch.git
+```
+
+Or clone and install locally:
+
+```bash
+git clone https://github.com/vlouf/gpmmatch.git
+cd gpmmatch
+pip install .
+```
+
+## 🛠️ Dependencies
+
+The following Python libraries are required to use `gpmmatch` (automatically installed with the package):
+
+- `numpy` - Array operations and numerical computing
+- `scipy` - Scientific computing and spatial operations
+- `pandas` - Data manipulation and time handling
+- `h5py` - HDF5 file reading for GPM data
+- `netCDF4` - NetCDF file I/O
+- `xarray` - Multi-dimensional labeled arrays and datasets
+- `pyodim` - ODIM HDF5 radar format reader (master branch only)
+- `pyproj` - Cartographic projections and coordinate transformations
+
+**Python Version:** Requires Python 3.9 or later
+
+## ✨ Key Features
+
+- **Volume Matching**: Spatially and temporally match GPM satellite and ground radar observations
+- **Calibration Monitoring**: Real-time monitoring of weather radar network calibration using GPM as reference
+- **Phase-Aware DFR Conversion**: Advanced reflectivity conversion accounting for hydrometeor phase (ice, melting layer, liquid) using GPM bright band detection
+- **Attenuation Correction**: Built-in attenuation correction for C-band and X-band radars using:
+  - ZPHI method (preferred when KDP is available)
+  - Gunn-East method (fallback)
+- **Multi-Pass Processing**: Iterative volume matching with automatic offset computation and convergence detection
+- **Parallax Correction**: Automatic geometric correction for satellite viewing angle
+
+## 📓 Example Jupyter Notebook
+
+A comprehensive example Jupyter notebook is available in the [notebooks](notebooks/) directory:
+
+- **[notebooks/Example.ipynb](notebooks/Example.ipynb)**: Step-by-step tutorial demonstrating:
+  - How to perform volume matching of GPM data against ground radar data
+  - Downloading sample radar data from the Australian weather radar network archive
+  - Processing and analyzing the matched data
+  - Creating publication-quality plots using Matplotlib
+
+## 📖 Usage
+
+### Basic Volume Matching
+
+```python
+import gpmmatch
+
+# Perform volume matching
+matchset = gpmmatch.volume_matching(
+    gpmfile="GPM_data.HDF5",
+    grfile="radar_data.h5",
+    gr_beamwidth=1.0,
+    radar_band="C",
+    refl_name="DBZH",
+    fname_prefix="my_radar",
+    phase_aware_dfr=True,  # Use phase-aware DFR conversion
+    correct_attenuation=True  # Apply attenuation correction
+)
+```
+
+### Multi-Pass Processing with Offset Convergence
+
+```python
+# Multi-pass processing with automatic offset computation
+gpmmatch.vmatch_multi_pass(
+    gpmfile="GPM_data.HDF5",
+    grfile="radar_data.h5",
+    radar_band="C",
+    refl_name="DBZH",
+    fname_prefix="my_radar",
+    output_dir="./output",
+    offset_thld=0.5,  # Convergence threshold in dB
+    phase_aware_dfr=True
+)
+```
+
+### Key Parameters
+
+- `gpmfile`: Path to GPM HDF5 data file
+- `grfile`: Path to ground radar ODIM HDF5 file
+- `radar_band`: Radar frequency band ('S', 'C', or 'X')
+- `refl_name`: Name of reflectivity field in radar data (e.g., 'DBZH', 'corrected_reflectivity')
+- `gr_beamwidth`: Ground radar 3dB beamwidth in degrees
+- `phase_aware_dfr`: Enable phase-aware DFR conversion (recommended, default: True)
+- `correct_attenuation`: Apply attenuation correction for C/X-band (default: True)
+- `kdp_name`: Name of KDP field for ZPHI attenuation correction (default: 'KDP')
+
+## Citation
+
+If you use `gpmmatch` in your research, please cite the following paper:
+
+**Louf, Valentin, and Alain Protat**. *Real-Time Monitoring of Weather Radar Network Calibration and Antenna Pointing.* Journal of Atmospheric and Oceanic Technology, April 24, 2023. https://doi.org/10.1175/JTECH-D-22-0118.1.
+
+BibTeX:
+```bibtex
+@article {Louf2023,
+    author = "Valentin Louf and Alain Protat",
+    title = "Real-Time Monitoring of Weather Radar Network Calibration and Antenna Pointing",
+    journal = "Journal of Atmospheric and Oceanic Technology",
+    year = "2023",
+    publisher = "American Meteorological Society",    
+    volume = "40",
+    number = "7",
+    doi = "10.1175/JTECH-D-22-0118.1",
+    pages=  "823 - 844",    
+}
+```
+
+Other references for the reflectivity conversion:
+
+- Rain DFR: Louf, V., A. Protat, R. A. Warren, S. M. Collis, D. B. Wolff, S. Raunyiar, C. Jakob, and W. A. Petersen, 2019: An Integrated Approach to Weather Radar Calibration and Monitoring Using Ground Clutter and Satellite Comparisons. *J. Atmos. Oceanic Technol.*, **36**, 17–39, https://doi.org/10.1175/JTECH-D-18-0007.1
+
+- Ice scattering: Tyynelä, J., J. Leinonen, A. Moisseev, and T. Nousiainen, 2011: Radar Backscattering from Snowflakes: Comparison of Fractal, Aggregate, and Soft Spheroid Models. *J. Atmos. Oceanic Technol.*, **28**, 1365–1372, https://doi.org/10.1175/JTECH-D-11-00004.1
+
+- Ice scattering: Leinonen, J., 2014: High-level interface to T-matrix scattering calculations: architecture, capabilities and limitations. *Opt. Express*, **22**(2), 1655–1660, https://doi.org/10.1364/OE.22.001655
+
+- GPM bright band: Awaka, J., M. Le, V. Chandrasekar, N. Yoshida, T. Higashiuwatoko, T. Kubota, and T. Iguchi, 2016: Rain Type Classification Algorithm Module for GPM Dual-Frequency Precipitation Radar. *J. Atmos. Oceanic Technol.*, **33**, 1887–1898, https://doi.org/10.1175/JTECH-D-16-0016.1
+
+## License
+
+This library is open source and made freely available according to the below
+text:
+
+    Copyright 2020 Valentin Louf
+    Copyright 2023 Commonwealth of Australia, Bureau of Meteorology
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+A copy of the license is also provided in the LICENSE file included with the
+source distribution of the library.

gpmmatch-1.5.4/README.md

@@ -0,0 +1,173 @@
+# 🛰️ gpmmatch 🛰️
+
+gpmmatch is a Python library for matching satellite and ground-based radar volumes. It is primarily designed for use with GPM (Global Precipitation Measurement) data, but also supports the latest TRMM (Tropical Rainfall Measuring Mission) products.
+
+## ⚠️ Branch and Radar Format Compatibility
+
+> **Important Notice on Branch Usage and Radar Format Support**
+
+The `master` branch of this repository uses **`pyodim`** for radar data I/O and is **only compatible with ODIM HDF5 radar format**. This branch is used in **operational environments**, and **ODIM is the only officially supported radar format** for production use.
+
+If you are working with other radar formats (e.g., NEXRAD, UF, SIGMET, etc.), please use the `pyart` branch, which integrates with the **Py-ART** library and supports a wider range of radar data formats.
+
+| Branch   | Radar I/O Library | Supported Formats         | Intended Use            |
+|----------|-------------------|---------------------------|--------------------------|
+| `master` | `pyodim`          | ODIM only                 | Operational (official)   |
+| `pyart`  | `Py-ART`          | Multiple radar formats    | Research & development   |
+
+Please ensure you are using the appropriate branch and radar I/O backend for your application.
+
+---
+
+## 🚀 Installation
+
+Install gpmmatch directly from the repository:
+
+```bash
+pip install git+https://github.com/vlouf/gpmmatch.git
+```
+
+Or clone and install locally:
+
+```bash
+git clone https://github.com/vlouf/gpmmatch.git
+cd gpmmatch
+pip install .
+```
+
+## 🛠️ Dependencies
+
+The following Python libraries are required to use `gpmmatch` (automatically installed with the package):
+
+- `numpy` - Array operations and numerical computing
+- `scipy` - Scientific computing and spatial operations
+- `pandas` - Data manipulation and time handling
+- `h5py` - HDF5 file reading for GPM data
+- `netCDF4` - NetCDF file I/O
+- `xarray` - Multi-dimensional labeled arrays and datasets
+- `pyodim` - ODIM HDF5 radar format reader (master branch only)
+- `pyproj` - Cartographic projections and coordinate transformations
+
+**Python Version:** Requires Python 3.9 or later
+
+## ✨ Key Features
+
+- **Volume Matching**: Spatially and temporally match GPM satellite and ground radar observations
+- **Calibration Monitoring**: Real-time monitoring of weather radar network calibration using GPM as reference
+- **Phase-Aware DFR Conversion**: Advanced reflectivity conversion accounting for hydrometeor phase (ice, melting layer, liquid) using GPM bright band detection
+- **Attenuation Correction**: Built-in attenuation correction for C-band and X-band radars using:
+  - ZPHI method (preferred when KDP is available)
+  - Gunn-East method (fallback)
+- **Multi-Pass Processing**: Iterative volume matching with automatic offset computation and convergence detection
+- **Parallax Correction**: Automatic geometric correction for satellite viewing angle
+
+## 📓 Example Jupyter Notebook
+
+A comprehensive example Jupyter notebook is available in the [notebooks](notebooks/) directory:
+
+- **[notebooks/Example.ipynb](notebooks/Example.ipynb)**: Step-by-step tutorial demonstrating:
+  - How to perform volume matching of GPM data against ground radar data
+  - Downloading sample radar data from the Australian weather radar network archive
+  - Processing and analyzing the matched data
+  - Creating publication-quality plots using Matplotlib
+
+## 📖 Usage
+
+### Basic Volume Matching
+
+```python
+import gpmmatch
+
+# Perform volume matching
+matchset = gpmmatch.volume_matching(
+    gpmfile="GPM_data.HDF5",
+    grfile="radar_data.h5",
+    gr_beamwidth=1.0,
+    radar_band="C",
+    refl_name="DBZH",
+    fname_prefix="my_radar",
+    phase_aware_dfr=True,  # Use phase-aware DFR conversion
+    correct_attenuation=True  # Apply attenuation correction
+)
+```
+
+### Multi-Pass Processing with Offset Convergence
+
+```python
+# Multi-pass processing with automatic offset computation
+gpmmatch.vmatch_multi_pass(
+    gpmfile="GPM_data.HDF5",
+    grfile="radar_data.h5",
+    radar_band="C",
+    refl_name="DBZH",
+    fname_prefix="my_radar",
+    output_dir="./output",
+    offset_thld=0.5,  # Convergence threshold in dB
+    phase_aware_dfr=True
+)
+```
+
+### Key Parameters
+
+- `gpmfile`: Path to GPM HDF5 data file
+- `grfile`: Path to ground radar ODIM HDF5 file
+- `radar_band`: Radar frequency band ('S', 'C', or 'X')
+- `refl_name`: Name of reflectivity field in radar data (e.g., 'DBZH', 'corrected_reflectivity')
+- `gr_beamwidth`: Ground radar 3dB beamwidth in degrees
+- `phase_aware_dfr`: Enable phase-aware DFR conversion (recommended, default: True)
+- `correct_attenuation`: Apply attenuation correction for C/X-band (default: True)
+- `kdp_name`: Name of KDP field for ZPHI attenuation correction (default: 'KDP')
+
+## Citation
+
+If you use `gpmmatch` in your research, please cite the following paper:
+
+**Louf, Valentin, and Alain Protat**. *Real-Time Monitoring of Weather Radar Network Calibration and Antenna Pointing.* Journal of Atmospheric and Oceanic Technology, April 24, 2023. https://doi.org/10.1175/JTECH-D-22-0118.1.
+
+BibTeX:
+```bibtex
+@article {Louf2023,
+    author = "Valentin Louf and Alain Protat",
+    title = "Real-Time Monitoring of Weather Radar Network Calibration and Antenna Pointing",
+    journal = "Journal of Atmospheric and Oceanic Technology",
+    year = "2023",
+    publisher = "American Meteorological Society",    
+    volume = "40",
+    number = "7",
+    doi = "10.1175/JTECH-D-22-0118.1",
+    pages=  "823 - 844",    
+}
+```
+
+Other references for the reflectivity conversion:
+
+- Rain DFR: Louf, V., A. Protat, R. A. Warren, S. M. Collis, D. B. Wolff, S. Raunyiar, C. Jakob, and W. A. Petersen, 2019: An Integrated Approach to Weather Radar Calibration and Monitoring Using Ground Clutter and Satellite Comparisons. *J. Atmos. Oceanic Technol.*, **36**, 17–39, https://doi.org/10.1175/JTECH-D-18-0007.1
+
+- Ice scattering: Tyynelä, J., J. Leinonen, A. Moisseev, and T. Nousiainen, 2011: Radar Backscattering from Snowflakes: Comparison of Fractal, Aggregate, and Soft Spheroid Models. *J. Atmos. Oceanic Technol.*, **28**, 1365–1372, https://doi.org/10.1175/JTECH-D-11-00004.1
+
+- Ice scattering: Leinonen, J., 2014: High-level interface to T-matrix scattering calculations: architecture, capabilities and limitations. *Opt. Express*, **22**(2), 1655–1660, https://doi.org/10.1364/OE.22.001655
+
+- GPM bright band: Awaka, J., M. Le, V. Chandrasekar, N. Yoshida, T. Higashiuwatoko, T. Kubota, and T. Iguchi, 2016: Rain Type Classification Algorithm Module for GPM Dual-Frequency Precipitation Radar. *J. Atmos. Oceanic Technol.*, **33**, 1887–1898, https://doi.org/10.1175/JTECH-D-16-0016.1
+
+## License
+
+This library is open source and made freely available according to the below
+text:
+
+    Copyright 2020 Valentin Louf
+    Copyright 2023 Commonwealth of Australia, Bureau of Meteorology
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+A copy of the license is also provided in the LICENSE file included with the
+source distribution of the library.

gpmmatch-1.5.4/gpmmatch/__init__.py

@@ -0,0 +1,34 @@
+"""
+GPM volume matching package.
+
+Volume matching of ground radar and GPM satellite data.
+"""
+
+from .gpmmatch import (
+    NoRainError,
+    generate_filename,
+    get_radar_coordinates,
+    get_gr_reflectivity,
+    has_valid_data,
+    volume_matching,
+    vmatch_multi_pass,
+    MIN_SAMPLE_POINTS,
+    MIN_REFL_SAMPLES,
+    MAX_OFFSET_THRESHOLD,
+)
+
+__author__ = "Valentin Louf"
+__email__ = "valentin.louf@bom.gov.au"
+
+__all__ = [
+    "NoRainError",
+    "generate_filename",
+    "get_radar_coordinates",
+    "get_gr_reflectivity",
+    "has_valid_data",
+    "volume_matching",
+    "vmatch_multi_pass",
+    "MIN_SAMPLE_POINTS",
+    "MIN_REFL_SAMPLES",
+    "MAX_OFFSET_THRESHOLD",
+]