pycontrails 0.53.1__tar.gz → 0.54.1__tar.gz

{pycontrails-0.53.1 → pycontrails-0.54.1}/.github/workflows/release.yaml

@@ -40,7 +40,7 @@ jobs:
 
       # https://cibuildwheel.readthedocs.io/en/stable/options/#testing
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.20
+        uses: pypa/cibuildwheel@v2.21
         env:
           CIBW_BUILD: cp310-* cp311-* cp312-* cp313-*
           CIBW_SKIP: '*-win32 *-manylinux_i686 *-musllinux*'

{pycontrails-0.53.1 → pycontrails-0.54.1}/.github/workflows/test.yaml

@@ -123,7 +123,6 @@ jobs:
         shell: bash
         run: |
           pip check
-          make black-check
-          make ruff
+          make lint
           make mypy
           make pytest

{pycontrails-0.53.1 → pycontrails-0.54.1}/.pre-commit-config.yaml

@@ -1,13 +1,21 @@
 repos:
   - repo: local
     hooks:
-      - id: ruff
-        name: ruff
+      - id: ruff-format
+        name: ruff format
+        language_version: python3
+        language: python
+        entry: ruff format
+        types: [file]
+        files: \.(py|ipynb)$
+      - id: ruff-lint
+        name: ruff lint
         language_version: python3
         language: python
         entry: ruff check
         args: [--fix, --exit-non-zero-on-fix]
-        types: [python]
+        types: [file]
+        files: \.(py|ipynb)$
       - id: doc8
         name: doc8
         language_version: python3
@@ -15,13 +23,6 @@ repos:
         entry: doc8
         types: [file]
         files: \.(rst)$
-      - id: black
-        name: black
-        language_version: python3
-        language: python
-        entry: black
-        types: [file]
-        files: \.(py|ipynb)$
       - id: nb-clean
         name: nb-clean
         language_version: python3

{pycontrails-0.53.1 → pycontrails-0.54.1}/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+## 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
+
+- Perform model-level to pressure-level conversion in-house instead of relying on `metview`. This update has several advantages:
+  - The `ARCOERA5` and `ERA5ModelLevel` interfaces no longer require `metview` to be installed. Similarly, grib files and the associated tooling can also largely be avoided.
+  - The computation is performed using `xarray` and `dask` tooling, which means the result can be computed lazily if desired.
+  - The computation is defined using `numpy` operations (some of which release the GIL) and can be parallelized using threading through `dask` (this is the default behavior).
+  - The computation is generally a bit faster than the `metview` implementation (this depends on the exact chunking of the model level meteorology data). This chunking can be tuned by the user to optimize runtime performance or memory usage.
+
+  See the `ml_to_pl` function for low-level details.
+
+- Update the `ARCOERA5` and `ERA5ModelLevel` interfaces to use the new model-level to pressure-level conversion. The ERA5 model level data is now downloaded as the netcdf format instead of grib. This format change decreases the download size.
+
+### Breaking changes
+
+- Rename `levels` -> `model_levels` in the `ARCOERA5` and `ERA5ModelLevel` constructors. Rename `cache_grib` -> `cache_download`.
+- Rename `pressure_levels_at_model_levels` -> `model_level_reference_pressure`. Add a new `model_level_pressure` method that requires surface pressure data.
+
+### Fixes
+
+- Update `ERA5ModelLevel` for the new CDS-Beta server.
+
+### Internals
+
+- Use `ruff` to format the codebase in place of `black`.
+- Run `ruff` linting and formatting over the notebook examples in the documentation.
+- Update development documentation with new links.
+
 ## v0.53.1
 
 ### Features

{pycontrails-0.53.1 → pycontrails-0.54.1}/Makefile

@@ -71,14 +71,12 @@ dev-pycontrails-bada:
 # QC, Test
 # -----------
 
-ruff: black-check
-	ruff check pycontrails tests
+lint:
+	ruff check pycontrails tests docs
+	ruff format --check pycontrails tests docs
 
