pycontrails 0.50.2__tar.gz → 0.51.1__tar.gz

{pycontrails-0.50.2 → pycontrails-0.51.1}/.zenodo.json

@@ -20,6 +20,10 @@
     {
       "name": "Tom Dean",
       "affiliation": "Breakthrough Energy"
+    },
+    {
+      "name": "Tristan Abbott",
+      "affiliation": "Breakthrough Energy"
     }
   ],
   "license": "Apache-2.0",
@@ -42,4 +46,4 @@
       "type": "Researcher"
     }
   ]
-}
+}

{pycontrails-0.50.2 → pycontrails-0.51.1}/CHANGELOG.md

@@ -1,6 +1,55 @@
-
 # Changelog
 
+## v0.51.1
+
+### Breaking changes
+
+- Average fuel burn in the PS model is increased by 2.5\% unless `engine_deterioration_factor` is overriden.
+
+### Features
+
+- PS model: Support four aircraft types, including `E75L`, `E75S`, `E290`, and `E295`
+- PS model: Integrate `ps_synonym_list` to increase PS model aircraft type coverage to 102
+- PS model: Account for increase in fuel consumption due to engine deterioration between maintenance cycle
+
+### Internals
+
+- Calculate rate of climb and descent (ROCD) using hydrostatic equation to improve accuracy.
+- PS model: Move engine performance buffer from `c_t_available` to `tr_max`.
+- Set `tr_max` buffer to +20%, as recommended by Ian Poll.
+
+## v0.51.0
+
+### Breaking changes
+
+- Geodesic interpolation is now used in `Flight.resample_and_fill` when the great circle distance between waypoints (rather than the total segment length including vertical displacement) exceeds a threshold. This may change the interpolation method used when resampling flight segments with lengths close to the geodesic interpolation threshold.
+- Fixed typo in `thermo.c_pm`  will decrease computed values of moist heat capacity with non-zero specific humidity. We expect the downstream impact on contrail predictions by `ISSR`, `SAC`, `PCR`, and `Cocip` models to be minimal.
+- `np.nan` is now used as the default `fill_value` in `MetDataArray.to_polygon_feature` and `MetDataArray.to_polygon_feature_collection`. This ensures that NaN values are never included in polygon interiors unless a non-NaN `fill_value` is explicitly passed as a keyword argument.
+
+### Features
+
+- Add `ERA5ModelLevel` and `HRESModelLevel` interfaces for accessing ERA5 and HRES data on model levels.
+- Update [ECMWF tutorial notebook](https://py.contrails.org/notebooks/ECMWF.html) with instructions for using model-level datalibs.
+- Add `HistogramMatching` humidity scaling calibrated for model-level ERA5 data.
+- Modify `polygon.find_multipolygon`, `MetDataArray.to_polygon_feature`, `MetDataArray.to_polygon_feature_collection`, and `MetDataArray.to_polyhedra` to permit finding regions with values above or below a threshold.
+
+### Fixes
+
+- Use horizontal great circle distance to determine whether geodesic interpolation is used in `Flight.resample_and_fill`. This ensures geodesic interpolation is used between sufficiently distant waypoints even when one or both waypoints contain NaN altitude data.
+- Fix typo in moist heat capacity equation `thermo.c_pm`.
+
+### Internals
+
+- Create static copy of dataframe for determining pressure at ECMWF model levels.
+- Extract model-level utilities in `ARCOERA5` to their own module for reuse in `ERA5ModelLevel` and `HRESModelLevel`.
+- Update Makefile so `make ensure-era5-cached` uses default cache directory when run locally.
+- Bump pinned black and ruff versions.
+- Disable mypy type checking on `functools.wraps` in `support_arraylike` decorator to avoid error that appears starting on mypy 1.10.0.
+- Update pinned `Cocip` test output values after moist heat capacity bugfix.
+- Add static files with ECMWF model levels and model-level ERA5 RHI quantiles to packaged data.
+- Pass `exc_type=ImportError` to `pytest.importorskip` in test fixtures that use pycontrails extensions to suppress pytest warning when extensions are not installed.
+- Bump minimum pytest version 8.2 to ensure the `exc_type` kwarg is available.
+
 ## v0.50.2
 
 ### Breaking changes

{pycontrails-0.50.2 → pycontrails-0.51.1}/Makefile

@@ -142,12 +142,11 @@ ensure-gcp-credentials:
 			"See https://cloud.google.com/docs/authentication/application-default-credentials$(END_COLOR)"; \
 		exit 1)
 
