pycontrails 0.54.0__cp312-cp312-win_amd64.whl → 0.54.2__cp312-cp312-win_amd64.whl

pycontrails/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.54.0'
-__version_tuple__ = version_tuple = (0, 54, 0)
+__version__ = version = '0.54.2'
+__version_tuple__ = version_tuple = (0, 54, 2)

pycontrails/core/aircraft_performance.py

@@ -4,14 +4,20 @@ from __future__ import annotations
 
 import abc
 import dataclasses
+import sys
 import warnings
 from typing import Any, Generic, NoReturn, overload
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 import numpy as np
 import numpy.typing as npt
-from overrides import overrides
 
 from pycontrails.core import flight, fuel
+from pycontrails.core.fleet import Fleet
 from pycontrails.core.flight import Flight
 from pycontrails.core.met import MetDataset
 from pycontrails.core.models import Model, ModelParams, interpolate_met
@@ -76,6 +82,10 @@ class AircraftPerformance(Model):
 
     source: Flight
 
+    @abc.abstractmethod
+    @overload
+    def eval(self, source: Fleet, **params: Any) -> Fleet: ...
+
     @abc.abstractmethod
     @overload
     def eval(self, source: Flight, **params: Any) -> Flight: ...
@@ -118,7 +128,7 @@ class AircraftPerformance(Model):
             Flight trajectory with aircraft performance data.
         """
 
-    @overrides
+    @override
     def set_source_met(self, *args: Any, **kwargs: Any) -> None:
         fill_with_isa = self.params["fill_low_altitude_with_isa_temperature"]
         if fill_with_isa and (self.met is None or "air_temperature" not in self.met):
@@ -467,10 +477,11 @@ class AircraftPerformance(Model):
             tas[cond] = self.source.segment_groundspeed()[cond]
             return tas
 
-        met_incomplete = (
-            self.met is None or "eastward_wind" not in self.met or "northward_wind" not in self.met
+        wind_available = ("eastward_wind" in self.source and "northward_wind" in self.source) or (
+            self.met is not None and "eastward_wind" in self.met and "northward_wind" in self.met
         )
-        if met_incomplete:
+
+        if not wind_available:
             if fill_with_groundspeed:
                 tas = self.source.segment_groundspeed()
                 self.source["true_airspeed"] = tas

pycontrails/core/cache.py

@@ -7,14 +7,18 @@ import logging
 import os
 import pathlib
 import shutil
+import sys
 import warnings
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
 from typing import TYPE_CHECKING, Any
 
-logger = logging.getLogger(__name__)
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
 
-from overrides import overrides
+logger = logging.getLogger(__name__)
 
 from pycontrails.utils import dependencies
 
@@ -203,20 +207,20 @@ class DiskCacheStore(CacheStore):
         return f"DiskCacheStore: {self.cache_dir}"
 
     @property
-    @overrides
+    @override
     def size(self) -> float:
         disk_path = pathlib.Path(self.cache_dir)
         size = sum(f.stat().st_size for f in disk_path.rglob("*") if f.is_file())
         logger.debug("Disk cache size %s bytes", size)
         return size / 1e6
 
-    @overrides
+    @override
     def listdir(self, path: str = "") -> list[str]:
         path = self.path(path)
         iter_ = pathlib.Path(path).iterdir()
         return sorted(str(f.relative_to(path)) for f in iter_)
 
-    @overrides
+    @override
     def path(self, cache_path: str) -> str:
         if cache_path.startswith(self.cache_dir):
             disk_path = pathlib.Path(cache_path)
@@ -228,7 +232,7 @@ class DiskCacheStore(CacheStore):
 
         return str(disk_path)
 
-    @overrides
+    @override
     def exists(self, cache_path: str) -> bool:
         disk_path = pathlib.Path(self.path(cache_path))
         return disk_path.exists()
@@ -551,7 +555,7 @@ class GCPCacheStore(CacheStore):
         return self._client
 
     @property
-    @overrides
+    @override
     def size(self) -> float:
         # get list of blobs below this path
         blobs = self._bucket.list_blobs(prefix=self.cache_dir)
@@ -559,7 +563,7 @@ class GCPCacheStore(CacheStore):
         logger.debug("GCP cache size %s bytes", size)
         return size / 1e6
 
-    @overrides
+    @override
     def listdir(self, path: str = "") -> list[str]:
         # I don't necessarily think we want to implement this .... it might be
         # very slow if the bucket is large. BUT, it won't be slower than the size
@@ -572,7 +576,7 @@ class GCPCacheStore(CacheStore):
             "list files in the local disk cache."
         )
 
-    @overrides
+    @override
     def path(self, cache_path: str) -> str:
         if cache_path.startswith(self.cache_dir):
             return cache_path
@@ -604,7 +608,7 @@ class GCPCacheStore(CacheStore):
         bucket_path = self.path(cache_path)
         return f"gs://{self.bucket}/{bucket_path}"
 
-    @overrides
+    @override
     def exists(self, cache_path: str) -> bool:
         # see if file is in the mirror disk cache
         if self._disk_cache.exists(cache_path):

pycontrails/core/fleet.py

@@ -2,14 +2,24 @@
 
 from __future__ import annotations
 
+import sys
 import warnings
 from collections.abc import Iterable
 from typing import Any, NoReturn
 
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 import numpy as np
 import numpy.typing as npt
 import pandas as pd
-from overrides import overrides
 
 from pycontrails.core.flight import Flight
 from pycontrails.core.fuel import Fuel, JetA
@@ -121,13 +131,13 @@ class Fleet(Flight):
 
         return final_waypoints, fl_attrs
 
-    @overrides
+    @override
     def copy(self, **kwargs: Any) -> Fleet:
         kwargs.setdefault("fuel", self.fuel)
         kwargs.setdefault("fl_attrs", self.fl_attrs)
         return super().copy(**kwargs)
 
-    @overrides
+    @override
     def filter(self, mask: npt.NDArray[np.bool_], copy: bool = True, **kwargs: Any) -> Fleet:
         kwargs.setdefault("fuel", self.fuel)
 
@@ -137,7 +147,7 @@ class Fleet(Flight):
 
         return super().filter(mask, copy=copy, **kwargs)
 
-    @overrides
+    @override
     def sort(self, by: str | list[str]) -> NoReturn:
         msg = (
             "Fleet.sort is not implemented. A Fleet instance must be sorted "
@@ -154,7 +164,7 @@ class Fleet(Flight):
         broadcast_numeric: bool = True,
         copy: bool = True,
         attrs: dict[str, Any] | None = None,
-    ) -> Fleet:
+    ) -> Self:
         """Instantiate a :class:`Fleet` instance from an iterable of :class:`Flight`.
 
         .. versionchanged:: 0.49.3