-black:
-	black pycontrails tests
-
-black-check:
-	black pycontrails tests --check
+format:
+	ruff format pycontrails tests docs
 
 # https://taplo.tamasfe.dev/
 taplo:
@@ -107,7 +105,7 @@ pytest-cov:
 		--ignore=tests/unit/test_zarr.py \
 		tests/unit
 
-test: ruff mypy black-check nb-black-check pytest doctest nb-test
+test: lint mypy pytest doctest nb-test
 
 profile:
 	python -m cProfile -o $(script).prof $(script)
@@ -178,11 +176,8 @@ doctest: ensure-numpy-2 ensure-era5-cached ensure-gcp-credentials
 doc8:
 	doc8 docs
 
-nb-black:
-	black docs/**/*.ipynb
-
-nb-black-check:
-	black docs/**/*.ipynb --check
+nb-format-check:
+	ruff format --check docs/**/*.ipynb
 
 # Note must be kept in sync with 
 # `.pre-commit-config.yaml` and `make nb-clean-check`
@@ -206,7 +201,7 @@ nb-clean-check:
 # TODO: 
 #   - Install eccodes on Github Action so GFS notebook can run
 #   - Provide meteorology data for `run-cocip-on-flight` tutorial
-nb-test: ensure-era5-cached nb-clean-check nb-black-check nb-check-links
+nb-test: ensure-era5-cached nb-clean-check nb-format-check nb-check-links
 	python -m pytest --nbval-lax \
 		--ignore=docs/integrations/ACCF.ipynb \
 		--ignore=docs/integrations/APCEMM.ipynb \
@@ -225,13 +220,14 @@ 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
 # NOTE notebooks from docs/integrations/ manually
 # Add `skip-execution` cell tag if you want to skip a cell
 # Add `raises-exception` cell tag if you know the cell raises exception
-nb-execute: ensure-era5-cached nb-black-check nb-check-links
+nb-execute: ensure-era5-cached nb-format-check nb-check-links
 	jupyter nbconvert --inplace \
 		--to notebook \
 		--execute \

{pycontrails-0.53.1/pycontrails.egg-info → pycontrails-0.54.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.53.1
+Version: 0.54.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -36,7 +36,6 @@ Requires-Dist: xarray>=2022.3
 Provides-Extra: complete
 Requires-Dist: pycontrails[ecmwf,gcp,gfs,jupyter,pyproj,sat,vis,zarr]; extra == "complete"
 Provides-Extra: dev
-Requires-Dist: black[jupyter]==24.8.0; extra == "dev"
 Requires-Dist: dep_license; extra == "dev"
 Requires-Dist: fastparquet>=0.8; extra == "dev"
 Requires-Dist: ipdb>=0.13; extra == "dev"
@@ -50,7 +49,7 @@ Requires-Dist: pyarrow>=5.0; 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.5.7; extra == "dev"
+Requires-Dist: ruff==0.6.2; extra == "dev"
 Requires-Dist: setuptools; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: doc8>=1.1; extra == "docs"
@@ -73,7 +72,6 @@ Requires-Dist: ecmwf-api-client>=1.6; extra == "ecmwf"
 Requires-Dist: netcdf4>=1.6.1; extra == "ecmwf"
 Requires-Dist: platformdirs>=3.0; extra == "ecmwf"
 Requires-Dist: requests>=2.25; extra == "ecmwf"
-Requires-Dist: lxml>=5.1.0; extra == "ecmwf"
 Provides-Extra: gcp
 Requires-Dist: google-cloud-storage>=2.1; extra == "gcp"
 Requires-Dist: platformdirs>=3.0; extra == "gcp"

{pycontrails-0.53.1 → pycontrails-0.54.1}/docs/develop.rst

@@ -91,17 +91,17 @@ but should also be run locally before submitting PRs:
 
     $ make test
 
-Lint the repository with `ruff <https://beta.ruff.rs/docs/>`__:
+Lint the repository with `ruff <https://docs.astral.sh/ruff/>`__:
 
 .. code-block:: bash
 
-    $ make ruff
+    $ make lint
 
-Autoformat the repository with `black <https://black.readthedocs.io/en/stable/>`__:
+Autoformat the repository with `ruff <https://docs.astral.sh/ruff/formatter/>`__:
 
 .. code-block:: bash
 
-    $ make black
+    $ make format
 
 Run type checking with `mypy <https://www.mypy-lang.org/>`__:
 
@@ -109,7 +109,7 @@ Run type checking with `mypy <https://www.mypy-lang.org/>`__:
 
     $ make mypy
 
-Run unit tests with `pytest <https://docs.pytest.org/en/7.2.x/>`__:
+Run unit tests with `pytest <https://docs.pytest.org/en/latest/>`__:
 
 .. code-block:: bash
 
@@ -121,7 +121,7 @@ Run notebook validation with `nbval <https://github.com/computationalmodelling/n
 
     $ make nb-test
 
-Run doctests with `pytest <https://docs.pytest.org/en/7.2.x/>`__:
+Run doctests with `pytest <https://docs.pytest.org/en/latest/>`__:
 
 .. code-block:: bash
 
@@ -294,7 +294,7 @@ The project uses `Black <https://black.readthedocs.io/en/stable/>`__,
 standardize code-formatting. These tools are run automatically in a
 pre-commit hook.
 
-The project uses `pytest <https://docs.pytest.org/en/7.2.x/>`__ to run
+The project uses `pytest <https://docs.pytest.org/en/latest/>`__ to run
 unit tests. New code should include clear unit tests for implementation
 and output values. New test files should be included in the
 `/tests/unit/ directory <https://github.com/contrailcirrus/pycontrails/tree/main/tests/unit>`__.

{pycontrails-0.53.1 → pycontrails-0.54.1}/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.53.1 → pycontrails-0.54.1}/docs/integrations/ACCF.ipynb

