doppy 0.2.4__cp310-abi3-macosx_10_12_x86_64.whl → 0.3.1__cp310-abi3-macosx_10_12_x86_64.whl

doppy/netcdf.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import warnings
+from types import TracebackType
 from typing import Literal, TypeAlias
 
 import netCDF4
@@ -14,6 +15,17 @@ class Dataset:
     def __init__(self, filename: str) -> None:
         self.nc = netCDF4.Dataset(filename, mode="w")
 
+    def __enter__(self) -> Dataset:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        self.close()
+
     def add_dimension(self, dim: str) -> Dataset:
         self.nc.createDimension(dim, None)
         return self
@@ -23,7 +35,7 @@ class Dataset:
         return self
 
     def add_atribute(self, key: str, val: str) -> Dataset:
-        warnings.warn("Use add_attribute", DeprecationWarning)
+        warnings.warn("Use add_attribute", DeprecationWarning, stacklevel=2)
         return self.add_attribute(key, val)
 
     def add_time(

doppy/product/__init__.py

@@ -1,5 +1,6 @@
 from doppy.product.stare import Stare
+from doppy.product.stare_depol import StareDepol
 from doppy.product.wind import Options as WindOptions
 from doppy.product.wind import Wind
 
-__all__ = ["Stare", "Wind", "WindOptions"]
+__all__ = ["Stare", "StareDepol", "Wind", "WindOptions"]

doppy/product/stare_depol.py

@@ -0,0 +1,83 @@
+import numpy as np
+import numpy.typing as npt
+
+from doppy.product.stare import Stare
+
+
+class StareDepol:
+    """
+    Stare product with depolarisation ratio derived from co-polarised and
+    cross-polarised stare data.
+
+    Attributes:
+    -----------
+    time
+        An array of datetime64 objects representing the observation times.
+    radial_distance
+        An array of radial distances from the observation point, in meters.
+    elevation
+        An array of elevation angles corresponding to the observation points, in
+        degrees.
+    beta
+        An array of backscatter coefficients for the co-polarised signal, in
+        sr-1 m-1.
+    radial_velocity
+        An array of radial velocities of the co-polarised signal, in m s-1.
+    mask
+        A boolean array indicating signal (True) or noise (False) data points.
+    depolarisation
+        An array of depolarisation ratios calculated as the ratio of
+        co-polarised to cross-polarised backscatter coefficients.
+    wavelength
+        The wavelength of the lidar, in meters.
+    system_id
+        A string identifier for the lidar.
+
+    Raises
+    ------
+    ValueError
+        If the input `co` and `cross` products have mismatched wavelengths,
+        system IDs, radial distances, or elevation angles, this exception is
+        raised.
+    """
+
+    time: npt.NDArray[np.datetime64]
+    radial_distance: npt.NDArray[np.float64]
+    elevation: npt.NDArray[np.float64]
+    beta: npt.NDArray[np.float64]
+    radial_velocity: npt.NDArray[np.float64]
+    mask: npt.NDArray[np.bool_]
+    depolarisation: npt.NDArray[np.float64]
+    wavelength: float
+    system_id: str
+
+    def __init__(self, co: Stare, cross: Stare):
+        if co.wavelength != cross.wavelength:
+            raise ValueError(
+                "Different wavelength in co and cross: "
+                f"{co.wavelength} vs {cross.wavelength}"
+            )
+        if co.system_id != cross.system_id:
+            raise ValueError(
+                "Different system ID in co and cross: "
+                f"{co.system_id} vs {cross.system_id}"
+            )
+        if not np.allclose(co.radial_distance, cross.radial_distance, atol=1):
+            raise ValueError("Different radial distance in co and cross")
+
+        time_ind = np.argmin(np.abs(co.time - cross.time[:, np.newaxis]), axis=0)
+        cross_elevation = cross.elevation[time_ind]
+        cross_beta = cross.beta[time_ind, :]
+
+        if not np.allclose(co.elevation, cross_elevation, atol=1):
+            raise ValueError("Different elevation in co and cross")
+
+        self.time = co.time
+        self.radial_distance = co.radial_distance
+        self.elevation = co.elevation
+        self.beta = co.beta
+        self.radial_velocity = co.radial_velocity
+        self.mask = co.mask
+        self.depolarisation = cross_beta / co.beta
+        self.wavelength = co.wavelength
+        self.system_id = co.system_id

{doppy-0.2.4.dist-info → doppy-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: doppy
-Version: 0.2.4
+Version: 0.3.1
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10

{doppy-0.2.4.dist-info → doppy-0.3.1.dist-info}/RECORD

@@ -1,14 +1,15 @@
-doppy-0.2.4.dist-info/METADATA,sha256=v9HI3W9NwDiBFoi7WimE35gNO4zd4wddz1sg0JM_0Qo,4146
-doppy-0.2.4.dist-info/WHEEL,sha256=WrMW63pUH_1YC4fVPzaPa4OCS_WjDVtthurSO7B3-1Y,105
-doppy-0.2.4.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
-doppy-0.2.4.dist-info/license_files/LICENSE,sha256=V-0iroMNMI8ctnLgUau1kdFvwhkYhr9vi-5kWKxw2wc,1089
+doppy-0.3.1.dist-info/METADATA,sha256=Nf2a2FVs4bvMqXqdOC_ujt_9NbjU8TaTWppMiWpzyPA,4146
+doppy-0.3.1.dist-info/WHEEL,sha256=WrMW63pUH_1YC4fVPzaPa4OCS_WjDVtthurSO7B3-1Y,105
+doppy-0.3.1.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
+doppy-0.3.1.dist-info/license_files/LICENSE,sha256=V-0iroMNMI8ctnLgUau1kdFvwhkYhr9vi-5kWKxw2wc,1089
 doppy/options.py,sha256=73BDODO4OYHn2qOshhwz6u6G3J1kNd3uj6P0a3V4HBE,205
 doppy/__init__.py,sha256=Z9aEUlbPRWRUAoB8_-djkgrJuS4-6pjem4-mVSB6Z9I,191
 doppy/product/wind.py,sha256=MXm5HDoO3X6AzvpPHYPlpUXB_MYp_TBPP81aZ151wj8,13043
-doppy/product/__init__.py,sha256=DwTrvhMY_Eq-RG3H6Qyg_R_E9ie1wv0ofKr_1rSJ4Sk,172
+doppy/product/__init__.py,sha256=C6s9cX20m9UwRsKo1lZH6TnYFfM5KmsX5MPUyShbgl4,235
+doppy/product/stare_depol.py,sha256=5YVdyQof5eE8ous9duZS4nDt9VG0aQlgEPZ5t7KshM8,2913
 doppy/product/stare.py,sha256=jt1vHptufBFwUH5Un_0pk44eHKbAWnkhrU7HUI7gYJ4,19908
 doppy/bench.py,sha256=iVNYveMVGGRES2oe3Orsn31jQFCKTXOmxRFuFiJ8_OA,248
-doppy/netcdf.py,sha256=bGl3oeXtL04Qz0RR2mIdNYp-nWq-OI7_aR3oFfeezOc,3600
+doppy/netcdf.py,sha256=FX151GC8fuRhm-veg94BGeOWqszGn6nnWT9BxbzoSO8,3895
 doppy/utils.py,sha256=qPtIYBJPaKKTmRWwJI93TFUuhJg7CAoecpyHCm5ZyxI,214
 doppy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 doppy/exceptions.py,sha256=1tljrtzp0McQhB6INFXj4yfLjxj6mXor5jLF9HZjp1A,138
@@ -24,5 +25,5 @@ doppy/raw/halo_bg.py,sha256=kO03yGlKS-DpMMGHYuy_BuidyeUL38TxT5vMn8H_8lE,4809
 doppy/raw/halo_hpl.py,sha256=YFTepAWXvIfAVGgLZCadsc1d-VaOh7j2RB3cpb6Sv6k,18486
 doppy/raw/windcube.py,sha256=ZaOswQJbVDPBYj5oU1pTYmsX8F-mKIbjJRZmLYEMXP0,9906
 doppy/__main__.py,sha256=zrKQJVj0k0ypBQCGK65Czt9G9FZ_qx3ussw6Q9VJ14g,346
-doppy/rs.abi3.so,sha256=A4SR1Jcxog3RWyLdupKzTlIeoEU4YBSVVt4ubUAtSrI,2787456
-doppy-0.2.4.dist-info/RECORD,,
+doppy/rs.abi3.so,sha256=QL14vzujOQmSAm7m3ekkrpl5qZm5ke6l4ZL4Emhy3A0,2655056
+doppy-0.3.1.dist-info/RECORD,,