pycontrails 0.54.2__cp312-cp312-macosx_11_0_arm64.whl → 0.54.4__cp312-cp312-macosx_11_0_arm64.whl

pycontrails/models/accf.py

@@ -88,13 +88,16 @@ class ACCFParams(ModelParams):
     h2o_scaling: float = 1.0
     o3_scaling: float = 1.0
 
-    forecast_step: float = 6.0
+    forecast_step: float | None = None
 
     sep_ri_rw: bool = False
 
     climate_indicator: str = "ATR"
 
-    horizontal_resolution: float = 0.5
+    #: The horizontal resolution of the meteorological data in degrees.
+    #: If None, it will be inferred from the ``met`` dataset for :class:`MetDataset`
+    #: source, otherwise it will be set to 0.5.
+    horizontal_resolution: float | None = None
 
     emission_scenario: str = "pulse"
 
@@ -116,6 +119,8 @@ class ACCFParams(ModelParams):
 
     PMO: bool = False
 
+    unit_K_per_kg_fuel: bool = False
+
 
 class ACCF(Model):
     """Compute Algorithmic Climate Change Functions (ACCF).
@@ -146,16 +151,13 @@ class ACCF(Model):
         SpecificHumidity,
         ecmwf.PotentialVorticity,
         Geopotential,
-        RelativeHumidity,
+        (RelativeHumidity, ecmwf.RelativeHumidity),
         NorthwardWind,
         EastwardWind,
-        ecmwf.PotentialVorticity,
     )
     sur_variables = (ecmwf.SurfaceSolarDownwardRadiation, ecmwf.TopNetThermalRadiation)
     default_params = ACCFParams
 
-    short_vars = frozenset(v.short_name for v in (*met_variables, *sur_variables))
-
     # This variable won't get used since we are not writing the output
     # anywhere, but the library will complain if it's not defined
     path_lib = "./"
@@ -168,7 +170,13 @@ class ACCF(Model):
         **params_kwargs: Any,
     ) -> None:
         # Normalize ECMWF variables
-        met = standardize_variables(met, self.met_variables)
+        variables = (v[0] if isinstance(v, tuple) else v for v in self.met_variables)
+        met = standardize_variables(met, variables)
+
+        # If relative humidity is in percentage, convert to a proportion
+        if met["relative_humidity"].attrs.get("units") == "%":
+            met.data["relative_humidity"] /= 100.0
+            met.data["relative_humidity"].attrs["units"] = "1"
 
         # Ignore humidity scaling warning
         with warnings.catch_warnings():
@@ -231,18 +239,21 @@ class ACCF(Model):
             if hasattr(self, "surface"):
                 self.surface = self.source.downselect_met(self.surface)
 
-        if isinstance(self.source, MetDataset):
-            # Overwrite horizontal resolution to match met
-            longitude = self.source.data["longitude"].values
-            if longitude.size > 1:
-                hres = abs(longitude[1] - longitude[0])
-                self.params["horizontal_resolution"] = float(hres)
-
-            else:
+        if self.params["horizontal_resolution"] is None:
+            if isinstance(self.source, MetDataset):
+                # Overwrite horizontal resolution to match met
+                longitude = self.source.data["longitude"].values
                 latitude = self.source.data["latitude"].values
-                if latitude.size > 1:
+                if longitude.size > 1:
+                    hres = abs(longitude[1] - longitude[0])
+                    self.params["horizontal_resolution"] = float(hres)
+                elif latitude.size > 1:
                     hres = abs(latitude[1] - latitude[0])
                     self.params["horizontal_resolution"] = float(hres)
+                else:
+                    self.params["horizontal_resolution"] = 0.5
+            else:
+                self.params["horizontal_resolution"] = 0.5
 
         p_settings = _get_accf_config(self.params)
 
@@ -267,10 +278,14 @@ class ACCF(Model):
         aCCFs, _ = clim_imp.get_xarray()
 
         # assign ACCF outputs to source
+        skip = {
+            v[0].short_name if isinstance(v, tuple) else v.short_name
+            for v in (*self.met_variables, *self.sur_variables)
+        }
         maCCFs = MetDataset(aCCFs)
         for key, arr in maCCFs.data.items():
             # skip met variables
-            if key in self.short_vars:
+            if key in skip:
                 continue
 
             assert isinstance(key, str)
@@ -292,7 +307,12 @@ class ACCF(Model):
         # It also needs variables to have the ECMWF short name
         if isinstance(self.met, MetDataset):
             ds_met = self.met.data.transpose("time", "level", "latitude", "longitude")
-            name_dict = {v.standard_name: v.short_name for v in self.met_variables}
+            name_dict = {
+                v[0].standard_name if isinstance(v, tuple) else v.standard_name: v[0].short_name
+                if isinstance(v, tuple)
+                else v.short_name
+                for v in self.met_variables
+            }
             ds_met = ds_met.rename(name_dict)
         else:
             ds_met = None
@@ -340,7 +360,7 @@ def _get_accf_config(params: dict[str, Any]) -> dict[str, Any]:
         "horizontal_resolution": params["horizontal_resolution"],
         "forecast_step": params["forecast_step"],
         "NOx_aCCF": True,
-        "NOx&inverse_EIs": params["nox_ei"],
+        "NOx_EI&F_km": params["nox_ei"],
         "output_format": "netCDF",
         "mean": False,
         "std": False,
@@ -361,6 +381,7 @@ def _get_accf_config(params: dict[str, Any]) -> dict[str, Any]:
             "H2O": params["h2o_scaling"],
             "O3": params["o3_scaling"],
         },
+        "unit_K/kg(fuel)": params["unit_K_per_kg_fuel"],
         "PCFA": params["pfca"],
         "PCFA-ISSR": {
             "rhi_threshold": params["issr_rhi_threshold"],

pycontrails/models/apcemm/apcemm.py

@@ -28,6 +28,7 @@ from pycontrails.core.met_var import (
     SpecificHumidity,
     VerticalVelocity,
 )
+from pycontrails.core.vector import GeoVectorDataset
 from pycontrails.models.apcemm import utils
 from pycontrails.models.apcemm.inputs import APCEMMInput
 from pycontrails.models.dry_advection import DryAdvection
@@ -276,13 +277,13 @@ class APCEMM(models.Model):
     """
 
     __slots__ = (
-        "apcemm_path",
+        "_trajectory_downsampling",
         "apcemm_input_params",
+        "apcemm_path",
         "cachestore",
+        "contrail",
         "trajectories",
         "vortex",
-        "contrail",
-        "_trajectory_downsampling",
     )
 
     name = "apcemm"