@@ -24,9 +24,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import matplotlib.pyplot as plt\n",
     "import numpy as np\n",
     "import pandas as pd\n",
-    "import matplotlib.pyplot as plt\n",
     "\n",
     "from pycontrails import Flight\n",
     "from pycontrails.datalib.ecmwf import ERA5\n",
@@ -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.53.1 → pycontrails-0.54.1}/docs/integrations/APCEMM.ipynb

@@ -26,17 +26,16 @@
     "import os\n",
     "\n",
     "import cartopy.crs as ccrs\n",
+    "import matplotlib.pyplot as plt\n",
     "import numpy as np\n",
     "import pandas as pd\n",
-    "import matplotlib.colors as colors\n",
-    "import matplotlib.pyplot as plt\n",
     "import xarray as xr\n",
+    "from matplotlib import colors\n",
     "\n",
-    "from pycontrails import Flight, MetDataset, MetVariable\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.apcemm.inputs import APCEMMInput\n",
     "from pycontrails.models.humidity_scaling import HistogramMatching\n",
     "from pycontrails.models.issr import ISSR\n",
     "from pycontrails.models.ps_model import PSFlight\n",
@@ -54,14 +53,7 @@
     "\n",
     "This demo uses model-level [ERA5](https://www.ecmwf.int/en/forecasts/dataset/ecmwf-reanalysis-v5) data from the [ARCO ERA5 dataset](https://github.com/google-research/arco-era5) for met data. \n",
     "\n",
-    ">  Note this will download ~3 GB of meteorology data to your computer\n",
-    "\n",
-    "Processing ARCO ERA5 data requires [metview](https://metview.readthedocs.io/en/latest/) binaries and python bindings. If pycontrails is installed in a conda environment, metview can be installed by running\n",
-    "```bash\n",
-    "conda install -c conda-forge metview\n",
-    "conda install -c conda-forge metview-python\n",
-    "python -m metview selfcheck\n",
-    "```"
+    ">  Note this will download ~3 GB of meteorology data to your computer"
    ]
   },
   {
@@ -82,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.53.1 → pycontrails-0.54.1}/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