doppy 0.2.3__cp310-abi3-win_amd64.whl → 0.3.0__cp310-abi3-win_amd64.whl

doppy/netcdf.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import warnings
+from types import TracebackType
 from typing import Literal, TypeAlias
 
 import netCDF4
@@ -13,14 +15,29 @@ 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
 
-    def add_atribute(self, key: str, val: str) -> Dataset:
+    def add_attribute(self, key: str, val: str) -> Dataset:
         setattr(self.nc, key, val)
         return self
 
+    def add_atribute(self, key: str, val: str) -> Dataset:
+        warnings.warn("Use add_attribute", DeprecationWarning, stacklevel=2)
+        return self.add_attribute(key, val)
+
     def add_time(
         self,
         name: str,

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.py

@@ -142,7 +142,7 @@ def _compute_beta(
     c
         speed of light
     B
-        reveiver bandwidth
+        receiver bandwidth
 
     References
     ----------
@@ -560,7 +560,7 @@ def _select_raws_for_stare(
 
 
 def _selection_key(raw: doppy.raw.HaloHpl) -> SelectionGroupKeyType:
-    return (raw.header.mergable_hash(),)
+    return (raw.header.mergeable_hash(),)
 
 
 def _time2bg_time(

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):
+            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):
+            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/product/wind.py

@@ -406,7 +406,7 @@ def _selection_key(raw: doppy.raw.HaloHpl) -> SelectionGroupKeyType:
     if len(raw.elevation_angles) != 1:
         raise ValueError("Expected only one elevation angle")
     return (
-        raw.header.mergable_hash(),
+        raw.header.mergeable_hash(),
         next(iter(raw.elevation_angles)),
         tuple(sorted(raw.azimuth_angles)),
     )

doppy/raw/halo_hpl.py

@@ -207,7 +207,7 @@ class HaloHplHeader:
     system_id: str
     instrument_spectral_width: float | None
 
-    def mergable_hash(self) -> int:
+    def mergeable_hash(self) -> int:
         return hash(
             (
                 self.gate_points,

doppy/raw/halo_sys_params.py

@@ -81,7 +81,7 @@ def _from_src(data: BufferedIOBase) -> HaloSysParams:
     b = [r.split(b"\t") for r in a]
     arr = np.array(b)
     if arr.shape[1] != 7:
-        raise ValueError("Unexpected data fromat")
+        raise ValueError("Unexpected data format")
 
     def timestr2datetime64_12H(datetime_bytes: bytes) -> np.datetime64:
         return datetime64(

{doppy-0.2.3.dist-info → doppy-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: doppy
-Version: 0.2.3
+Version: 0.3.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -37,7 +37,7 @@ Project-URL: Repository, https://github.com/actris-cloudnet/doppy
 Project-URL: Changelog, https://github.com/actris-cloudnet/doppy/blob/main/CHANGELOG.md
 Project-URL: Bug Tracker, https://github.com/actris-cloudnet/doppy/issues
 
-# Doppy - Wind doppler lidar processing
+# Doppy – Doppler wind lidar processing
 
 [![CI](https://github.com/actris-cloudnet/doppy/actions/workflows/ci.yml/badge.svg)](https://github.com/actris-cloudnet/doppy/actions/workflows/ci.yml)
 [![PyPI version](https://badge.fury.io/py/doppy.svg)](https://badge.fury.io/py/doppy)
@@ -129,8 +129,8 @@ stare = doppy.product.Stare.from_halo_data(
         data=stare.wavelength,
         dtype="f4",
     )
-    .add_atribute("serial_number", stare.system_id)
-    .add_atribute("doppy_version", doppy.__version__)
+    .add_attribute("serial_number", stare.system_id)
+    .add_attribute("doppy_version", doppy.__version__)
 ).close()
 
 ```

{doppy-0.2.3.dist-info → doppy-0.3.0.dist-info}/RECORD

@@ -1,8 +1,7 @@
-doppy-0.2.3.dist-info/METADATA,sha256=K2bCG_iuezFNxdkiO3No1sMSCvcrb1RgW-1hviAHHmQ,4239
-doppy-0.2.3.dist-info/WHEEL,sha256=q-xSG6XZRjDAnU09cWJDju_6rt60Z02Q6B2xMawZIOA,95
-doppy-0.2.3.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
-doppy-0.2.3.dist-info/license_files/LICENSE,sha256=RIAxFjJLTw0wQ3_SM73JoTeppoD99DJJ72cjvVuRrW4,1110
-doppy-0.2.3.dist-info/license_files/LICENSE,sha256=RIAxFjJLTw0wQ3_SM73JoTeppoD99DJJ72cjvVuRrW4,1110
+doppy-0.3.0.dist-info/METADATA,sha256=Ev5A4AsPf6a-OyhbGFn5cqIK8XHRDmwYFMGg2mnHWEE,4243
+doppy-0.3.0.dist-info/WHEEL,sha256=ooo3OLxJB34JFfOmPzfiM9QlB2wmB_Cl3_kcSm8NkLg,95
+doppy-0.3.0.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
+doppy-0.3.0.dist-info/license_files/LICENSE,sha256=RIAxFjJLTw0wQ3_SM73JoTeppoD99DJJ72cjvVuRrW4,1110
 doppy/bench.py,sha256=fLN2iS5mmoYH4qZjD80Vl1h9lp3C-KDfhj9fteWRPtM,260
 doppy/data/api.py,sha256=c3zbZI3IV7HnzhyFzJpUPOFT20eYFuQlJ5K_1ZEe1Pg,1921
 doppy/data/cache.py,sha256=VNPB3XsWGwY2bNXBs1r_sEWF4qBq_U7sJSlSmt1Rxm8,1033
@@ -10,20 +9,21 @@ doppy/data/exceptions.py,sha256=JOyekvUO-Ew4ZVezf3_IxZOrPN0IksfUILd8R2YcSts,95
 doppy/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 doppy/defaults.py,sha256=nhxcZcFd2jyDVbq0azwtekEJEjiz8k21MZmXFlSXAjo,40
 doppy/exceptions.py,sha256=YNEyz4r0ObzZHZ9re83K3wZlR2CRI1GyhH0vvFGasgQ,148
-doppy/netcdf.py,sha256=UnuecY_yEijEDpsuOBCj3EGeWMXtyRIOlLAC1UVUVHY,3527
+doppy/netcdf.py,sha256=VkWGleFKef3bkWf2_LfCdJnR1LORIFc51cXDRoRdHFo,4023
 doppy/options.py,sha256=uyIKM_G2GtbmV6Gve8o13eIShQqUwsnYZ41mhX2ypGE,218
-doppy/product/stare.py,sha256=hJPGujuMiOM424XtbCWWEdnD21zl9qg4dgZXnT-CDfk,20521
-doppy/product/wind.py,sha256=JT4DAwE1hl7NbE53mkZl4a-5RQb30IlydzfpDwkOoZM,13454
-doppy/product/__init__.py,sha256=kHVF77la8tzWKKpiM9eNWT-eAkAUd4uwb0wJFp62QLk,177
+doppy/product/stare.py,sha256=sh2HuKEWa-gaWZCbjbozYFA0oRUZa4U3nG9FpgqtoKM,20522
+doppy/product/stare_depol.py,sha256=rSi1nxC9VqiTse4xu4E733iJJUq9IC2EXKa_n3dIUWA,2980
+doppy/product/wind.py,sha256=f52owv_pzfUDiMzLXv6IqHFWHWdLXmGUIgBCXjOhPnk,13455
+doppy/product/__init__.py,sha256=xoBEXuhid-bvoof5Ogzpt1dKIhJgNMRyrAinCqUOUUI,241
 doppy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 doppy/raw/halo_bg.py,sha256=9K7E9smahGOqDIYnA-9m-Di3QsDY0PR2FH4Yd_oYiEY,4951
-doppy/raw/halo_hpl.py,sha256=OMVa6K8TqUnhwE5w3w_qy5Qi_Vg6S2lHwKEaIq5iGG0,19006
-doppy/raw/halo_sys_params.py,sha256=L3cFf1jATLMkVf2ViSbrmom-rZu7dn1Nq1J354xO98A,4041
+doppy/raw/halo_hpl.py,sha256=VF8JQ_5N8adLsGNJOlhvKwz0LtNd4oCU76hETe5Vuhk,19007
+doppy/raw/halo_sys_params.py,sha256=nT9r4F-H0Rf5njee5rYzzLTCm7vm3N_pdJqrW6RtyK4,4041
 doppy/raw/windcube.py,sha256=h_kqlQf2Pz59xg5EVSROiUlcA2RQp2jkGIxohmN1QOE,10166
 doppy/raw/wls70.py,sha256=2OhjmQ1SoAmjN4npOKFH0eFLyo9RssO7sr-gOtxjAho,7622
 doppy/raw/__init__.py,sha256=J06q7iykSAWIif4XAxI1jOszkARvLFBR1eU-B9yUXMw,235
 doppy/utils.py,sha256=lENDTzMVjCOA15Va9WZ6cou-foL5bGbNt4-NbDcnXpc,223
 doppy/__init__.py,sha256=Af7_8p3oN1nTqS9fo0mVKVuiKf5CAEK69uQa32CSFBA,197
 doppy/__main__.py,sha256=38hIWWfanILuBBGorQiAaleSC4qYJoIxuzVBkxf7Dng,371
-doppy/rs.pyd,sha256=NmaCgG3Sfesud2Uz3Fp87vaMPm0nwV_y9qtVdrSUB7I,2112512
-doppy-0.2.3.dist-info/RECORD,,
+doppy/rs.pyd,sha256=-gldLueqXNJls_220C85maa0oidYpfxu2Gs-ovk1-tU,2100736
+doppy-0.3.0.dist-info/RECORD,,

{doppy-0.2.3.dist-info → doppy-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.6.0)
+Generator: maturin (1.7.0)
 Root-Is-Purelib: false
 Tag: cp310-abi3-win_amd64