-
-# Cache common ERA5 data for nb-tests and doctests in DiskCacheStore(cache_dir=".doc-test-cache")
+# Cache common ERA5 data for nb-tests and doctests in DiskCacheStore
 ensure-era5-cached:
 	python -c 'from pycontrails.datalib.ecmwf import ERA5; \
 		from pycontrails import DiskCacheStore; \
-		cache = DiskCacheStore(cache_dir=".doc-test-cache"); \
+		cache = DiskCacheStore(); \
 		time = "2022-03-01", "2022-03-01T23"; \
 		lev = [300, 250, 200]; \
 		met_vars = ["t", "q", "u", "v", "w", "ciwc", "z", "cc"]; \
@@ -250,4 +249,13 @@ docs-serve: doc8
 
 docs-pdf: doc8
 	sphinx-build -b latex $(DOCS_DIR) $(DOCS_BUILD_DIR)/latex
+
+	# GIF in notebooks/advection.ipynb kills the pdflatex process
+	# If advection notebook changes, this will have to get updated
+	rm docs/_build/latex/notebooks_advection_20_0.png
+
+	# this needs to get run twice
 	cd $(DOCS_BUILD_DIR)/latex && make
+	cd $(DOCS_BUILD_DIR)/latex && make
+
+	echo "PDF exported to $(DOCS_BUILD_DIR)/latex/pycontrails.pdf"

{pycontrails-0.50.2 → pycontrails-0.51.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.50.2
+Version: 0.51.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -36,7 +36,7 @@ Requires-Dist: xarray>=2022.3
 Provides-Extra: complete
 Requires-Dist: pycontrails[ecmwf,gcp,gfs,goes,jupyter,pyproj,vis,zarr]; extra == "complete"
 Provides-Extra: dev
-Requires-Dist: black[jupyter]==24.2.0; extra == "dev"
+Requires-Dist: black[jupyter]==24.4.1; extra == "dev"
 Requires-Dist: dep_license; extra == "dev"
 Requires-Dist: fastparquet>=0.8; extra == "dev"
 Requires-Dist: ipdb>=0.13; extra == "dev"
@@ -47,10 +47,10 @@ Requires-Dist: platformdirs>=3.0; extra == "dev"
 Requires-Dist: pre-commit>=2.10; extra == "dev"
 Requires-Dist: psutil; extra == "dev"
 Requires-Dist: pyarrow>=5.0; extra == "dev"
-Requires-Dist: pytest>=8.1; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
 Requires-Dist: pytest-cov>=2.11; extra == "dev"
 Requires-Dist: requests>=2.25; extra == "dev"
-Requires-Dist: ruff==0.1.15; extra == "dev"
+Requires-Dist: ruff==0.4.1; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: doc8>=1.1; extra == "docs"
 Requires-Dist: furo>=2023.3; extra == "docs"

{pycontrails-0.50.2 → pycontrails-0.51.1}/docs/api.rst

@@ -55,8 +55,11 @@ ECMWF
     :toctree: api/
 
     datalib.ecmwf.ERA5
+    datalib.ecmwf.era5_model_level
     datalib.ecmwf.HRES
+    datalib.ecmwf.hres_model_level
     datalib.ecmwf.hres.get_forecast_filename
+    datalib.ecmwf.model_levels
     datalib.ecmwf.IFS
     datalib.ecmwf.variables
 

{pycontrails-0.50.2 → pycontrails-0.51.1}/docs/conf.py

@@ -37,6 +37,7 @@ extensions = [
     "sphinx.ext.autosummary",
     "sphinx.ext.todo",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.imgconverter",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx.ext.extlinks",
@@ -269,3 +270,7 @@ html_sourcelink_suffix = ""
 html_js_files = [
     ("https://plausible.io/js/script.js", {"data-domain": "py.contrails.org", "defer": "defer"}),
 ]
+
+# -- Options for Latex output -------------------------------------------------
+
+latex_logo = "_static/img/logo.png"