pycontrails 0.54.0__tar.gz → 0.54.2__tar.gz

{pycontrails-0.54.0 → pycontrails-0.54.2}/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## v0.54.2
+
+### Features
+
+- Add `cache_download` parameter to the `GFSForecast` interface. When set to `True`, downloaded grib data is cached locally. This is consistent with the behavior of the `ERA5ModelLevel` and `HRESModelLevel` interfaces.
+
+### Fixes
+
+- Update GFS variable names "uswrf" -> "suswrf" and "ulwrf" -> "sulwrf". This accommodates a breaking change introduced in [eccodes 2.38](https://confluence.ecmwf.int/display/MTG2US/Changes+in+ecCodes+version+2.38.0+compared+to+the+previous+version#ChangesinecCodesversion2.38.0comparedtothepreviousversion-Changedshortnames).
+
+### Internals
+
+- Remove `overrides` dependency. Require `typing-extensions` for python < 3.12.
+- Upgrade some type hints for more modern python language features.
+
+## v0.54.1
+
+### Features
+
+- Add [CoCiP Grid notebook](https://py.contrails.org/notebooks/CoCiPGrid.html) example to documentation.
+- Implement `PSFlight.eval` on a `Fleet` source.
+
+### Breaking changes
+
+- Remove `attrs["crs"]` usage from `GeoVectorDataset` and child classes (`Flight`, `Fleet`). All spatial data is assumed to be EPSG:4326 (WGS84). This was previously assumed implicitly, but now the `crs` attribute is removed from the `attrs` dictionary.
+- Change the return type of `GeoVectorDataset.transform_crs` to a pair of numpy arrays representing `x` and `y` coordinates in the target CRS.
+- Remove deprecated `MetDataset.variables` property in favor of `MetDataset.indexes`.
+- Remove `**kwargs` in `MetDataArray` constructor.
+- Rename `ARCOERA5` to `ERA5ARCO` for consistency with the `ERA5` and `ERA5ModelLevel` interfaces.
+
+### Fixes
+
+- Fix the integration time step in `CocipGrid.calc_evolve_one_step`. The previous implementation assumed a time interval of `params["dt_integration"]`. This may not be the case for all `source` parameters (for example, this could occur if running `CocipGrid` over a collection of ADS-B waypoints).
+- Raise an exception in constructing `MetDataset(ds, copy=False)` when `ds["level"]` has float32 dtype. Per interpolation conventions, all coordinate variables must have float64 dtype. (This was previously enforced in longitude and latitude, but was overlooked in the level coordinate.)
+- Allow `AircraftPerformance.ensure_true_airspeed_on_source` to use `eastward_wind` and `northward_wind` fields on the `source` if available. This is useful when the `source` has already been interpolated to met data.
+
 ## v0.54.0
 
 ### Features

{pycontrails-0.54.0 → pycontrails-0.54.2}/Makefile

@@ -220,6 +220,7 @@ nb-check-links:
 		--check-links-ignore "https://doi.org/10.1021/acs.est.2c05781" \
 		--check-links-ignore "https://github.com/contrailcirrus/pycontrails-bada" \
 		--check-links-ignore "https://ourairports.com" \
+		--check-links-ignore "https://www.ncei.noaa.gov/products/weather-climate-models/global-forecast" \
 		docs/notebooks/*.ipynb
 
 # Execute all notebooks in docs

{pycontrails-0.54.0/pycontrails.egg-info → pycontrails-0.54.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.54.0
+Version: 0.54.2
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -29,9 +29,9 @@ License-File: LICENSE
 License-File: NOTICE
 Requires-Dist: dask>=2022.3
 Requires-Dist: numpy>=1.22
-Requires-Dist: overrides>=6.1
 Requires-Dist: pandas>=2.2
 Requires-Dist: scipy>=1.10
+Requires-Dist: typing-extensions>=4.5; python_version < "3.12"
 Requires-Dist: xarray>=2022.3
 Provides-Extra: complete
 Requires-Dist: pycontrails[ecmwf,gcp,gfs,jupyter,pyproj,sat,vis,zarr]; extra == "complete"
@@ -67,7 +67,7 @@ Requires-Dist: sphinxext.opengraph>=0.8; extra == "docs"
 Provides-Extra: ecmwf
 Requires-Dist: cdsapi>=0.4; extra == "ecmwf"
 Requires-Dist: cfgrib>=0.9; extra == "ecmwf"
-Requires-Dist: eccodes>=1.4; extra == "ecmwf"
+Requires-Dist: eccodes>=2.38; extra == "ecmwf"
 Requires-Dist: ecmwf-api-client>=1.6; extra == "ecmwf"
 Requires-Dist: netcdf4>=1.6.1; extra == "ecmwf"
 Requires-Dist: platformdirs>=3.0; extra == "ecmwf"
@@ -79,7 +79,8 @@ Requires-Dist: tqdm>=4.61; extra == "gcp"
 Provides-Extra: gfs
 Requires-Dist: boto3>=1.20; extra == "gfs"
 Requires-Dist: cfgrib>=0.9; extra == "gfs"
-Requires-Dist: eccodes>=1.4; extra == "gfs"
+Requires-Dist: eccodes>=2.38; extra == "gfs"
+Requires-Dist: netcdf4>=1.6.1; extra == "gfs"
 Requires-Dist: platformdirs>=3.0; extra == "gfs"
 Requires-Dist: tqdm>=4.61; extra == "gfs"
 Provides-Extra: jupyter

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/conf.py

@@ -78,6 +78,7 @@ suppress_warnings = ["myst.header"]
 # Set up mapping for other projects' docs
 intersphinx_mapping = {
     "numpy": ("https://numpy.org/doc/stable/", None),
+    "open3d": ("https://www.open3d.org/docs/release/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/dev/", None),
     "pyproj": ("https://pyproj4.github.io/pyproj/stable/", None),
     "python": ("https://docs.python.org/3/", None),
@@ -170,7 +171,7 @@ autodoc_typehints = "none"
 
 # autodoc options
 autoclass_content = "class"  # only include docstring from Class (not __init__ method)
-autodoc_inherit_docstrings = False
+autodoc_inherit_docstrings = True
 autodoc_default_options = {
     "members": None,  # means yes/true/on
     "undoc-members": None,

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/index.rst

@@ -92,7 +92,7 @@ Learn more on `contrails.org <https://contrails.org>`_.
    :alt: Unit test
    :target: https://github.com/contrailcirrus/pycontrails/actions/workflows/test.yaml
 
-.. |Docs| image:: https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml/badge.svg
+.. |Docs| image:: https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml/badge.svg?event=push
    :alt: Docs
    :target: https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml
 

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/integrations/ACCF.ipynb

@@ -65,7 +65,7 @@
     "## Download meteorology data from ECMWF\n",
     "\n",
     "This demo uses [ERA5](https://www.ecmwf.int/en/forecasts/dataset/ecmwf-reanalysis-v5) via the [Copernicus Data Store (CDS)](https://cds.climate.copernicus.eu/) for met data.\n",
-    "This requires account with [Copernicus Data Portal](https://cds.climate.copernicus.eu/cdsapp#!/home) and local `~/.cdsapirc` file with credentials."
+    "This requires account with [Copernicus Data Portal](https://cds.climate.copernicus.eu/how-to-api) and local `~/.cdsapirc` file with credentials."
    ]
   },
   {

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/integrations/APCEMM.ipynb

@@ -34,7 +34,7 @@
     "\n",
     "from pycontrails import Flight, MetVariable\n",
     "from pycontrails.core.met_var import Geopotential\n",
-    "from pycontrails.datalib.ecmwf import ARCOERA5\n",
+    "from pycontrails.datalib.ecmwf import ERA5ARCO\n",
     "from pycontrails.models.apcemm.apcemm import APCEMM\n",
     "from pycontrails.models.humidity_scaling import HistogramMatching\n",
     "from pycontrails.models.issr import ISSR\n",
@@ -74,7 +74,7 @@
    "outputs": [],
    "source": [
     "variables = (v if isinstance(v, MetVariable) else Geopotential for v in APCEMM.met_variables)\n",
-    "era5ml = ARCOERA5(time=time_bounds, variables=APCEMM.met_variables, n_jobs=4)"
+    "era5ml = ERA5ARCO(time=time_bounds, variables=APCEMM.met_variables)"
    ]
   },
   {

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/models.rst

@@ -12,6 +12,7 @@ Models
    notebooks/SAC
    notebooks/AircraftPerformance
    notebooks/CoCiP
+   notebooks/CoCiPGrid
    notebooks/advection
-   integrations/ACCF.ipynb
-   integrations/APCEMM.ipynb
+   integrations/ACCF
+   integrations/APCEMM

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/notebooks/ARCO-ERA5.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# ARCO ERA5\n",
     "\n",
-    "This notebook demonstrates how to load [ARCO ERA5](https://cloud.google.com/storage/docs/public-datasets/era5) data from [Google Cloud Storage](https://cloud.google.com/storage) through the pycontrails `ARCOERA5` interface."
+    "This notebook demonstrates how to load [ARCO ERA5](https://cloud.google.com/storage/docs/public-datasets/era5) data from [Google Cloud Storage](https://cloud.google.com/storage) through the pycontrails `ERA5ARCO` interface."
    ]
   },
   {
@@ -22,7 +22,7 @@
     "import xarray as xr\n",
     "\n",
     "from pycontrails import Flight, MetDataset\n",
-    "from pycontrails.datalib.ecmwf import ARCOERA5\n",
+    "from pycontrails.datalib.ecmwf import ERA5ARCO\n",
     "from pycontrails.models.cocip import Cocip\n",
     "from pycontrails.models.humidity_scaling import ConstantHumidityScaling\n",
     "from pycontrails.models.issr import ISSR\n",
@@ -47,7 +47,7 @@
    "source": [
     "time = (\"2019-01-01T00\", \"2019-01-01T12\")\n",
     "\n",
-    "era5_pl = ARCOERA5(\n",
+    "era5_pl = ERA5ARCO(\n",
     "    time=time,\n",
     "    variables=(*Cocip.met_variables, *Cocip.optional_met_variables),\n",
     "    cachestore=None,\n",
@@ -55,7 +55,7 @@
     "met = era5_pl.open_metdataset()\n",
     "\n",
     "\n",
-    "era5_sl = ARCOERA5(\n",
+    "era5_sl = ERA5ARCO(\n",
     "    time=time,\n",
     "    variables=Cocip.rad_variables,\n",
     "    pressure_levels=-1,\n",

{pycontrails-0.54.0 → pycontrails-0.54.2}/docs/notebooks/CoCiP.ipynb

@@ -44,7 +44,7 @@
     "## Download meteorology data from ECMWF\n",
     "\n",
     "This demo uses [ERA5](https://www.ecmwf.int/en/forecasts/dataset/ecmwf-reanalysis-v5) via the [Copernicus Data Store (CDS)](https://cds.climate.copernicus.eu/) for met data.\n",
-    "This requires account with [Copernicus Data Portal](https://cds.climate.copernicus.eu/cdsapp#!/home) and  local `~/.cdsapirc` file with credentials.\n",
+    "This requires account with [Copernicus Data Portal](https://cds.climate.copernicus.eu/how-to-api) and  local `~/.cdsapirc` file with credentials.\n",
     "\n",
     "> Note this will download ~1 GB of meteorology data to your computer"
    ]