@@ -314,7 +315,7 @@ class APCEMM(models.Model):
     source: Flight
 
     #: Output from trajectory calculation
-    trajectories: Flight | None
+    trajectories: GeoVectorDataset | None
 
     #: Time series output from the APCEMM early plume model
     vortex: pd.DataFrame | None

pycontrails/models/cocip/__init__.py

@@ -15,9 +15,10 @@ from pycontrails.models.cocip.output_formats import (
 
 __all__ = [
     "Cocip",
+    "CocipFlightParams",
     "CocipParams",
     "CocipUncertaintyParams",
-    "CocipFlightParams",
+    "compare_cocip_with_goes",
     "contrail_flight_summary_statistics",
     "contrails_to_hi_res_grid",
     "flight_waypoint_summary_statistics",
@@ -25,5 +26,4 @@ __all__ = [
     "longitude_latitude_grid",
     "natural_cirrus_properties_to_hi_res_grid",
     "time_slice_statistics",
-    "compare_cocip_with_goes",
 ]

pycontrails/models/cocip/cocip.py

@@ -195,14 +195,14 @@ class Cocip(Model):
     """
 
     __slots__ = (
-        "rad",
+        "_downwash_contrail",
+        "_downwash_flight",
+        "_sac_flight",
         "contrail",
         "contrail_dataset",
         "contrail_list",
+        "rad",
         "timesteps",
-        "_sac_flight",
-        "_downwash_flight",
-        "_downwash_contrail",
     )
 
     name = "cocip"
@@ -660,7 +660,7 @@ class Cocip(Model):
             attrs = self.source.attrs
             attrs.pop("fl_attrs", None)
             attrs.pop("data_keys", None)
-            self.source = Fleet.from_seq(fls, broadcast_numeric=False, copy=False, attrs=attrs)
+            self.source = Fleet.from_seq(fls, broadcast_numeric=False, attrs=attrs)
 
         # Single flight
         else:
@@ -2055,9 +2055,9 @@ def calc_radiative_properties(contrail: GeoVectorDataset, params: dict[str, Any]
 
 def calc_contrail_properties(
     contrail: GeoVectorDataset,
-    effective_vertical_resolution: float | npt.NDArray[np.float64],
-    wind_shear_enhancement_exponent: float | npt.NDArray[np.float64],
-    sedimentation_impact_factor: float | npt.NDArray[np.float64],
+    effective_vertical_resolution: float | npt.NDArray[np.floating],
+    wind_shear_enhancement_exponent: float | npt.NDArray[np.floating],
+    sedimentation_impact_factor: float | npt.NDArray[np.floating],
     radiative_heating_effects: bool,
 ) -> None:
     """Calculate geometric and ice-related properties of contrail.
@@ -2084,11 +2084,11 @@ def calc_contrail_properties(
     ----------
     contrail : GeoVectorDataset
         Grid points with many precomputed keys.
-    effective_vertical_resolution : float | npt.NDArray[np.float64]
+    effective_vertical_resolution : float | npt.NDArray[np.floating]
         Passed into :func:`wind_shear.wind_shear_enhancement_factor`.
-    wind_shear_enhancement_exponent : float | npt.NDArray[np.float64]
+    wind_shear_enhancement_exponent : float | npt.NDArray[np.floating]
         Passed into :func:`wind_shear.wind_shear_enhancement_factor`.
-    sedimentation_impact_factor: float | npt.NDArray[np.float64]
+    sedimentation_impact_factor: float | npt.NDArray[np.floating]
         Passed into `contrail_properties.vertical_diffusivity`.
     radiative_heating_effects: bool
         Include radiative heating effects on contrail cirrus properties.
@@ -2296,8 +2296,7 @@ def calc_timestep_contrail_evolution(
     dt = time_2_array - time_1
 
     # get new contrail location & segment properties after t_step
-    longitude_2 = geo.advect_longitude(longitude_1, latitude_1, u_wind_1, dt)
-    latitude_2 = geo.advect_latitude(latitude_1, v_wind_1, dt)
+    longitude_2, latitude_2 = geo.advect_horizontal(longitude_1, latitude_1, u_wind_1, v_wind_1, dt)
     level_2 = geo.advect_level(level_1, vertical_velocity_1, rho_air_1, terminal_fall_speed_1, dt)
     altitude_2 = units.pl_to_m(level_2)
 
@@ -2526,8 +2525,8 @@ def calc_timestep_contrail_evolution(
 def _rad_accumulation_to_average_instantaneous(
     rad: MetDataset,
     name: str,
-    arr: npt.NDArray[np.float64],
-) -> npt.NDArray[np.float64]:
+    arr: npt.NDArray[np.floating],
+) -> npt.NDArray[np.floating]:
     """Convert from radiation accumulation to average instantaneous values.
 
     .. versionadded:: 0.48.0
@@ -2538,12 +2537,12 @@ def _rad_accumulation_to_average_instantaneous(
         Radiation data
     name : str
         Variable name
-    arr : npt.NDArray[np.float64]
+    arr : npt.NDArray[np.floating]
         Array of values already interpolated from ``rad``
 
     Returns
     -------
-    npt.NDArray[np.float64]
+    npt.NDArray[np.floating]
         Array of values converted from accumulation to average instantaneous values
 
     Raises

pycontrails/models/cocip/cocip_params.py

@@ -11,7 +11,7 @@ import numpy as np
 import numpy.typing as npt
 
 from pycontrails.core.aircraft_performance import AircraftPerformance
-from pycontrails.core.models import ModelParams
+from pycontrails.core.models import AdvectionBuffers
 from pycontrails.models.emissions.emissions import EmissionsParams
 from pycontrails.models.humidity_scaling import HumidityScaling
 
@@ -50,7 +50,7 @@ def _habits() -> npt.NDArray[np.str_]:
 
 
 @dataclasses.dataclass
-class CocipParams(ModelParams):
+class CocipParams(AdvectionBuffers):
     """Model parameters required by the CoCiP models."""
 
     # -------------------------
@@ -116,15 +116,6 @@ class CocipParams(ModelParams):
     #: evaluation after the met data is downselected.
     compute_tau_cirrus_in_model_init: bool | str = "auto"
 
-    #: Met longitude [WGS84] buffer for Cocip evolution.
-    met_longitude_buffer: tuple[float, float] = (10.0, 10.0)
-
-    #: Met latitude buffer [WGS84] for Cocip evolution.
-    met_latitude_buffer: tuple[float, float] = (10.0, 10.0)
-
-    #: Met level buffer [:math:`hPa`] for Cocip initialization and evolution.
-    met_level_buffer: tuple[float, float] = (40.0, 40.0)
-
     # ---------
     # Filtering
     # ---------

pycontrails/models/cocip/cocip_uncertainty.py

@@ -2,8 +2,8 @@
 
 from __future__ import annotations
 
+import dataclasses
 import logging
-from dataclasses import asdict, dataclass
 from typing import Any, ClassVar
 
 import numpy as np
@@ -70,7 +70,7 @@ class habit_dirichlet(rv_frozen):
         return habit_weights
 
 
-@dataclass
+@dataclasses.dataclass
 class CocipUncertaintyParams(CocipParams):
     """Model parameters for CoCiP epistemic uncertainty.
 
@@ -117,26 +117,30 @@ class CocipUncertaintyParams(CocipParams):
     #: Schumann takes ``wind_shear_enhancement_exponent`` = 0.5 and discusses the case of 0 and 2/3
     #: as possibilities.
     #: With a value of 0, wind shear is not enhanced.
-    wind_shear_enhancement_exponent_uncertainty: rv_frozen | None = stats.triang(
-        loc=0.0, c=CocipParams.wind_shear_enhancement_exponent, scale=1.0
+    wind_shear_enhancement_exponent_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.triang(
+            loc=0.0, c=CocipParams.wind_shear_enhancement_exponent, scale=1.0
+        )
     )
 
     #: Schumann takes ``initial_wake_vortex_depth`` = 0.5 and discusses some
     #: uncertainty in this value. This parameter should be non-negative.
-    initial_wake_vortex_depth_uncertainty: rv_frozen | None = stats.triang(
-        loc=0.3, c=CocipParams.initial_wake_vortex_depth, scale=0.4
+    initial_wake_vortex_depth_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.triang(
+            loc=0.3, c=CocipParams.initial_wake_vortex_depth, scale=0.4
+        )
     )
 
     #: Schumann takes a default value of 0.1 and describes it as an "important adjustable parameter"
     #: Currently, `CocipParams` uses a default value of 0.5
-    sedimentation_impact_factor_uncertainty: rv_frozen | None = stats.norm(
-        loc=CocipParams.sedimentation_impact_factor, scale=0.1
+    sedimentation_impact_factor_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.norm(loc=CocipParams.sedimentation_impact_factor, scale=0.1)
     )
 
     #: Teoh 2022 (to appear) takes values between 70% decrease and 100% increase.
     #: This coincides with the log normal distribution defined below.
-    nvpm_ei_n_enhancement_factor_uncertainty: rv_frozen | None = stats.lognorm(
-        s=0.15, scale=1 / stats.lognorm(s=0.15).mean()
+    nvpm_ei_n_enhancement_factor_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.lognorm(s=0.15, scale=1 / stats.lognorm(s=0.15).mean())
     )
 
     #: Scale shortwave radiative forcing.
@@ -145,8 +149,8 @@ class CocipUncertaintyParams(CocipParams):
     #: by `libRadTran <http://www.libradtran.org/doku.php>`_.
     #: We use the average RMS error across all habit types (pg 1397) as the standard deviation
     #: of a normally distributed scaling factor for SW forcing
-    rf_sw_enhancement_factor_uncertainty: rv_frozen | None = stats.norm(
-        loc=CocipParams.rf_sw_enhancement_factor, scale=0.106
+    rf_sw_enhancement_factor_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.norm(loc=CocipParams.rf_sw_enhancement_factor, scale=0.106)
     )
 
     #: Scale longwave radiative forcing.
@@ -154,8 +158,8 @@ class CocipUncertaintyParams(CocipParams):
     #: fit to the data generated by `libRadTran <http://www.libradtran.org/doku.php>`_.
     #: We use the average RMS error across all habit types (pg 1397) as the standard deviation
     #: of a normally distributed scaling factor for LW forcing.
-    rf_lw_enhancement_factor_uncertainty: rv_frozen | None = stats.norm(
-        loc=CocipParams.rf_lw_enhancement_factor, scale=0.071
+    rf_lw_enhancement_factor_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=lambda: stats.norm(loc=CocipParams.rf_lw_enhancement_factor, scale=0.071)
     )
 
     #: Scale the habit distributions by a dirichlet distribution
@@ -163,7 +167,9 @@ class CocipUncertaintyParams(CocipParams):
     #: where :math:`\text{G}_{i}` is the approximate habit weight distributions
     #: defined in :attr:`CocipParams().habit_distributions`.
     #: Higher values of :math:`\text{C}` correspond to higher confidence in initial estimates.
-    habit_distributions_uncertainty: rv_frozen | None = habit_dirichlet(C=96.0)
+    habit_distributions_uncertainty: rv_frozen | None = dataclasses.field(
+        default_factory=habit_dirichlet
+    )
 
     def __post_init__(self) -> None:
         """Override values of model parameters according to ranges."""
@@ -192,7 +198,7 @@ class CocipUncertaintyParams(CocipParams):
 
         out = {}
 
-        param_dict = asdict(self)
+        param_dict = dataclasses.asdict(self)
         for uncertainty_param, dist in param_dict.items():
             if uncertainty_param.endswith("_uncertainty") and dist is not None:
                 param = uncertainty_param.split("_uncertainty")[0]
@@ -212,7 +218,7 @@ class CocipUncertaintyParams(CocipParams):
 
         return out
 
-    def rvs(self, size: None | int = None) -> dict[str, np.float64 | npt.NDArray[np.float64]]:
+    def rvs(self, size: None | int = None) -> dict[str, np.float64 | npt.NDArray[np.floating]]:
         """Call each distribution's `rvs` method to generate random parameters.
 
         Seed calls to `rvs` with class variable `rng`.
@@ -224,7 +230,7 @@ class CocipUncertaintyParams(CocipParams):
 
         Returns
         -------
-        dict[str, float | npt.NDArray[np.float64]]
+        dict[str, float | npt.NDArray[np.floating]]
             Dictionary of random parameters. Dictionary keys consists of names of parameters in
             `CocipParams` to be overridden by random value.