pycontrails 0.54.7__cp312-cp312-macosx_11_0_arm64.whl → 0.54.9__cp312-cp312-macosx_11_0_arm64.whl

pycontrails/models/cocip/cocip.py

@@ -997,14 +997,14 @@ class Cocip(Model):
         else:
             f_surv = contrail_properties.ice_particle_survival_fraction(iwc, iwc_1)
 
-        n_ice_per_m_1 = contrail_properties.ice_particle_number(
+        n_ice_per_m_0 = contrail_properties.initial_ice_particle_number(
             nvpm_ei_n=nvpm_ei_n,
             fuel_dist=fuel_dist,
-            f_surv=f_surv,
             air_temperature=air_temperature,
             T_crit_sac=T_critical_sac,
             min_ice_particle_number_nvpm_ei_n=self.params["min_ice_particle_number_nvpm_ei_n"],
         )
+        n_ice_per_m_1 = n_ice_per_m_0 * f_surv
 
         # Check for persistent initial_contrails
         persistent_1 = contrail_properties.initial_persistent(iwc_1, rhi_1)
@@ -1018,6 +1018,8 @@ class Cocip(Model):
         self._sac_flight["rho_air_1"] = rho_air_1
         self._sac_flight["rhi_1"] = rhi_1
         self._sac_flight["iwc_1"] = iwc_1
+        self._sac_flight["f_surv"] = f_surv
+        self._sac_flight["n_ice_per_m_0"] = n_ice_per_m_0
         self._sac_flight["n_ice_per_m_1"] = n_ice_per_m_1
         self._sac_flight["persistent_1"] = persistent_1
 
@@ -1384,7 +1386,13 @@ class Cocip(Model):
         if verbose_outputs:
             sac_cols += ["dT_dz", "ds_dz", "dz_max"]
 
-        downwash_cols = ["rho_air_1", "iwc_1", "n_ice_per_m_1"]
+        downwash_cols = [
+            "rho_air_1",
+            "iwc_1",
+            "f_surv",
+            "n_ice_per_m_0",
+            "n_ice_per_m_1",
+        ]
         df = pd.concat(
             [
                 self.source.dataframe.set_index(col_idx),
@@ -2211,8 +2219,6 @@ def calc_contrail_properties(
         air_temperature += contrail["cumul_heat"]
 
     # get required radiation
-    theta_rad = geo.orbital_position(time)
-    sd0 = geo.solar_constant(theta_rad)
     sdr = contrail["sdr"]
     rsr = contrail["rsr"]
     olr = contrail["olr"]
@@ -2247,6 +2253,9 @@ def calc_contrail_properties(
     diffuse_h = contrail_properties.horizontal_diffusivity(ds_dz, depth)
 
     if radiative_heating_effects:
+        # theta_rad has float64 dtype, convert back to float32 if needed
+        theta_rad = geo.orbital_position(time).astype(sdr.dtype, copy=False)
+        sd0 = geo.solar_constant(theta_rad)
         heat_rate = radiative_heating.heating_rate(
             air_temperature=air_temperature,
             rhi=rhi,

pycontrails/models/cocip/contrail_properties.py

@@ -201,10 +201,9 @@ def iwc_post_wake_vortex(
     return np.maximum(iwc - iwc_ad, 0.0)
 
 
-def ice_particle_number(
+def initial_ice_particle_number(
     nvpm_ei_n: npt.NDArray[np.floating],
     fuel_dist: npt.NDArray[np.floating],
-    f_surv: npt.NDArray[np.floating],
     air_temperature: npt.NDArray[np.floating],
     T_crit_sac: npt.NDArray[np.floating],
     min_ice_particle_number_nvpm_ei_n: float,
@@ -222,8 +221,6 @@ def ice_particle_number(
         black carbon number emissions index, [:math:`kg^{-1}`]
     fuel_dist : npt.NDArray[np.floating]
         fuel consumption of the flight segment per distance traveled, [:math:`kg m^{-1}`]
-    f_surv : npt.NDArray[np.floating]
-        Fraction of contrail ice particle number that survive the wake vortex phase.
     air_temperature : npt.NDArray[np.floating]
         ambient temperature for each waypoint, [:math:`K`]
     T_crit_sac : npt.NDArray[np.floating]
@@ -235,11 +232,12 @@ def ice_particle_number(
     Returns
     -------
     npt.NDArray[np.floating]
-        initial number of ice particles per distance after the wake vortex phase, [:math:`# m^{-1}`]
+        The initial number of ice particles per distance before the wake vortex
+        phase, [:math:`# m^{-1}`]
     """
     f_activation = ice_particle_activation_rate(air_temperature, T_crit_sac)
     nvpm_ei_n_activated = nvpm_ei_n * f_activation
-    return fuel_dist * np.maximum(nvpm_ei_n_activated, min_ice_particle_number_nvpm_ei_n) * f_surv
+    return fuel_dist * np.maximum(nvpm_ei_n_activated, min_ice_particle_number_nvpm_ei_n)
 
 
 def ice_particle_activation_rate(

pycontrails/models/cocip/output_formats.py

@@ -1188,10 +1188,18 @@ def meteorological_time_slice_statistics(
     )
 
     # ISSR: Volume of airspace with RHi > 100% between FL300 and FL450
-    met = humidity_scaling.eval(met)
-    rhi = met["rhi"].data.sel(level=slice(150, 300))
-    rhi = rhi.interp(time=time)
-    is_issr = rhi > 1
+    met_cruise = MetDataset(met.data.sel(level=slice(150, 300)))
+    rhi = humidity_scaling.eval(met_cruise)["rhi"].data
+
+    try:
+        # If the given time is already in the dataset, select the time slice
+        i = rhi.get_index("time").get_loc(time)
+    except KeyError:
+        rhi = rhi.interp(time=time)
+    else:
+        rhi = rhi.isel(time=i)
+
+    is_issr = rhi > 1.0
 
     # Cirrus in a longitude-latitude grid
     if cirrus_coverage is None:

pycontrails/models/cocip/radiative_forcing.py

@@ -1104,10 +1104,7 @@ def _contrail_optical_depth_above_contrail_layer(
 
     da_surface_area = geo.grid_surface_area(da["longitude"].values, da["latitude"].values)
     da = da / da_surface_area
-
-    lon_coords = da["longitude"].values
-    wrap_longitude = (lon_coords[-1] + lon_coords[0] + np.diff(lon_coords)[0]) == 0.0
-    mda = MetDataArray(da, wrap_longitude=wrap_longitude, copy=False)
+    mda = MetDataArray(da)
 
     # Interpolate to contrails_level
     contrails_level["tau_contrails_above"] = contrails_level.intersect_met(mda)
@@ -1133,10 +1130,7 @@ def _rsr_and_olr_with_contrail_overlap(
         Contrail waypoints at the current altitude layer with `rsr_overlap` and
         `olr_overlap` attached.
     """
-    # Change in radiation fields
-    lon_coords = delta_rad_t["longitude"].values
-    wrap_longitude = (lon_coords[-1] + lon_coords[0] + np.diff(lon_coords)[0]) == 0.0
-    mds = MetDataset(delta_rad_t, wrap_longitude=wrap_longitude, copy=False)
+    mds = MetDataset(delta_rad_t)
 
     # Interpolate radiation fields to obtain `rsr_overlap` and `olr_overlap`
     delta_rsr = contrails_level.intersect_met(mds["rsr"])

pycontrails/models/cocipgrid/cocip_grid.py

@@ -1488,18 +1488,18 @@ def find_initial_persistent_contrails(
     )
     iwc_1 = contrail_properties.iwc_post_wake_vortex(iwc, iwc_ad)
     f_surv = contrail_properties.ice_particle_survival_fraction(iwc, iwc_1)
-    n_ice_per_m = contrail_properties.ice_particle_number(
+    n_ice_per_m_0 = contrail_properties.initial_ice_particle_number(
         nvpm_ei_n=nvpm_ei_n,
         fuel_dist=fuel_dist,
-        f_surv=f_surv,
         air_temperature=air_temperature,
         T_crit_sac=T_crit_sac,
         min_ice_particle_number_nvpm_ei_n=params["min_ice_particle_number_nvpm_ei_n"],
     )
+    n_ice_per_m_1 = n_ice_per_m_0 * f_surv
 
     # The logic below corresponds to Cocip._create_downwash_contrail (roughly)
     contrail["iwc"] = iwc_1
-    contrail["n_ice_per_m"] = n_ice_per_m
+    contrail["n_ice_per_m"] = n_ice_per_m_1
 
     # Check for persistent initial_contrails
     rhi_1 = contrail["rhi"]
@@ -2152,18 +2152,18 @@ def result_to_metdataset(
     size = np.prod(shape)
 
     dtype = result["ef"].dtype if result else np.float32
-    contrail_age = np.zeros(size, dtype=np.float32)
-    ef_per_m = np.zeros(size, dtype=dtype)
+    contrail_age_1d = np.zeros(size, dtype=np.float32)
+    ef_per_m_1d = np.zeros(size, dtype=dtype)
 
     if result:
         contrail_idx = result["index"]
         # Step 1: Contrail age. Convert from timedelta to float
-        contrail_age[contrail_idx] = result["age"] / np.timedelta64(1, "h")
+        contrail_age_1d[contrail_idx] = result["age"] / np.timedelta64(1, "h")
         # Step 2: EF
-        ef_per_m[contrail_idx] = result["ef"] / nominal_segment_length
+        ef_per_m_1d[contrail_idx] = result["ef"] / nominal_segment_length
 
-    contrail_age = contrail_age.reshape(shape)
-    ef_per_m = ef_per_m.reshape(shape)
+    contrail_age_4d = contrail_age_1d.reshape(shape)
+    ef_per_m_4d = ef_per_m_1d.reshape(shape)
 
     # Step 3: Dataset dims and attrs
     dims = tuple(source.coords)
@@ -2171,8 +2171,8 @@ def result_to_metdataset(
 
     # Step 4: Dataset core variables
     data_vars = {
-        "contrail_age": (dims, contrail_age, local_attrs["contrail_age"]),
-        "ef_per_m": (dims, ef_per_m, local_attrs["ef_per_m"]),
+        "contrail_age": (dims, contrail_age_4d, local_attrs["contrail_age"]),
+        "ef_per_m": (dims, ef_per_m_4d, local_attrs["ef_per_m"]),
     }
 
     # Step 5: Dataset variables from verbose_dicts

pycontrails/models/humidity_scaling/humidity_scaling.py

@@ -321,7 +321,27 @@ class _SigmoidCoefficients:
 
 
 @functools.cache
-def _load_sigmoid_coef(q_method: str | None) -> _SigmoidCoefficients:
+def _load_sigmoid_coef(q_method: str | None, level_type: str) -> _SigmoidCoefficients:
+    available = ("pressure", "model")
+    if level_type not in available:
+        msg = f"Invalid 'level_type' value '{level_type}'. Must be one of {available}."
+        raise ValueError(msg)
+
+    if level_type == "model":
+        if q_method is not None:
+            msg = "Parameter 'q_method' must be None for model-level data."
+            raise ValueError(msg)
+        return _SigmoidCoefficients(
+            a1=0.026302083473778933,
+            a2=0.9651041666272301,
+            a3=2.250107435038734,
+            a4=36.549393263544914,
+            b1=0.489062500000000095,
+            b2=2.210937499999999,
+            b3=4.182743010484767,
+            b4=17.53378893219587,
+        )
+
     if q_method is None:
         return _SigmoidCoefficients(
             a1=0.062621,
@@ -347,6 +367,14 @@ def _load_sigmoid_coef(q_method: str | None) -> _SigmoidCoefficients:
     raise NotImplementedError(f"Unsupported q_method: {q_method}")
 
 
+@dataclasses.dataclass
+class ExponentialBoostLatitudeCorrectionParams(models.ModelParams):
+    """Parameters for :class:`ExponentialBoostLatitudeCorrectionHumidityScaling`."""
+
+    #: The ERA5 vertical level type. Must be one of ``"pressure"`` or ``"model"``.
+    level_type: str = "pressure"
+
+
 class ExponentialBoostLatitudeCorrectionHumidityScaling(HumidityScaling):
     """Correct RHi values derived from ECMWF ERA5 HRES.
 
@@ -406,12 +434,28 @@ class ExponentialBoostLatitudeCorrectionHumidityScaling(HumidityScaling):
     name = "exponential_boost_latitude_customization"
     long_name = "Latitude specific humidity scaling composed with exponential boosting"
     formula = "rhi -> (rhi / rhi_adj) ^ rhi_boost_exponent"
-    default_params = models.ModelParams
+    default_params = ExponentialBoostLatitudeCorrectionParams
     scaler_specific_keys = ("latitude",)
 
+    def __init__(
+        self,
+        met: MetDataset | None = None,
+        params: dict[str, Any] | None = None,
+        **params_kwargs: Any,
+    ):
+        if (params is None or "level_type" not in params) and ("level_type" not in params_kwargs):
+            msg = (
+                "The default level_type will change from 'pressure' to 'model' "
+                "in a future release. To silence this warning, provide a 'level_type' "
+                "value when instantiating ExponentialBoostLatitudeCorrectionHumidityScaling."
+            )
+            warnings.warn(msg, DeprecationWarning)
+        super().__init__(met, params, **params_kwargs)
+
     def _scale_kwargs(self) -> dict[str, Any]:
         q_method = self.params["interpolation_q_method"]
-        return {**super()._scale_kwargs(), "q_method": q_method}
+        level_type = self.params["level_type"]
+        return {**super()._scale_kwargs(), "q_method": q_method, "level_type": level_type}
 
     @override
     def scale(
@@ -423,7 +467,8 @@ class ExponentialBoostLatitudeCorrectionHumidityScaling(HumidityScaling):
     ) -> tuple[ArrayLike, ArrayLike]:
         # Get sigmoid coefficients
         q_method = kwargs["q_method"]
-        coef = _load_sigmoid_coef(q_method)
+        level_type = kwargs["level_type"]
+        coef = _load_sigmoid_coef(q_method, level_type)
 
         # Use the dtype of specific_humidity to determine the precision of the
         # the calculation. If working with gridded data here, latitude will have

pycontrails/models/ps_model/ps_aircraft_params.py

@@ -16,7 +16,7 @@ from pycontrails.physics import constants as c
 from pycontrails.utils.types import ArrayOrFloat
 
 #: Path to the Poll-Schumann aircraft parameters CSV file.
-PS_FILE_PATH = pathlib.Path(__file__).parent / "static" / "ps-aircraft-params-20240524.csv"
+PS_FILE_PATH = pathlib.Path(__file__).parent / "static" / "ps-aircraft-params-20250328.csv"
 
 
 @dataclasses.dataclass(frozen=True)

pycontrails/models/ps_model/ps_grid.py

@@ -408,35 +408,35 @@ def ps_nominal_grid(
     >>> perf.attrs["mach_number"]
     0.753
 
-    >>> perf.to_dataframe()
+    >>> perf.to_dataframe().round({"aircraft_mass": 0, "engine_efficiency": 3, "fuel_flow": 3})
            aircraft_mass  engine_efficiency  fuel_flow
     level
-    200.0   58416.230844           0.300958   0.575635
-    210.0   61617.676624           0.300958   0.604417
-    220.0   64829.702584           0.300958   0.633199
-    230.0   68026.415694           0.300958   0.662998
-    240.0   71187.897060           0.300958   0.694631
-    250.0   71775.399880           0.300824   0.703349
-    260.0   71765.716789           0.300363   0.708259
-    270.0   71752.405449           0.299671   0.714514
-    280.0   71736.129125           0.298823   0.721878
-    290.0   71717.392213           0.297875   0.730169
+    200.0        58416.0              0.301      0.576
+    210.0        61618.0              0.301      0.604
+    220.0        64830.0              0.301      0.633
+    230.0        68026.0              0.301      0.663
+    240.0        71188.0              0.301      0.695
+    250.0        71775.0              0.301      0.703
+    260.0        71766.0              0.300      0.708
+    270.0        71752.0              0.300      0.715
+    280.0        71736.0              0.299      0.722
+    290.0        71717.0              0.298      0.730
 
     >>> # Now compute it for a higher Mach number
     >>> perf = ps_nominal_grid("A320", level=level, mach_number=0.78)
-    >>> perf.to_dataframe()
+    >>> perf.to_dataframe().round({"aircraft_mass": 0, "engine_efficiency": 3, "fuel_flow": 3})
            aircraft_mass  engine_efficiency  fuel_flow
     level
-    200.0   57941.825236           0.306598   0.596100
-    210.0   60626.062062           0.306605   0.621331
-    220.0   63818.498305           0.306605   0.650918
-    230.0   66993.691515           0.306605   0.681551
-    240.0   70129.930502           0.306605   0.714069
-    250.0   71703.009114           0.306560   0.732944
-    260.0   71690.188703           0.306239   0.739276
-    270.0   71673.392137           0.305694   0.747052
-    280.0   71653.431366           0.304997   0.755990
-    290.0   71630.901358           0.304201   0.765883
+    200.0        58473.0              0.307      0.601
+    210.0        60626.0              0.307      0.621
+    220.0        63818.0              0.307      0.651
+    230.0        66994.0              0.307      0.682
+    240.0        70130.0              0.307      0.714
+    250.0        71703.0              0.307      0.733
+    260.0        71690.0              0.306      0.739
+    270.0        71673.0              0.306      0.747
+    280.0        71653.0              0.305      0.756
+    290.0        71631.0              0.304      0.766
     """
     dims, coords, air_pressure, air_temperature = _parse_variables(level, air_temperature)
 

pycontrails/models/ps_model/ps_model.py

@@ -27,7 +27,6 @@ from pycontrails.core.aircraft_performance import (
 )
 from pycontrails.core.flight import Flight
 from pycontrails.core.met import MetDataset
-from pycontrails.core.met_var import AirTemperature, EastwardWind, MetVariable, NorthwardWind
 from pycontrails.models.ps_model import ps_operational_limits as ps_lims
 from pycontrails.models.ps_model.ps_aircraft_params import (
     PSAircraftEngineParams,
@@ -39,7 +38,7 @@ from pycontrails.utils.types import ArrayOrFloat
 # mypy: disable-error-code = "type-var, arg-type"
 
 #: Path to the Poll-Schumann aircraft parameters CSV file.
-PS_SYNONYM_FILE_PATH = pathlib.Path(__file__).parent / "static" / "ps-synonym-list-20240524.csv"
+PS_SYNONYM_FILE_PATH = pathlib.Path(__file__).parent / "static" / "ps-synonym-list-20250328.csv"
 
 
 @dataclasses.dataclass
@@ -70,8 +69,6 @@ class PSFlight(AircraftPerformance):
 
     name = "PSFlight"
     long_name = "Poll-Schumann Aircraft Performance Model"
-    met_variables: tuple[MetVariable, ...] = (AirTemperature,)
-    optional_met_variables = EastwardWind, NorthwardWind
     default_params = PSFlightParams
 
     aircraft_engine_params: Mapping[str, PSAircraftEngineParams]
@@ -160,10 +157,10 @@ class PSFlight(AircraftPerformance):
             time=fl["time"],
             true_airspeed=true_airspeed,
             air_temperature=fl["air_temperature"],
-            aircraft_mass=self.get_source_param("aircraft_mass", None),
-            thrust=self.get_source_param("thrust", None),
-            engine_efficiency=self.get_source_param("engine_efficiency", None),
-            fuel_flow=self.get_source_param("fuel_flow", None),
+            aircraft_mass=self.get_data_param(fl, "aircraft_mass", None),
+            thrust=self.get_data_param(fl, "thrust", None),
+            engine_efficiency=self.get_data_param(fl, "engine_efficiency", None),
+            fuel_flow=self.get_data_param(fl, "fuel_flow", None),
             q_fuel=q_fuel,
             n_iter=self.params["n_iter"],
             amass_oew=amass_oew,
@@ -999,8 +996,5 @@ def get_aircraft_synonym_dict_ps() -> dict[str, str]:
         Dictionary of the form ``{"icao_aircraft_type": "ps_aircraft_type"}``.
     """
     # get path to static PS synonym list
-    synonym_path = pathlib.Path(__file__).parent / "static" / "ps-synonym-list-20240524.csv"
-    df_atyp_icao_to_ps = pd.read_csv(
-        synonym_path, usecols=["ICAO Aircraft Code", "PS ATYP"], index_col=0
-    )
-    return df_atyp_icao_to_ps.squeeze("columns").to_dict()
+    df_atyp_icao_to_ps = pd.read_csv(PS_SYNONYM_FILE_PATH, index_col="ICAO Aircraft Code")
+    return df_atyp_icao_to_ps["PS ATYP"].to_dict()