pycontrails 0.54.10__tar.gz → 0.54.12__tar.gz

{pycontrails-0.54.10 → pycontrails-0.54.12}/.github/workflows/docs.yaml

@@ -31,7 +31,7 @@ jobs:
       - name: OS Dependencies
         run: sudo apt-get install -y pandoc
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -74,7 +74,7 @@ jobs:
           ls -la docs/_build/html
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: 'docs/_build/html/'
 

{pycontrails-0.54.10 → pycontrails-0.54.12}/.github/workflows/doctest.yaml

@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -51,7 +51,7 @@ jobs:
           credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT }}
 
       - name: Set up Cloud SDK
-        uses: google-github-actions/setup-gcloud@v2
+        uses: google-github-actions/setup-gcloud@v3.0.0
 
       # put bada files in the default location
       - name: BADA files

{pycontrails-0.54.10 → pycontrails-0.54.12}/.github/workflows/release.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: OS Dependencies
         run: sudo apt-get install -y curl jq
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Check main test status
         run: make main-test-status
@@ -34,13 +34,13 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
       # https://cibuildwheel.readthedocs.io/en/stable/options/#testing
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.23
+        uses: pypa/cibuildwheel@v3.1
         env:
           CIBW_BUILD: cp310-* cp311-* cp312-* cp313-*
           CIBW_SKIP: '*-win32 *-manylinux_i686 *-musllinux*'
@@ -69,7 +69,7 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -99,7 +99,7 @@ jobs:
 
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           path: artifacts
 
@@ -132,7 +132,7 @@ jobs:
 
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           path: artifacts
 

{pycontrails-0.54.10 → pycontrails-0.54.12}/.github/workflows/scorecard.yaml

@@ -27,10 +27,10 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Run OpenSSF Security Scorecard
-        uses: ossf/scorecard-action@v2.4.1
+        uses: ossf/scorecard-action@v2.4.2
         with:
           results_file: results.sarif
           results_format: sarif

{pycontrails-0.54.10 → pycontrails-0.54.12}/.github/workflows/test.yaml

@@ -42,7 +42,7 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -68,7 +68,7 @@ jobs:
           credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT }}
 
       - name: Set up Cloud SDK
-        uses: google-github-actions/setup-gcloud@v2
+        uses: google-github-actions/setup-gcloud@v3.0.0
 
       - name: Download BADA files
         timeout-minutes: 5  # `gcloud storage cp` occasionally hangs on windows