@@ -196,17 +206,15 @@ class Fleet(Flight):
 
         fl_attrs: dict[str, Any] = {}
 
-        # Pluck from the first flight to get fuel, data_keys, and crs
+        # Pluck from the first flight to get fuel and data_keys
         fuel = seq[0].fuel
         data_keys = set(seq[0])  # convert to a new instance to because we mutate seq[0]
-        crs = seq[0].attrs["crs"]
 
         for fl in seq:
             _validate_fl(
                 fl,
                 fl_attrs=fl_attrs,
                 data_keys=data_keys,
-                crs=crs,
                 fuel=fuel,
                 broadcast_numeric=broadcast_numeric,
             )
@@ -316,44 +324,39 @@ class Fleet(Flight):
         # use case isn't seen.
         return np.concatenate(tas)
 
-    @overrides
+    @override
     def segment_groundspeed(self, *args: Any, **kwargs: Any) -> npt.NDArray[np.float64]:
-        # Implement if we have a usecase for this.
-        # Because the super() method uses a smoothing pattern, it will not reliably
-        # work on Fleet.
-        raise NotImplementedError
+        fls = self.to_flight_list(copy=False)
+        gs = [fl.segment_groundspeed(*args, **kwargs) for fl in fls]
+        return np.concatenate(gs)
 
-    @overrides
+    @override
     def resample_and_fill(self, *args: Any, **kwargs: Any) -> Fleet:
         flights = self.to_flight_list(copy=False)
         flights = [fl.resample_and_fill(*args, **kwargs) for fl in flights]
         return type(self).from_seq(flights, copy=False, broadcast_numeric=False, attrs=self.attrs)
 
-    @overrides
+    @override
     def segment_length(self) -> npt.NDArray[np.float64]:
         return np.where(self.final_waypoints, np.nan, super().segment_length())
 
     @property
-    @overrides
+    @override
     def max_distance_gap(self) -> float:
-        if self.attrs["crs"] != "EPSG:4326":
-            msg = "Only implemented for EPSG:4326 CRS."
-            raise NotImplementedError(msg)
-
         return np.nanmax(self.segment_length()).item()
 
-    @overrides
+    @override
     def segment_azimuth(self) -> npt.NDArray[np.float64]:
         return np.where(self.final_waypoints, np.nan, super().segment_azimuth())
 
