doppy 0.3.3__cp310-abi3-macosx_10_12_x86_64.whl → 0.3.5__cp310-abi3-macosx_10_12_x86_64.whl

doppy/exceptions.py

@@ -8,3 +8,7 @@ class RawParsingError(DoppyException):
 
 class NoDataError(DoppyException):
     pass
+
+
+class ShapeError(DoppyException):
+    pass

doppy/product/stare_depol.py

@@ -71,8 +71,6 @@ class StareDepol:
     radial_velocity: npt.NDArray[np.float64]
     mask: npt.NDArray[np.bool_]
     depolarisation: npt.NDArray[np.float64]
-    mask_depolarisation: npt.NDArray[np.bool_]
-    mask_beta_cross: npt.NDArray[np.bool_]
     polariser_bleed_through: float
     wavelength: float
     system_id: str
@@ -94,6 +92,12 @@ class StareDepol:
             The amount of bleed-through from the polariser.
         """
 
+        if co.beta.shape[1] != cross.beta.shape[1]:
+            raise doppy.exceptions.ShapeError(
+                "Range dimension mismatch in co and cross: "
+                f"{co.beta.shape[1]} vs {cross.beta.shape[1]}"
+            )
+
         if not np.isclose(co.wavelength, cross.wavelength):
             raise ValueError(
                 "Different wavelength in co and cross: "
@@ -107,12 +111,6 @@ class StareDepol:
         if not np.allclose(co.radial_distance, cross.radial_distance, atol=1):
             raise ValueError("Different radial distance in co and cross")
 
-        if co.beta.shape[1] != cross.beta.shape[1]:
-            raise ValueError(
-                "Range dimension mismatch in co and cross: "
-                f"{co.beta.shape[1]} vs {cross.beta.shape[1]}"
-            )
-
         ind = np.searchsorted(cross.time, co.time, side="left")
         pick_ind = ind < len(cross.time)
         time_diff_threshold = 2 * np.median(np.diff(co.time))
@@ -142,12 +140,18 @@ class StareDepol:
         self.radial_velocity = co.radial_velocity
         self.mask = co.mask
         self.depolarisation = depolarisation
-        self.mask_depolarisation = np.isnan(depolarisation)
-        self.mask_beta_cross = np.isnan(self.beta_cross)
         self.polariser_bleed_through = polariser_bleed_through
         self.wavelength = co.wavelength
         self.system_id = co.system_id
 
+    @property
+    def mask_depolarisation(self) -> npt.NDArray[np.bool_]:
+        return np.isnan(self.depolarisation)
+
+    @property
+    def mask_beta_cross(self) -> npt.NDArray[np.bool_]:
+        return np.isnan(self.beta_cross)
+
     @classmethod
     def from_halo_data(
         cls,

doppy/product/wind.py

@@ -34,6 +34,18 @@ class Wind:
     system_id: str
     options: Options | None
 
+    @property
+    def mask_zonal_wind(self) -> npt.NDArray[np.bool_]:
+        return np.isnan(self.zonal_wind)
+
+    @property
+    def mask_meridional_wind(self) -> npt.NDArray[np.bool_]:
+        return np.isnan(self.meridional_wind)
+
+    @property
+    def mask_vertical_wind(self) -> npt.NDArray[np.bool_]:
+        return np.isnan(self.vertical_wind)
+
     @functools.cached_property
     def horizontal_wind_speed(self) -> npt.NDArray[np.float64]:
         return np.sqrt(self.zonal_wind**2 + self.meridional_wind**2)
@@ -153,7 +165,7 @@ class Wind:
         elevation = np.array(elevation_list)
         wind = np.concatenate(wind_list)
         rmse = np.concatenate(rmse_list)
-        mask = _compute_mask(wind, rmse)
+        mask = _compute_mask(wind, rmse) | np.any(np.isnan(wind), axis=2)
         if not np.allclose(elevation, elevation[0]):
             raise ValueError("Elevation is expected to stay same")
         height = np.array(raw.height, dtype=np.float64)
@@ -241,6 +253,7 @@ class Wind:
                 dimensions=("time", "height"),
                 units="m s-1",
                 data=self.zonal_wind,
+                mask=self.mask_zonal_wind,
                 dtype="f4",
                 long_name="Non-screened zonal wind",
             )
@@ -249,7 +262,7 @@ class Wind:
                 dimensions=("time", "height"),
                 units="m s-1",
                 data=self.zonal_wind,
-                mask=self.mask,
+                mask=self.mask | self.mask_zonal_wind,
                 dtype="f4",
                 long_name="Zonal wind",
             )
@@ -258,6 +271,7 @@ class Wind:
                 dimensions=("time", "height"),
                 units="m s-1",
                 data=self.meridional_wind,
+                mask=self.mask_meridional_wind,
                 dtype="f4",
                 long_name="Non-screened meridional wind",
             )
@@ -266,7 +280,7 @@ class Wind:
                 dimensions=("time", "height"),
                 units="m s-1",
                 data=self.meridional_wind,
-                mask=self.mask,
+                mask=self.mask | self.mask_meridional_wind,
                 dtype="f4",
                 long_name="Meridional wind",
             )

doppy/raw/halo_bg.py

@@ -12,6 +12,8 @@ import numpy as np
 import numpy.typing as npt
 from numpy import datetime64
 
+from doppy.exceptions import RawParsingError
+
 
 @dataclass
 class HaloBg:
@@ -30,6 +32,28 @@ class HaloBg:
         | Sequence[tuple[bytes, str]]
         | Sequence[tuple[BufferedIOBase, str]],
     ) -> list[HaloBg]:
+        """
+        Creates a list of `HaloBg` instances from various data sources.
+
+        Parameters
+        ----------
+        data
+            A sequence of data source identifiers which can be file paths (as strings
+            or `Path` objects), tuples of raw byte data with filenames, or tuples of
+            buffered reader streams with filenames.
+
+        Returns
+        -------
+        list[HaloBg]
+            A list of `HaloBg` instances created from the provided data sources. Data
+            sources that cause a raw parsing error are ignored and not included in
+            the resulting list.
+
+        Raises
+        ------
+        TypeError
+            If `data` is not a list or tuple of supported types.
+        """
         if not isinstance(data, (list, tuple)):
             raise TypeError("data should be list or tuple")
         # TODO: rust reader and proper type checking
@@ -46,10 +70,13 @@ class HaloBg:
                 data_normalised.append(item)
             elif isinstance(item, tuple) and isinstance(item[0], BufferedIOBase):
                 data_normalised.append((item[0].read(), item[1]))
-        return [
-            HaloBg.from_src(data_bytes, filename)
-            for data_bytes, filename in data_normalised
-        ]
+        bgs = []
+        for data_bytes, filename in data_normalised:
+            try:
+                bgs.append(HaloBg.from_src(data_bytes, filename))
+            except RawParsingError:
+                continue
+        return bgs
 
     @classmethod
     def from_src(
@@ -124,9 +151,13 @@ def _from_src(data: BufferedIOBase, filename: str) -> HaloBg:
         try:
             signal = np.array(list(map(float, data_bytes.split(b"\r\n"))))[np.newaxis]
         except ValueError:
-            signal = np.array(
-                list(map(float, data_bytes.replace(b",", b".").split(b"\r\n")))
-            )[np.newaxis]
+            try:
+                signal = np.array(
+                    list(map(float, data_bytes.replace(b",", b".").split(b"\r\n")))
+                )[np.newaxis]
+            except ValueError as err:
+                raise RawParsingError(err) from err
+
     return HaloBg(time, signal)
 
 

doppy/raw/windcube.py

@@ -160,11 +160,14 @@ def _from_vad_src(nc: Dataset) -> WindCube:
     elevation_list = []
     range_list = []
     height_list = []
+    time_reference = (
+        nc["time_reference"][:] if "time_reference" in nc.variables else None
+    )
 
     for i, group in enumerate(
         nc[group] for group in (nc.variables["sweep_group_name"][:])
     ):
-        time_list.append(_extract_datetime64_or_raise(group["time"]))
+        time_list.append(_extract_datetime64_or_raise(group["time"], time_reference))
         radial_wind_speed_list.append(
             _extract_float64_or_raise(group["radial_wind_speed"])
         )
@@ -198,12 +201,21 @@ def _from_vad_src(nc: Dataset) -> WindCube:
     )
 
 
-def _extract_datetime64_or_raise(nc: Dataset) -> npt.NDArray[np.datetime64]:
+def _extract_datetime64_or_raise(
+    nc: Dataset, time_reference: str | None
+) -> npt.NDArray[np.datetime64]:
     match nc.name:
         case "time":
             if nc.dimensions != ("time",):
                 raise ValueError
-            return np.array(num2date(nc[:], units=nc.units), dtype="datetime64[us]")
+
+            units = nc.units
+            if "time_reference" in nc.units:
+                if time_reference is not None:
+                    units = nc.units.replace("time_reference", time_reference)
+                else:
+                    raise ValueError("Unknown time_reference")
+            return np.array(num2date(nc[:], units=units), dtype="datetime64[us]")
         case _:
             raise ValueError(f"Unexpected variable name {nc.name}")
 
@@ -216,7 +228,7 @@ def _extract_float64_or_raise(nc: Dataset) -> npt.NDArray[np.float64]:
             if nc.units != "dB":
                 raise ValueError(f"Unexpected units for {nc.name}")
             if nc[:].mask is not np.bool_(False):
-                raise ValueError
+                pass  # ignore that array contains masked values
             return np.array(nc[:].data, dtype=np.float64)
         case "radial_wind_speed":
             if nc.dimensions != ("time", "gate_index"):
@@ -224,7 +236,7 @@ def _extract_float64_or_raise(nc: Dataset) -> npt.NDArray[np.float64]:
             if nc.units != "m s-1":
                 raise ValueError(f"Unexpected units for {nc.name}")
             if nc[:].mask is not np.bool_(False):
-                raise ValueError
+                pass  # ignore that array contains masked values
             return np.array(nc[:].data, dtype=np.float64)
         case "radial_wind_speed_ci":
             if nc.dimensions != ("time", "gate_index"):
@@ -232,7 +244,7 @@ def _extract_float64_or_raise(nc: Dataset) -> npt.NDArray[np.float64]:
             if nc.units != "percent":
                 raise ValueError(f"Unexpected units for {nc.name}")
             if nc[:].mask is not np.bool_(False):
-                raise ValueError
+                pass  # ignore that array contains masked values
             return np.array(nc[:].data, dtype=np.float64)
         case "azimuth" | "elevation":
             if nc.dimensions != ("time",):

{doppy-0.3.3.dist-info → doppy-0.3.5.dist-info}/METADATA

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

{doppy-0.3.3.dist-info → doppy-0.3.5.dist-info}/RECORD

@@ -1,18 +1,18 @@
-doppy-0.3.3.dist-info/METADATA,sha256=wix5airh0vlAA1Yv-qT8ru4m5j382iQX69W0B90dotg,4175
-doppy-0.3.3.dist-info/WHEEL,sha256=5DSfM1TQ9gpjw2oUlJRyYVl2IqhTvHFIzdmuvKLQUkc,105
-doppy-0.3.3.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
-doppy-0.3.3.dist-info/licenses/LICENSE,sha256=V-0iroMNMI8ctnLgUau1kdFvwhkYhr9vi-5kWKxw2wc,1089
+doppy-0.3.5.dist-info/METADATA,sha256=Elbf8GWld1QLg3qAvBvl2_Wpp59I2nexthXgAaWXSfU,4175
+doppy-0.3.5.dist-info/WHEEL,sha256=5DSfM1TQ9gpjw2oUlJRyYVl2IqhTvHFIzdmuvKLQUkc,105
+doppy-0.3.5.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
+doppy-0.3.5.dist-info/licenses/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=RFa-msyn8ue5ty_da1rk2bkjoWo-aFtju9Lh89ekdeg,15503
+doppy/product/wind.py,sha256=dRXXBGRN5GY0ICqkdqEikS-UaKz0jM3V-qc6IKXMIPw,16030
 doppy/product/__init__.py,sha256=C6s9cX20m9UwRsKo1lZH6TnYFfM5KmsX5MPUyShbgl4,235
-doppy/product/stare_depol.py,sha256=Km0XeK2KDxIypsFsX5i2hT00shgg_eB0v1c_WGgx79M,9611
+doppy/product/stare_depol.py,sha256=thrWzCpvdH3AiA6gmR37vrH_pDACNY2QTtqPteJ2s8Y,9653
 doppy/product/stare.py,sha256=OD9Ff0IUVvRVR-KRIfOiWIQq3sC5KKhYtlmnif81HcU,22625
 doppy/bench.py,sha256=iVNYveMVGGRES2oe3Orsn31jQFCKTXOmxRFuFiJ8_OA,248
 doppy/netcdf.py,sha256=34TzB9UyypTwDpT2MfrRD14g2zGP3X-NuEU15mQGaUI,3925
 doppy/utils.py,sha256=qPtIYBJPaKKTmRWwJI93TFUuhJg7CAoecpyHCm5ZyxI,214
 doppy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-doppy/exceptions.py,sha256=1tljrtzp0McQhB6INFXj4yfLjxj6mXor5jLF9HZjp1A,138
+doppy/exceptions.py,sha256=OzdLXmKs3qZrvzwaI0pxjzpM2w9J5Of7dCo_Ekygecc,183
 doppy/defaults.py,sha256=-il4DWU1HPttlGFoVQTPC7R4pDZERoPvt3kw6xwMKrw,38
 doppy/data/cache.py,sha256=2rxmkWFn-FPy2LNGuCW2Vu4KKLBwIV9sb2gPBA-Jfck,996
 doppy/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,9 +21,9 @@ doppy/data/exceptions.py,sha256=6CS6OHIWq8CqlxiceEvC1j0EfWUYoIfM7dW88apQVn4,89
 doppy/raw/halo_sys_params.py,sha256=DeOIIRtVdO7HnNY3FaI4u035ScI65jfDgUrEccLepEo,3937
 doppy/raw/__init__.py,sha256=AMHyONuH0aUJUQz20EhlANaq9UjWJtSZf7kWUVx3ZjA,228
 doppy/raw/wls70.py,sha256=PMyr_JYTiKuYv1JpWHgVX6OA5zU83DOnr8vBCxFyFAw,7420
-doppy/raw/halo_bg.py,sha256=kO03yGlKS-DpMMGHYuy_BuidyeUL38TxT5vMn8H_8lE,4809
+doppy/raw/halo_bg.py,sha256=8t9j-SUF1yJht3vrT6KAYJQyxcg3W-0zr8h0jAEhWes,5815
 doppy/raw/halo_hpl.py,sha256=YFTepAWXvIfAVGgLZCadsc1d-VaOh7j2RB3cpb6Sv6k,18486
-doppy/raw/windcube.py,sha256=ZaOswQJbVDPBYj5oU1pTYmsX8F-mKIbjJRZmLYEMXP0,9906
+doppy/raw/windcube.py,sha256=MlN6glTwlfoqFL7ejehqQdRECMAt3Jt5nr5WO6MTCfg,10442
 doppy/__main__.py,sha256=zrKQJVj0k0ypBQCGK65Czt9G9FZ_qx3ussw6Q9VJ14g,346
-doppy/rs.abi3.so,sha256=4VS3G_TSsZ4W1Wvtc6etBjEGGFxkIUdy9P0tTjsIYHQ,2655056
-doppy-0.3.3.dist-info/RECORD,,
+doppy/rs.abi3.so,sha256=cLyiErRQtFlREptac0qEOGZDcDzikSHQebyE_AdHZKU,2655056
+doppy-0.3.5.dist-info/RECORD,,