{pycontrails-0.54.10 → pycontrails-0.54.12}/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.54.12
+
+### Breaking changes
+
+- Update the formula used to compute the saturation vapor pressure over liquid water from Sonntag (1994) to [Murphy and Koop (2005)](https://doi.org/10.1256/qj.04.94). This improves consistency with [Ponsonby et al.](https://egusphere.copernicus.org/preprints/2025/egusphere-2025-1717/). Minor numerical differences may appear in models that depend on the saturation vapor pressure over liquid water (for example, applications involving the Schmidt-Appleman criterion). Users who wish to supply their own saturation vapor pressure function can monkey-patch `thermo.e_sat_liquid` and `thermo.e_sat_liquid_prime`.
+
+### Internals
+
+- Consolidate several `pycontrails.utils.types` type variables to speed up type checking. This has no effect on runtime behavior.
+
+## 0.54.11
+
+### Features
+
+- Add new `timesteps` parameter to the `DryAdvection` model. If provided, this parameter overrides the timesteps computed by the model. Providing `timesteps` and setting the `max_age` parameter to `None` allows the model to advect all waypoints to the specified times. This is useful for running advection simulations over a fixed time period rather than to a fixed age. The `timesteps` parameter is optional and defaults to `None`, in which case the model behaves as before.
+- Add new `time` parameter to `Flight.resample_and_fill`. If provided, flights will be resampled to times in `time` rather than to times computed based on `freq`. The `time` parameter is optional and defaults to `None`, in which case `Flight.resample_and_fill` behaves as before.
+
+### Fixes
+
+- Fix the `GOES` interface caching mechanism when a custom `goes_bucket` is provided. This allows users to cache both GOES-16 and GOES-18 data without conflicts.
+- Officially support the "scda" HRES stream (useful for forecast reference times 06Z and 18Z). Previously, this was implicitly assumed.
+- Fix an issue with how the `parse_atc_plan` method handles newline characters in the flightplan string.
+- Fix an issue with the `DryAdvection.eval` implementation in which a large temporal gap between waypoints caused the model to end prematurely.
+- Fix the error message emitted by `ACCF.eval` if the [`climaccf`](https://github.com/dlr-pa/climaccf) package is not installed. (The `climaccf` package can be installed with `pip install git+https://github.com/dlr-pa/climaccf.git`.)
+
+### Internals
+
+- Support [PEP 639](https://peps.python.org/pep-0639/).
+- Support [ruff 0.12.0](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md#0120).
+- Remove the `dep_license` optional dependency from the `dev` extras.
+
 ## 0.54.10
 
 ### Features

{pycontrails-0.54.10 → pycontrails-0.54.12}/Makefile

@@ -51,12 +51,6 @@ clean: docs-clean
 remove: clean
 	pip uninstall pycontrails
 
-licenses:
-	deplic .
-
-check-licenses:
-	deplic -c setup.cfg .
-
 # -----------
 # Extensions
 # -----------

{pycontrails-0.54.10/pycontrails.egg-info → pycontrails-0.54.12}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pycontrails
-Version: 0.54.10
+Version: 0.54.12
 Summary: Python library for modeling aviation climate impacts
 Author-email: "Contrails.org" <py@contrails.org>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Changelog, https://py.contrails.org/changelog.html
 Project-URL: Documentation, https://py.contrails.org
 Project-URL: Issues, https://github.com/contrailcirrus/pycontrails/issues
@@ -11,7 +11,6 @@ Project-URL: Repository, https://github.com/contrailcirrus/pycontrails
 Keywords: contrails,climate,aviation,geospatial
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -36,7 +35,6 @@ Requires-Dist: xarray>=2022.3
 Provides-Extra: complete
 Requires-Dist: pycontrails[ecmwf,gcp,gfs,jupyter,pyproj,sat,vis,zarr]; extra == "complete"
 Provides-Extra: dev
-Requires-Dist: dep_license; extra == "dev"
 Requires-Dist: fastparquet>=0.8; extra == "dev"
 Requires-Dist: ipdb>=0.13; extra == "dev"
 Requires-Dist: memory_profiler; extra == "dev"

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.54.10'
-__version_tuple__ = version_tuple = (0, 54, 10)
+__version__ = version = '0.54.12'
+__version_tuple__ = version_tuple = (0, 54, 12)
+
+__commit_id__ = commit_id = 'g5920a0c98'

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/core/flight.py

@@ -806,19 +806,24 @@ class Flight(GeoVectorDataset):
         nominal_rocd: float = constants.nominal_rocd,
         drop: bool = True,
         keep_original_index: bool = False,
+        time: npt.NDArray[np.datetime64] | None = None,
     ) -> Self:
         """Resample and fill flight trajectory with geodesics and linear interpolation.
 
-        Waypoints are resampled according to the frequency ``freq``. Values for :attr:`data`
-        columns ``longitude``, ``latitude``, and ``altitude`` are interpolated.
+        Waypoints are resampled according to the frequency ``freq`` or to the times in ``time``.
+        Values for :attr:`data` columns ``longitude``, ``latitude``, and ``altitude``
+        are interpolated.
 
-        Resampled waypoints will include all multiples of ``freq`` between the flight
-        start and end time. For example, when resampling to a frequency of 1 minute,
-        a flight that starts at 2020/1/1 00:00:59 and ends at 2020/1/1 00:01:01
+        When resampled based on ``freq``, waypoints will include all multiples of ``freq``
+        between the flight start and end time. For example, when resampling to a frequency of
+        1 minute, a flight that starts at 2020/1/1 00:00:59 and ends at 2020/1/1 00:01:01
         will return a single waypoint at 2020/1/1 00:01:00, whereas a flight that
         starts at 2020/1/1 00:01:01 and ends at 2020/1/1 00:01:59 will return an empty
         flight.
 
+        When resampled based on ``time``, waypoints will include all times between the
+        flight start and end time.
+
         Parameters
         ----------
         freq : str, optional
@@ -844,6 +849,9 @@ class Flight(GeoVectorDataset):
             Keep the original index of the :class:`Flight` in addition to the new
             resampled index. Defaults to ``False``.
             .. versionadded:: 0.45.2
+        time : npt.NDArray[np.datetime64], optional
+            Times to resample to. Will override ``freq`` if provided.
+            .. versionadded:: 0.54.11
 
         Returns
         -------
@@ -930,10 +938,10 @@ class Flight(GeoVectorDataset):
         if shift is not None:
             df["longitude"] = (df["longitude"] - shift) % 360.0
 
-        # STEP 5: Resample flight to freq
+        # STEP 5: Resample flight
         # Save altitudes to copy over - these just get rounded down in time.
         # Also get target sample indices
-        df, t = _resample_to_freq(df, freq)
+        df, t = _resample_to_freq_or_time(df, freq, time)
 
         if shift is not None:
             # We need to translate back to the original chart here
@@ -2129,13 +2137,14 @@ def segment_rocd(
     return T_correction * out  # type: ignore[return-value]
 
 
-def _resample_to_freq(df: pd.DataFrame, freq: str) -> tuple[pd.DataFrame, pd.DatetimeIndex]:
+def _resample_to_freq_or_time(
+    df: pd.DataFrame, freq: str, time: npt.NDArray[np.datetime64] | None
+) -> tuple[pd.DataFrame, pd.DatetimeIndex]:
     """Resample a DataFrame to a given frequency.
 
-    This function is used to resample a DataFrame to a given frequency. The new
-    index will include all the original index values and the new resampled-to-freq
-    index values. The "longitude" and "latitude" columns will be linearly interpolated
-    to the new index values.
+    This function is used to resample a DataFrame to a given frequency or a specified set of times.
+    The new index will include all the original index values and the new resampled index values.
+    The "longitude" and "latitude" columns will be linearly interpolated to the new index values.
 
     Parameters
     ----------
@@ -2145,6 +2154,8 @@ def _resample_to_freq(df: pd.DataFrame, freq: str) -> tuple[pd.DataFrame, pd.Dat
     freq : str
         Frequency to resample to. See :func:`pd.DataFrame.resample` for
         valid frequency strings.
+    time : pd.DatetimeIndex | None
+        Times to resample to. Overrides ``freq`` if not ``None``.
 
     Returns
     -------
@@ -2153,10 +2164,14 @@ def _resample_to_freq(df: pd.DataFrame, freq: str) -> tuple[pd.DataFrame, pd.Dat
     """
 
     # Manually create a new index that includes all the original index values
-    # and the resampled-to-freq index values.
-    t0 = df.index[0].ceil(freq)
-    t1 = df.index[-1]
-    t = pd.date_range(t0, t1, freq=freq, name="time")
+    # and the resampled index values
+    if time is None:
+        t0 = df.index[0].ceil(freq)
+        t1 = df.index[-1]
+        t = pd.date_range(t0, t1, freq=freq, name="time")
+    else:
+        mask = (time >= df.index[0]) & (time <= df.index[-1])
+        t = pd.DatetimeIndex(time[mask], name="time")
 
     concat_arr = np.concatenate([df.index, t])
     concat_arr = np.unique(concat_arr)

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/core/flightplan.py

@@ -97,8 +97,8 @@ def parse_atc_plan(atc_plan: str) -> dict[str, str]:
     --------
     :func:`to_atc_plan`
     """
-    atc_plan = atc_plan.replace("\r", "")
-    atc_plan = atc_plan.replace("\n", "")
+    atc_plan = atc_plan.replace("\r", " ")
+    atc_plan = atc_plan.replace("\n", " ")
     atc_plan = atc_plan.upper()
     atc_plan = atc_plan.strip()
 

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/core/met.py

@@ -522,7 +522,7 @@ class MetBase(ABC, Generic[XArrayType]):
         return self.data.__len__()
 
     @property
-    def attrs(self) -> dict[Hashable, Any]:
+    def attrs(self) -> dict[str, Any]:
         """Pass through to :attr:`self.data.attrs`."""
         return self.data.attrs
 

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/core/models.py

@@ -1311,7 +1311,11 @@ def update_param_dict(param_dict: dict[str, Any], new_params: dict[str, Any]) ->
             raise KeyError(msg) from None
 
         # Convenience: convert timedelta64-like params
-        if isinstance(old_value, np.timedelta64) and not isinstance(value, np.timedelta64):
+        if (
+            isinstance(old_value, np.timedelta64)
+            and not isinstance(value, np.timedelta64)
+            and value is not None
+        ):
             value = pd.to_timedelta(value).to_numpy()
 
         param_dict[param] = value

{pycontrails-0.54.10 → pycontrails-0.54.12}/pycontrails/core/polygon.py

@@ -238,7 +238,7 @@ def _contours_to_polygons(
                 latitude=latitude,
                 precision=precision,
                 buffer=buffer,
-                i=child_i,
+                i=child_i,  # type: ignore[arg-type]
             )
 
             candidate = shapely.Polygon(polygon.exterior, [h.exterior for h in holes])