pycontrails 0.51.2__tar.gz → 0.52.1__tar.gz

{pycontrails-0.51.2 → pycontrails-0.52.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.18
+        uses: pypa/cibuildwheel@v2.19
         env:
           CIBW_BUILD: cp39-* cp310-* cp311-* cp312-*
           CIBW_SKIP: '*-win32 *-manylinux_i686 *-musllinux*'
@@ -50,6 +50,10 @@ jobs:
           # Completely isolate tests to prevent cibuildwheel from importing the
           # source instead of the wheel. This happens when tests/__init__.py is read.
           CIBW_TEST_EXTRAS: "complete,dev"
+          # Make sure GITHUB_ACTIONS
+          # (used to selectively skip expensive unit test)
+          # is passed through when testing linux wheels
+          CIBW_ENVIRONMENT_PASS_LINUX: GITHUB_ACTIONS
           CIBW_TEST_COMMAND: >
             mv {project}/pycontrails {project}/pycontrails-bak &&
             python -m pytest {project}/tests -vv &&

{pycontrails-0.51.2 → pycontrails-0.52.1}/.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
         name: ruff
         language_version: python3
         language: python
-        entry: ruff
+        entry: ruff check
         args: [--fix, --exit-non-zero-on-fix]
         types: [python]
       - id: doc8

{pycontrails-0.51.2 → pycontrails-0.52.1}/CHANGELOG.md

@@ -1,14 +1,72 @@
 # Changelog
 
+## v0.52.1
+
+### Breaking changes
+
+- Remove `lock=False` as a default keyword argument to `xr.open_mfdataset` in the `MetDataSource.open_dataset` method. This reverts a change from [v0.44.1](https://github.com/contrailcirrus/pycontrails/releases/tag/v0.44.1) and prevents segmentation faults when using recent versions of [netCDF4](https://pypi.org/project/netCDF4/) (1.7.0 and above).
+- GOES imagery is now loaded from a temporary file on disk rather than directly from memory when using `GOES.get` without a cachestore.
+
+### Internals
+
+- Remove upper limits on netCDF4 and numpy versions.
+- Remove h5netcdf dependency.
+- Update doctests with numpy 2 scalar representation (see [NEP 51](https://numpy.org/neps/nep-0051-scalar-representation.html)). Doctests will now fail when run with numpy 1.
+- Run certain tests in `test_ecmwf.py` and `test_met.py` using the single-threaded dask scheduler to prevent tests from hanging while waiting for a lock that is never released. (This issue was [encountered previously](https://github.com/contrailcirrus/pycontrails/pull/68), and removing `lock=False` in `MetDataSource.open_dataset` reverts the fix.)
+- Document pycontrails installation from conda-forge.
+
+### Fixes
+
+- Ensure the `MetDataset` vertical coordinates `"air_pressure"` and `"altitude"` have the correct dtype.
+
+## v0.52.0
+
+### Breaking changes
+
+- The `_antimeridian_index` helper method in the `flight` module now returns a list of integers rather than an integer. This allows `Flight.to_geojson_multilinestring` to support multiple antimeridian crossings (see below).
+
+### Features
+
+- Add tools for running [APCEMM](https://github.com/MIT-LAE/APCEMM) from within pycontrails. This includes:
+    - utilities for generating APCEMM input files and running APCEMM (`pycontrails.models.apcemm.utils`)
+    - an interface (`pycontrails.models.apcemm.apcemm`) that allows users to run APCEMM as a pycontrails `Model`.
+- Add [APCEMM tutorial notebook](https://py.contrails.org/integrations/APCEMM.html).
+- Add prescribed sedimentation rate to `DryAdvection` model.
+- Add `Landsat` and `Sentinel` datalibs for searching, retrieving, and visualizing Landsat 8-9 and Sentinel-2 imagery. The datalibs include:
+    - Tools for querying Landsat and Sentinel-2 imagery for intersections with user-defined regions (`landsat.query`, `sentinel.query`) or flights (`landsat.intersect`, `sentinel.intersect`). These tools use BigQuery tables and require a Google Cloud Platform account with access to the BigQuery API.
+    - Tools for downloading and visualizing imagery from Landsat (`Landsat`) and Sentinel-2 (`Sentinel`). These tools retrieve data anonymously from Google Cloud Platform storage buckets and can be used without a Google Cloud Platform account.
+- Add tutorial notebooks demonstrating how to use `Landsat` and `Sentinel` datalibs to find flights in high-resolution satellite imagery.
+- Modify `Flight.to_geojson_multilinestring` to make grouping key optional and to support multiple antimeridian crossings.
+- Update the `pycontrails` build system to require `numpy 2.0` per the [official numpy guidelines](https://numpy.org/devdocs/dev/depending_on_numpy.html#numpy-2-0-specific-advice). Note that the runtime requirement for `pycontrails` remains `numpy>=1.22`.
+- Update `pycontrails` for breaking changes introduced in `numpy 2.0` (e.g., [NEP 50](https://numpy.org/neps/nep-0050-scalar-promotion.html)). All changes are backward compatible with `numpy>=1.22`.
+
+### Fixes
+
+- Ensure width and depth are never attached to `DryAdvection` source when running pointwise-only model.
+- Ensure that azimuth is not dropped when present in `DryAdvection` input source.
+- Exclude netCDF version 1.7.0, which causes non-deterministic failures in unit tests primarily due to segmentation faults.
+- Pin numpy to 1.x in runtime dependencies until a working numpy 2.x-compatible netCDF4 release is available.
+
+### Internals
+
+- Create unit tests for the `APCEMM` interface that run if an `APCEMM` executable is found on the `PATH` inside a clean APCEMM git repository with a pinned git hash. These tests will be skipped unless users carefully configure their local test environment and will not run in CI.
+- Exclude APCEMM tutorial notebook from notebook tests.
+- Add unit tests for Landsat and Sentinel search tools and datalibs, but disable any tests that retrieve imagery data when running tests in GitHub Actions to limit resource consumption in GitHub runners. Users can disable these units tests locally by setting the environment variable `GITHUB_ACTIONS=true`.
+- Ensure `GITHUB_ACTIONS` environment variable is available when building and testing wheels on linux.
+- Skip cells that retrieve imagery data when running tests on Landsat and Sentinel tutorial notebooks.
+- Add tests for `Flight.to_geojson_multilinestring` with grouping key omitted and update tests with multiple antimeridian crossings.
+- Minimum pandas version is bumped to 2.2 to ensure the the `include_groups` keyword argument used in `Flight.to_geojson_multilinestring` is available.
+- Upgrade minimum `mypy` dependencies
+
 ## v0.51.2
 
 ### Features
 
-- Add functionality to automatically compare  simulated contrails from `cocip.Cocip` with GOES satellite imagery (`compare_cocip_with_goes`)
+- Add functionality to automatically compare  simulated contrails from `cocip.Cocip` with GOES satellite imagery (`compare_cocip_with_goes`).
 
 ### Internals
 
-- Fix documentation build in CI
+- Fix documentation build in CI.
 
 ## v0.51.1
 
@@ -18,9 +76,9 @@
 
 ### 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
+- 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
 

{pycontrails-0.51.2 → pycontrails-0.52.1}/Makefile

@@ -133,6 +133,13 @@ main-test-status:
 DOCS_DIR = docs
 DOCS_BUILD_DIR = docs/_build
 
+# Check that numpy 2 is being used
+ensure-numpy-2:
+	[[ $$(python -c 'import numpy as np; print(np.__version__)') == 2.* ]] \
+	|| ( \
+		echo -e "$(COLOR_YELLOW)NumPy 2 required for doctests$(END_COLOR)"; \
+		exit 1)
+
 # Check for GCP credentials
 ensure-gcp-credentials:
 	python -c 'from google.cloud import storage; storage.Client()' \
@@ -163,7 +170,7 @@ ensure-era5-cached:
 cache-era5-gcp: ensure-era5-cached
 	gcloud storage cp -r -n .doc-test-cache/* gs://contrails-301217-unit-test/doc-test-cache/
 
-doctest: ensure-era5-cached ensure-gcp-credentials
+doctest: ensure-numpy-2 ensure-era5-cached ensure-gcp-credentials
 	pytest --doctest-modules \
 		--ignore-glob=pycontrails/ext/* \
 		pycontrails -vv
@@ -202,6 +209,7 @@ nb-clean-check:
 nb-test: ensure-era5-cached nb-clean-check nb-black-check nb-check-links
 	python -m pytest --nbval-lax \
 		--ignore=docs/integrations/ACCF.ipynb \
+		--ignore=docs/integrations/APCEMM.ipynb \
 		--ignore=docs/notebooks/specific-humidity-interpolation.ipynb \
 		--ignore=docs/notebooks/GFS.ipynb \
 		--ignore=docs/notebooks/run-cocip-on-flight.ipynb \

{pycontrails-0.51.2/pycontrails.egg-info → pycontrails-0.52.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.51.2
+Version: 0.52.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -30,19 +30,19 @@ License-File: NOTICE
 Requires-Dist: dask>=2022.3
 Requires-Dist: numpy>=1.22
 Requires-Dist: overrides>=6.1
-Requires-Dist: pandas>=1.4
+Requires-Dist: pandas>=2.2
 Requires-Dist: scipy>=1.10
 Requires-Dist: xarray>=2022.3
 Provides-Extra: complete
-Requires-Dist: pycontrails[ecmwf,gcp,gfs,goes,jupyter,pyproj,vis,zarr]; extra == "complete"
+Requires-Dist: pycontrails[ecmwf,gcp,gfs,jupyter,pyproj,sat,vis,zarr]; extra == "complete"
 Provides-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"
 Requires-Dist: memory_profiler; extra == "dev"
-Requires-Dist: mypy>=0.99; extra == "dev"
-Requires-Dist: mypy-extensions>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: mypy-extensions>=1.0; extra == "dev"
 Requires-Dist: platformdirs>=3.0; extra == "dev"
 Requires-Dist: pre-commit>=2.10; extra == "dev"
 Requires-Dist: psutil; extra == "dev"
@@ -84,13 +84,20 @@ Requires-Dist: cfgrib>=0.9; extra == "gfs"
 Requires-Dist: eccodes>=1.4; extra == "gfs"
 Requires-Dist: platformdirs>=3.0; extra == "gfs"
 Requires-Dist: tqdm>=4.61; extra == "gfs"
-Provides-Extra: goes
-Requires-Dist: cartopy>=0.22; extra == "goes"
-Requires-Dist: gcsfs>=2022.3; extra == "goes"
-Requires-Dist: h5netcdf>=1.2; extra == "goes"
 Provides-Extra: jupyter
 Requires-Dist: ipywidgets>=7.6; extra == "jupyter"
 Requires-Dist: jupyterlab>=2.2; extra == "jupyter"
+Provides-Extra: sat
+Requires-Dist: cartopy>=0.22; extra == "sat"
+Requires-Dist: db-dtypes>=1.2; extra == "sat"
+Requires-Dist: gcsfs>=2022.3; extra == "sat"
+Requires-Dist: geojson>=3.1; extra == "sat"
+Requires-Dist: google-cloud-bigquery>=3.23; extra == "sat"
+Requires-Dist: google-cloud-bigquery-storage>=2.25; extra == "sat"
+Requires-Dist: pillow>=10.3; extra == "sat"
+Requires-Dist: pyproj>=3.5; extra == "sat"
+Requires-Dist: rasterio>=1.3; extra == "sat"
+Requires-Dist: scikit-image>=0.18; extra == "sat"
 Provides-Extra: open3d
 Requires-Dist: open3d>=0.14; extra == "open3d"
 Provides-Extra: pyproj
@@ -113,7 +120,7 @@ Requires-Dist: zarr>=2.12; extra == "zarr"
 
 |               |                                                                   |
 |---------------|-------------------------------------------------------------------|
-| **Version**   | [![PyPI version](https://img.shields.io/pypi/v/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) [![Supported python versions](https://img.shields.io/pypi/pyversions/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) |
+| **Version**   | [![PyPI version](https://img.shields.io/pypi/v/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails)  [![conda-forge version](https://anaconda.org/conda-forge/pycontrails/badges/version.svg)](https://anaconda.org/conda-forge/pycontrails) [![Supported python versions](https://img.shields.io/pypi/pyversions/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) |
 | **Citation**  | [![DOI](https://zenodo.org/badge/617248930.svg)](https://zenodo.org/badge/latestdoi/617248930) |
 | **Tests**     | [![Unit test](https://github.com/contrailcirrus/pycontrails/actions/workflows/test.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/test.yaml) [![Docs](https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml) [![Release](https://github.com/contrailcirrus/pycontrails/actions/workflows/release.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/release.yaml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/contrailcirrus/pycontrails/badge)](https://securityscorecards.dev/viewer?uri=github.com/contrailcirrus/pycontrails)|
 | **License**   | [![Apache License 2.0](https://img.shields.io/pypi/l/pycontrails.svg)](https://github.com/contrailcirrus/pycontrails/blob/main/LICENSE) |
@@ -132,7 +139,9 @@ Documentation and examples available at [py.contrails.org](https://py.contrails.
 
 ## Install
 
-Requires Python (3.9 or later)
+### Install with pip
+
+You can install pycontrails from PyPI with `pip` (Python 3.9 or later required):
 
 ```bash
 $ pip install pycontrails
@@ -147,7 +156,17 @@ Install the latest development version directly from GitHub:
 pip install git+https://github.com/contrailcirrus/pycontrails.git
 ```
 
-See more options in the [install documentation](https://py.contrails.org/install).
+### Install with conda
+
+You can install pycontrails from the [conda-forge](https://conda-forge.org/) channel with `conda` (or other `conda`-like package managers such as `mamba`):
+
+```bash
+conda install -c conda-forge pycontrails
+```
+
+The conda-forge package includes all optional runtime dependencies.
+
+See more installation options in the [install documentation](https://py.contrails.org/install).
 
 ## Get Involved
 

{pycontrails-0.51.2 → pycontrails-0.52.1}/README.md

@@ -4,7 +4,7 @@
 
 |               |                                                                   |
 |---------------|-------------------------------------------------------------------|
-| **Version**   | [![PyPI version](https://img.shields.io/pypi/v/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) [![Supported python versions](https://img.shields.io/pypi/pyversions/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) |
+| **Version**   | [![PyPI version](https://img.shields.io/pypi/v/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails)  [![conda-forge version](https://anaconda.org/conda-forge/pycontrails/badges/version.svg)](https://anaconda.org/conda-forge/pycontrails) [![Supported python versions](https://img.shields.io/pypi/pyversions/pycontrails.svg)](https://pypi.python.org/pypi/pycontrails) |
 | **Citation**  | [![DOI](https://zenodo.org/badge/617248930.svg)](https://zenodo.org/badge/latestdoi/617248930) |
 | **Tests**     | [![Unit test](https://github.com/contrailcirrus/pycontrails/actions/workflows/test.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/test.yaml) [![Docs](https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/docs.yaml) [![Release](https://github.com/contrailcirrus/pycontrails/actions/workflows/release.yaml/badge.svg)](https://github.com/contrailcirrus/pycontrails/actions/workflows/release.yaml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/contrailcirrus/pycontrails/badge)](https://securityscorecards.dev/viewer?uri=github.com/contrailcirrus/pycontrails)|
 | **License**   | [![Apache License 2.0](https://img.shields.io/pypi/l/pycontrails.svg)](https://github.com/contrailcirrus/pycontrails/blob/main/LICENSE) |
@@ -23,7 +23,9 @@ Documentation and examples available at [py.contrails.org](https://py.contrails.
 
 ## Install
 
-Requires Python (3.9 or later)
+### Install with pip
+
+You can install pycontrails from PyPI with `pip` (Python 3.9 or later required):
 
 ```bash
 $ pip install pycontrails
@@ -38,7 +40,17 @@ Install the latest development version directly from GitHub:
 pip install git+https://github.com/contrailcirrus/pycontrails.git
 ```
 
-See more options in the [install documentation](https://py.contrails.org/install).
+### Install with conda
+
+You can install pycontrails from the [conda-forge](https://conda-forge.org/) channel with `conda` (or other `conda`-like package managers such as `mamba`):
+
+```bash
+conda install -c conda-forge pycontrails
+```
+
+The conda-forge package includes all optional runtime dependencies.
+
+See more installation options in the [install documentation](https://py.contrails.org/install).
 
 ## Get Involved