pycontrails 0.42.0__tar.gz → 0.42.2__tar.gz

{pycontrails-0.42.0 → pycontrails-0.42.2}/.github/workflows/test.yaml

@@ -87,7 +87,7 @@ jobs:
     - name: Install pycontrails (dev)
       run: |
         pip install -U pip wheel
-        pip install -e .[dev,docs,ecmwf,gcp,gfs,jupyter,vis,zarr] --verbose
+        pip install -e .[dev,docs,ecmwf,gcp,gfs,jupyter,pwlf,vis,zarr] --verbose
 
     # In latest-windows, redirecting stdout to a file uses utf-16 encoding
     # This gives an error when ssh tries to read the key

{pycontrails-0.42.0 → pycontrails-0.42.2}/CHANGELOG.md

@@ -1,6 +1,35 @@
 
 # Changelog
 
+## v0.42.1
+
+### Features
+
+- Add new `HistogramMatchingWithEckel` experimental humidity scaling model. This is still a work in progress.
+- Add new `Flight.fit_altitude` method which uses piecewise linear fitting to smooth a flight profile.
+- Add new `pycontrails.core.flightplan` module for parsing ATC flight plans between string and dictionary representations.
+- Add new [airports](docs/examples/airports.ipynb) and [flightplan](docs/examples/flightplan.ipynb) examples.
+
+### Breaking changes
+
+- No longer attach empty fields "sdr", "rsr", "olr", "rf_sw", "rf_lw", "rf_net" onto the `source` parameter in `Cocip.eval` when the flight doesn't generate any persistent contrails.
+- Remove params `humidity_scaling`, `rhi_adj_uncertainty`, and `rhi_boost_exponent_uncertainty` from `CocipUncertaintyParams`.
+- Change the default value for `parallel` from True to False in `xr.open_mfdataset`. This can be overridden by setting the `xr_kwargs` parameter in `ERA5.open_metdataset`.
+
+### Fixes
+
+- Fix a unit test (`test_dtypes.py::test_issr_sac_grid_output`) that occasionally hangs. There may be another test in `test_ecmwf.py` that suffers from the same issue.
+- Fix issue encountered in `Cocip.eval` when concatenating contrails with inconsistent values for `_out_of_bounds`. This is only relevant when running the model with the experimental parameter `interpolation_use_indices=True`.
+- Add a `Fleet.max_distance_gap` property. The previous property on the `Flight` class was not applicable to `Fleet` instances.
+- Fix warning in `Flight` class to correctly suggest adding kwarg `drop_duplicated_times`.
+- Fix an issue in the `VectorDataset` constructor with a `data` parameter of type `pd.DataFrame`. Previously, time data was rewritten to the underlying DataFrame. This could cause copy-on-write issues if the DataFrame was a view of another DataFrame. This is now avoided.
+
+### Internals
+
+- When possible, replace type hints `np.ndarray` -> `np.typing.NDArray[np.float_]` in the `cocip`, `cocip_params`, `cocip_uncertainty`, `radiative_forcing`, and `wake_vortex` modules.
+- Slight performance enhancements in the `radiative_forcing` module.
+- Change the default value of `u_wind` and `v_wind` from None to 0 in `Flight.segment_true_airspeed`. This makes more sense semantically.
+
 ## v0.42.0
 
 Phase 1 of the Spire datalib, which contains functions to identify unique flight trajectories from the raw Spire ADS-B data.
@@ -46,7 +75,6 @@ Improve polygon algorithms.
 #### Fixes
 
 - Use [oldest-supported-numpy](https://pypi.org/project/oldest-supported-numpy/) for building pycontrails wheels. This allows pycontrails to be compatible with environments that use old versions of numpy. The [pycontrails v0.40.0 wheels](https://pypi.org/project/pycontrails/0.40.0/#files) are not compatible with numpy 1.22.
-- Fix a unit test (`test_dtypes.py::test_issr_sac_grid_output`) that occasionally hangs.
 
 ## v0.40.0
 

{pycontrails-0.42.0/pycontrails.egg-info → pycontrails-0.42.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.42.0
+Version: 0.42.2
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -32,6 +32,7 @@ Provides-Extra: gcp
 Provides-Extra: gfs
 Provides-Extra: jupyter
 Provides-Extra: open3d
+Provides-Extra: pwlf
 Provides-Extra: vis
 Provides-Extra: zarr
 License-File: LICENSE

{pycontrails-0.42.0 → pycontrails-0.42.2}/docs/_static/pycontrails.bib

@@ -148,6 +148,24 @@
   keywords = {Science / Light,Technology \& Engineering / Manufacturing,Technology \& Engineering / Mechanical,Technology \& Engineering / Power Resources / General}
 }
 
+@article{eckelCalibratedProbabilisticQuantitative1998,
+  title = {Calibrated {{Probabilistic Quantitative Precipitation Forecasts Based}} on {{theMRF Ensemble}}},
+  author = {Eckel, F. Anthony and Walters, Michael K.},
+  year = {1998},
+  month = dec,
+  journal = {Weather and Forecasting},
+  volume = {13},
+  number = {4},
+  pages = {1132--1147},
+  publisher = {{American Meteorological Society}},
+  issn = {1520-0434, 0882-8156},
+  doi = {10.1175/1520-0434(1998)013<1132:CPQPFB>2.0.CO;2},
+  urldate = {2023-05-12},
+  abstract = {Abstract Probabilistic quantitative precipitation forecasts (PQPFs) based on the National Centers for Environmental Prediction Medium-Range Forecast (MRF) ensemble currently perform below their full potential quality (i.e., accuracy and reliability). This unfulfilled potential is due to the MRF ensemble being adversely affected by systematic errors that arise from an imperfect forecast model and less than optimum ensemble initial perturbations. This research sought to construct a calibration to account for these systematic errors and thus produce higher quality PQPFs. The main tool of the calibration was the verification rank histogram, which can be used to interpret and adjust an ensemble forecast. Using a large training dataset, many histograms were created, each characterized by a different forecast lead time and level of ensemble variability. These results were processed into probability surfaces, providing detailed information on performance of the ensemble as part of the calibration scheme. Improvement of the calibrated PQPF over the current uncalibrated PQPF was examined using a separate, large forecasting dataset, with climatological PQPF as the baseline. While the calibration technique noticeably improved the quality of PQPF and extended predictability by about 1 day, its usefulness was bounded by the intrinsic predictability limits of cumulative precipitation. Predictability was found to be dependent upon the precipitation category. For significant levels of precipitation (high thresholds), the calibration designed in this research was found to be useful only for short-range PQPFs. For low precipitation thresholds, the calibrated PQPF did prove to be of value in the medium range.},
+  chapter = {Weather and Forecasting},
+  langid = {english}
+}
+
 @misc{eurocontrolUSERMANUALBASE2010,
   title = {{{USER MANUAL FOR THE BASE OF Aircraft DATA}} ({{BADA}}) {{REVISION}} 3.8},
   author = {Eurocontrol},

{pycontrails-0.42.0 → pycontrails-0.42.2}/docs/examples/ACCF.ipynb

@@ -102,8 +102,8 @@
     "    variables=[\"surface_solar_downward_radiation\", \"top_net_thermal_radiation\"],\n",
     ")\n",
     "\n",
-    "pl = era5_pl.open_metdataset(xr_kwargs=dict(parallel=False))\n",
-    "sl = era5_sl.open_metdataset(xr_kwargs=dict(parallel=False))"
+    "pl = era5_pl.open_metdataset()\n",
+    "sl = era5_sl.open_metdataset()"
    ]
   },
   {