-    @overrides
+    @override
     def segment_angle(self) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
         sin_a, cos_a = super().segment_angle()
         sin_a[self.final_waypoints] = np.nan
         cos_a[self.final_waypoints] = np.nan
         return sin_a, cos_a
 
-    @overrides
+    @override
     def clean_and_resample(
         self,
         freq: str = "1min",
@@ -400,7 +403,6 @@ def _validate_fl(
     *,
     fl_attrs: dict[str, Any],
     data_keys: set[str],
-    crs: str,
     fuel: Fuel,
     broadcast_numeric: bool,
 ) -> None:
@@ -419,8 +421,6 @@ def _validate_fl(
         Set of data keys expected in each flight.
     fuel : Fuel
         Fuel used all flights
-    crs : str
-        CRS to use all flights
     broadcast_numeric : bool
         If True, broadcast numeric attributes to data variables.
 
@@ -429,7 +429,7 @@ def _validate_fl(
     KeyError
         ``fl`` does not have a ``flight_id`` key in :attr:`attrs`.
     ValueError
-        If ``flight_id`` is duplicated or incompatible CRS found.
+        If ``flight_id`` is duplicated or if ``fuel`` or ``data_keys`` are inconsistent.
     """
     flight_id = _extract_flight_id(fl)
 
@@ -446,13 +446,6 @@ def _validate_fl(
             "The 'fuel' attributes must be consistent between flights in a Fleet."
         )
         raise ValueError(msg)
-    if fl.attrs["crs"] != crs:
-        msg = (
-            f"CRS on Flight {flight_id} ({fl.attrs['crs']}) "
-            f"is not inconsistent with previous flights ({crs}). "
-            "The 'crs' attributes must be consistent between flights in a Fleet."
-        )
-        raise ValueError(msg)
     if fl.data.keys() != data_keys:
         msg = (
             f"Data keys on Flight {flight_id} ({fl.data.keys()}) "

pycontrails/core/flight.py

@@ -4,14 +4,20 @@ from __future__ import annotations
 
 import enum
 import logging
+import sys
 import warnings
 from typing import TYPE_CHECKING, Any, NoReturn, TypeVar
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+
 import numpy as np
 import numpy.typing as npt
 import pandas as pd
 import scipy.signal
-from overrides import overrides
 
 from pycontrails.core.fuel import Fuel, JetA
 from pycontrails.core.vector import AttrDict, GeoVectorDataset, VectorDataDict, VectorDataset
@@ -75,9 +81,6 @@ class Flight(GeoVectorDataset):
     Expect altitude in [:math:`m`].
     Expect pressure level (`level`) in [:math:`hPa`].
 
-    Use the attribute :attr:`attrs["crs"]` to specify coordinate reference system
-    using `PROJ <https://proj.org/>`_ or `EPSG <https://epsg.org/home.html>`_ syntax.
-
     Parameters
     ----------
     data : dict[str, np.ndarray] | pd.DataFrame | VectorDataDict | VectorDataset | None
@@ -159,7 +162,7 @@ class Flight(GeoVectorDataset):
     ... })
     >>> fl = Flight(data=df, flight_id=123)  # specify a flight_id by keyword
     >>> fl
-    Flight [4 keys x 500 length, 2 attributes]
+    Flight [4 keys x 500 length, 1 attributes]
     Keys: longitude, latitude, altitude, time
     Attributes:
     time                [2021-01-01 10:00:00, 2021-01-01 15:00:00]
@@ -167,7 +170,6 @@ class Flight(GeoVectorDataset):
     latitude            [10.0, 40.0]
     altitude            [10500.0, 10500.0]
     flight_id           123
-    crs                 EPSG:4326
 
     >>> # Create `Flight` from keywords
     >>> fl = Flight(
@@ -177,14 +179,13 @@ class Flight(GeoVectorDataset):
     ...     time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200),
     ... )
     >>> fl
-    Flight [4 keys x 200 length, 1 attributes]
+    Flight [4 keys x 200 length, 0 attributes]
         Keys: longitude, latitude, time, altitude
         Attributes:
         time                [2021-01-01 12:00:00, 2021-01-01 14:00:00]
         longitude           [20.0, 30.0]
         latitude            [30.0, 40.0]
         altitude            [11000.0, 11000.0]
-        crs                 EPSG:4326
 
     >>> # Access the underlying data as DataFrame
     >>> fl.dataframe.head()
@@ -281,19 +282,19 @@ class Flight(GeoVectorDataset):
                     "'drop_duplicated_times=True' or call the 'resample_and_fill' method."
                 )
 
-    @overrides
+    @override
     def copy(self: FlightType, **kwargs: Any) -> FlightType:
         kwargs.setdefault("fuel", self.fuel)
         return super().copy(**kwargs)
 
-    @overrides
+    @override
     def filter(
         self: FlightType, mask: npt.NDArray[np.bool_], copy: bool = True, **kwargs: Any
     ) -> FlightType:
         kwargs.setdefault("fuel", self.fuel)
         return super().filter(mask, copy=copy, **kwargs)
 
-    @overrides
+    @override
     def sort(self, by: str | list[str]) -> NoReturn:
         msg = (
             "Flight.sort is not implemented. A Flight instance is automatically sorted "
@@ -369,11 +370,6 @@ class Flight(GeoVectorDataset):
         float
             Maximum distance between waypoints, [:math:`m`]
 
-        Raises
-        ------
-        NotImplementedError
-            Raises when attr:`attrs["crs"]` is not EPSG:4326
-
         Examples
         --------
         >>> import numpy as np
@@ -386,9 +382,6 @@ class Flight(GeoVectorDataset):
         >>> fl.max_distance_gap
         np.float64(7391.27...)
         """
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
-
         return self.segment_length()[:-1].max()
 
     @property
@@ -400,11 +393,6 @@ class Flight(GeoVectorDataset):
         float
             Total flight length, [:math:`m`]
 
-        Raises
-        ------
-        NotImplementedError
-            Raises when attr:`attrs["crs"]` is not EPSG:4326
-
         Examples
         --------
         >>> import numpy as np
@@ -417,9 +405,6 @@ class Flight(GeoVectorDataset):
         >>> fl.length
         np.float64(1436924.67...)
         """
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
-
         # drop off the nan
         return np.nansum(self.segment_length()[:-1])
 
@@ -461,11 +446,6 @@ class Flight(GeoVectorDataset):
         npt.NDArray[np.float64]
             Array of great circle distances in [:math:`m`] between waypoints
 
-        Raises
-        ------
-        NotImplementedError
-            Raises when attr:`attrs["crs"]` is not EPSG:4326
-
         Examples
         --------
         >>> from pycontrails import Flight
@@ -484,9 +464,6 @@ class Flight(GeoVectorDataset):
         :func:`segment_haversine`
         :meth:`segment_length`
         """
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
-
         return geo.segment_haversine(self["longitude"], self["latitude"])
 
     def segment_length(self) -> npt.NDArray[np.float64]:
@@ -500,11 +477,6 @@ class Flight(GeoVectorDataset):
         npt.NDArray[np.float64]
             Array of distances in [:math:`m`] between waypoints
 
-        Raises
-        ------
-        NotImplementedError
-            Raises when attr:`attrs["crs"]` is not EPSG:4326
-
         Examples
         --------
         >>> from pycontrails import Flight
@@ -522,9 +494,6 @@ class Flight(GeoVectorDataset):
         --------
         :func:`segment_length`
         """
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
-
         return geo.segment_length(self["longitude"], self["latitude"], self.altitude)
 
     def segment_angle(self) -> tuple[npt.NDArray[np.float64], npt.NDArray[np.float64]]:
@@ -1128,7 +1097,7 @@ class Flight(GeoVectorDataset):
 
         Notes
         -----
-        Algorithm is derived from :meth:`traffic.core.flight.Flight.filter`.
+        Algorithm is derived from :meth:`traffic.core.Flight.filter`.
 
         The `traffic
         <https://traffic-viz.github.io/api_reference/traffic.core.flight.html#traffic.core.Flight.filter>`_
@@ -1304,15 +1273,7 @@ class Flight(GeoVectorDataset):
         pd.DataFrame | None
             Generated waypoints to be merged into underlying :attr:`data`.
             Return `None` if no new waypoints are created.
-
-        Raises
-        ------
-        NotImplementedError
-            Raises when attr:`attrs["crs"]` is not EPSG:4326
         """
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
-
         # Omit the final nan and ensure index + 1 (below) is well defined
         segs = self.segment_haversine()[:-1]
 
@@ -1431,7 +1392,7 @@ class Flight(GeoVectorDataset):
         if key is not None and key not in self.dataframe.columns:
             raise KeyError(f"Column {key} does not exist in data.")
 
-        jump_indices = _antimeridian_index(pd.Series(self["longitude"]), self.attrs["crs"])
+        jump_indices = _antimeridian_index(pd.Series(self["longitude"]))
 
         def _group_to_feature(group: pd.DataFrame) -> dict[str, str | dict[str, Any]]:
             # assigns a different value to each group of consecutive indices
@@ -1464,19 +1425,21 @@ class Flight(GeoVectorDataset):
         return {"type": "FeatureCollection", "features": features}
 
     def to_traffic(self) -> traffic.core.Flight:
-        """Convert Flight instance to :class:`traffic.core.Flight` instance.
-
-        See https://traffic-viz.github.io/traffic.core.flight.html#traffic.core.Flight
+        """Convert to :class:`traffic.core.Flight`instance.
 
         Returns
         -------
-        :class:`traffic.core.Flight`
-            `traffic.core.Flight` instance
+        traffic.core.Flight
+            traffic flight instance
 
         Raises
         ------
         ModuleNotFoundError
             `traffic` package not installed
+
+        See Also
+        --------
+        :class:`traffic.core.Flight`
         """
         try:
             import traffic.core
@@ -1515,8 +1478,6 @@ class Flight(GeoVectorDataset):
         ------
         KeyError
             :attr:`data` does not contain column ``key``
-        NotImplementedError
-            Raised when ``attrs["crs"]`` is not EPSG:4326
 
         Examples
         --------
@@ -1557,8 +1518,6 @@ class Flight(GeoVectorDataset):
         """
         if key not in self.data:
             raise KeyError(f"Column {key} does not exist in data.")
-        if self.attrs["crs"] != "EPSG:4326":
-            raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
 
         # The column of interest may contain floating point values less than 1.
         # In this case, if the default threshold is not changed, warn the user that the behavior
@@ -1668,40 +1627,23 @@ def _return_linestring(data: dict[str, npt.NDArray[np.float64]]) -> list[list[fl
     return [list(p) for p in points]
 
 
-def _antimeridian_index(longitude: pd.Series, crs: str = "EPSG:4326") -> list[int]:
+def _antimeridian_index(longitude: pd.Series) -> list[int]:
     """Return indices after flight crosses antimeridian, or an empty list if flight does not cross.
 
+    This function assumes EPSG:4326 coordinates.
+
     Parameters
     ----------
     longitude : pd.Series
         longitude values with an integer index
-    crs : str, optional
-        Coordinate Reference system for longitude specified in EPSG format.
-        Currently only supports "EPSG:4326" and "EPSG:3857".
 
     Returns
     -------
     list[int]
         Indices after jump, or empty list of flight does not cross antimeridian.
-
-    Raises
-    ------
-    ValueError
-        CRS is not supported.
     """
-    # WGS84
-    if crs in ["EPSG:4326"]:
-        l1 = (-180.0, -90.0)
-        l2 = (90.0, 180.0)
-
-    # pseudo mercator
-    elif crs in ["EPSG:3857"]:
-        # values calculated through pyproj.Transformer
-        l1 = (-20037508.342789244, -10018754.171394622)
-        l2 = (10018754.171394622, 20037508.342789244)
-
-    else:
-        raise ValueError("CRS must be one of EPSG:4326 or EPSG:3857")
+    l1 = (-180.0, -90.0)
+    l2 = (90.0, 180.0)
 
     # TODO: When nans exist, this method *may* not find the meridian
     if np.any(np.isnan(longitude)):
@@ -1711,9 +1653,7 @@ def _antimeridian_index(longitude: pd.Series, crs: str = "EPSG:4326") -> list[in
     s2 = longitude.between(*l2)
     jump12 = longitude[s1 & s2.shift()]
     jump21 = longitude[s1.shift() & s2]
-    jump_index = pd.concat([jump12, jump21]).index.to_list()
-
-    return jump_index
+    return pd.concat([jump12, jump21]).index.to_list()
 
 
 def _sg_filter(
@@ -2045,18 +1985,18 @@ def filter_altitude(
 
     Notes
     -----
-    Algorithm is derived from :meth:`traffic.core.flight.Flight.filter`.
+    Algorithm is derived from :meth:`traffic.core.Flight.filter`.
 
-    The `traffic
+    The `traffic filter algorithm
     <https://traffic-viz.github.io/api_reference/traffic.core.flight.html#traffic.core.Flight.filter>`_
-    algorithm also computes thresholds on sliding windows
+    also computes thresholds on sliding windows
     and replaces unacceptable values with NaNs.
 
     Errors may raised if the ``kernel_size`` is too large.
 
     See Also
     --------
-    :meth:`traffic.core.flight.Flight.filter`
+    :meth:`traffic.core.Flight.filter`
     :func:`scipy.signal.medfilt`
     """
     if not len(altitude_ft):