pycontrails 0.52.0__tar.gz → 0.52.1__tar.gz

{pycontrails-0.52.0 → 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.52.0 → pycontrails-0.52.1}/CHANGELOG.md

@@ -1,5 +1,24 @@
 # 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

{pycontrails-0.52.0 → 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.52.0
+Version: 0.52.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -28,7 +28,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
 Requires-Dist: dask>=2022.3
-Requires-Dist: numpy<2.0.0,>=1.22
+Requires-Dist: numpy>=1.22
 Requires-Dist: overrides>=6.1
 Requires-Dist: pandas>=2.2
 Requires-Dist: scipy>=1.10
@@ -70,7 +70,7 @@ Requires-Dist: cdsapi>=0.4; extra == "ecmwf"
 Requires-Dist: cfgrib>=0.9; extra == "ecmwf"
 Requires-Dist: eccodes>=1.4; extra == "ecmwf"
 Requires-Dist: ecmwf-api-client>=1.6; extra == "ecmwf"
-Requires-Dist: netcdf4<1.7.0,>=1.6.1; 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"
@@ -94,7 +94,6 @@ 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: h5netcdf>=1.2; extra == "sat"
 Requires-Dist: pillow>=10.3; extra == "sat"
 Requires-Dist: pyproj>=3.5; extra == "sat"
 Requires-Dist: rasterio>=1.3; extra == "sat"
@@ -121,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) |
@@ -140,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
@@ -155,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.52.0 → 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
 

{pycontrails-0.52.0 → pycontrails-0.52.1}/docs/index.rst

@@ -11,11 +11,11 @@ Learn more on `contrails.org <https://contrails.org>`_.
    :header-rows: 0
 
    * - **Version**
-     - |PyPI version| |Supported python versions|
+     - |PyPI version| |conda-forge version| |Supported python versions|
    * - **Citation**
      - |DOI|
    * - **Tests**
-     - |Unit test| |Docs| |Release|
+     - |Unit test| |Docs| |Release| |OpenSSF scorecard|
    * - **License**
      - |Apache License 2.0|
    * - **Community**
@@ -80,6 +80,10 @@ Learn more on `contrails.org <https://contrails.org>`_.
    :alt: Supported python versions
    :target: https://pypi.python.org/pypi/pycontrails
 
+.. |conda-forge version| image:: https://anaconda.org/conda-forge/pycontrails/badges/version.svg
+   :alt: conda-forge version
+   :target: https://anaconda.org/conda-forge/pycontrails
+
 .. |DOI| image:: https://zenodo.org/badge/617248930.svg
    :alt: DOI
    :target: https://zenodo.org/badge/latestdoi/617248930
@@ -96,6 +100,10 @@ Learn more on `contrails.org <https://contrails.org>`_.
    :alt: Release
    :target: https://github.com/contrailcirrus/pycontrails/actions/workflows/release.yaml
 
+.. |OpenSSF scorecard| image:: https://api.securityscorecards.dev/projects/github.com/contrailcirrus/pycontrails/badge
+   :alt: OpenSSF scorecard
+   :target: https://securityscorecards.dev/viewer?uri=github.com/contrailcirrus/pycontrails
+
 .. |Apache License 2.0| image:: https://img.shields.io/pypi/l/pycontrails.svg
    :alt: Apache License 2.0
    :target: https://github.com/contrailcirrus/pycontrails/blob/main/LICENSE

{pycontrails-0.52.0 → pycontrails-0.52.1}/docs/install.rst

@@ -2,15 +2,22 @@
 Install
 =======
 
-Requires
---------
+conda install
+-------------
 
-- Python (3.9 or later)
+Install the latest release from `conda-forge <https://conda-forge.org>`__ using ``conda``:
 
-Core
-----
+.. code-block:: bash
+
+    $ conda install -c conda-forge pycontrails
+
+
+The conda-forge package includes all optional runtime dependencies.
+
+pip install
+-----------
 
-Install the latest release using ``pip``:
+With Python 3.9 or later, install the latest release from PyPI using ``pip``:
 
 .. code-block:: bash
 
@@ -29,13 +36,13 @@ Install the latest development version directly from GitHub:
 
 
 Optional Dependencies
----------------------
+~~~~~~~~~~~~~~~~~~~~~
 
 The ``pycontrails`` package uses optional dependencies for specific features:
 
 .. code-block:: bash
 
-    # install all non-development optional dependencies
+    # install all optional runtime dependencies
     $ pip install "pycontrails[complete]"
 
     # install specific optional dependencies
@@ -57,7 +64,7 @@ for the latest optional dependencies.
 
 
 Pre-built wheels
------------------
+~~~~~~~~~~~~~~~~
 
 Wheels for common platforms are available on `PyPI <https://pypi.org/project/pycontrails/>`__. Currently, wheels are available for:
 

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.52.0'
-__version_tuple__ = version_tuple = (0, 52, 0)
+__version__ = version = '0.52.1'
+__version_tuple__ = version_tuple = (0, 52, 1)

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/core/coordinates.py

@@ -59,27 +59,27 @@ def slice_domain(
     >>> # Call with request as np.array
     >>> request = np.linspace(-20, 20, 100)
     >>> slice_domain(domain, request)
-    slice(640, 801, None)
+    slice(np.int64(640), np.int64(801), None)
 
     >>> # Call with request as tuple
     >>> request = -20, 20
     >>> slice_domain(domain, request)
-    slice(640, 801, None)
+    slice(np.int64(640), np.int64(801), None)
 
     >>> # Call with a buffer
     >>> request = -16, 13
     >>> buffer = 4, 7
     >>> slice_domain(domain, request, buffer)
-    slice(640, 801, None)
+    slice(np.int64(640), np.int64(801), None)
 
     >>> # Call with request as a single number
     >>> request = -20
     >>> slice_domain(domain, request)
-    slice(640, 641, None)
+    slice(np.int64(640), np.int64(641), None)
 
     >>> request = -19.9
     >>> slice_domain(domain, request)
-    slice(640, 642, None)
+    slice(np.int64(640), np.int64(642), None)
 
     """
     # if the length of domain coordinates is <= 2, return the whole domain

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/core/flight.py

@@ -384,7 +384,7 @@ class Flight(GeoVectorDataset):
         ...     time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200),
         ... )
         >>> fl.max_distance_gap
-        7391.27...
+        np.float64(7391.27...)
         """
         if self.attrs["crs"] != "EPSG:4326":
             raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
@@ -415,7 +415,7 @@ class Flight(GeoVectorDataset):
         ...     time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200),
         ... )
         >>> fl.length
-        1436924.67...
+        np.float64(1436924.67...)
         """
         if self.attrs["crs"] != "EPSG:4326":
             raise NotImplementedError("Only implemented for EPSG:4326 CRS.")
@@ -1520,11 +1520,11 @@ class Flight(GeoVectorDataset):
 
         >>> # Length (in meters) of waypoints whose temperature exceeds 236K
         >>> fl.length_met("air_temperature", threshold=236)
-        4132178.159...
+        np.float64(4132178.159...)
 
         >>> # Proportion (with respect to distance) of waypoints whose temperature exceeds 236K
         >>> fl.proportion_met("air_temperature", threshold=236)
-        0.663552...
+        np.float64(0.663552...)
         """
         if key not in self.data:
             raise KeyError(f"Column {key} does not exist in data.")

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/core/interpolation.py

@@ -621,11 +621,11 @@ class EmissionsProfileInterpolator:
     >>> epi = EmissionsProfileInterpolator(xp, fp)
     >>> # Interpolate a single value
     >>> epi.interp(5)
-    0.150000...
+    np.float64(0.150000...)
 
     >>> # Interpolate a single value on a logarithmic scale
     >>> epi.log_interp(5)
-    1.105171...
+    np.float64(1.105171...)
 
     >>> # Demonstrate speed up compared with xarray.DataArray interpolation
     >>> import time, xarray as xr

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/core/met.py

@@ -1375,9 +1375,10 @@ class MetDataArray(MetBase):
 
         # try to create DataArray out of input data and **kwargs
         if not isinstance(data, xr.DataArray):
-            DeprecationWarning(
+            warnings.warn(
                 "Input 'data' must be an xarray DataArray. "
-                "Passing arbitrary kwargs will be removed in future versions."
+                "Passing arbitrary kwargs will be removed in future versions.",
+                DeprecationWarning,
             )
             data = xr.DataArray(data, **kwargs)
 
@@ -2609,13 +2610,14 @@ def _load(hash: str, cachestore: CacheStore, chunks: dict[str, int]) -> xr.Datas
 
 
 def _add_vertical_coords(data: XArrayType) -> XArrayType:
-    """Add "air_pressure" and "altitude" coordinates to data."""
+    """Add "air_pressure" and "altitude" coordinates to data.
 
-    data["level"].attrs.update(units="hPa", long_name="Pressure", positive="down")
+    .. versionchanged:: 0.52.1
+        Ensure that the ``dtype`` of the additional vertical coordinates agree
+        with the ``dtype`` of the underlying gridded data.
+    """
 
-    coords = data.coords
-    if "air_pressure" in coords and "altitude" in coords:
-        return data
+    data["level"].attrs.update(units="hPa", long_name="Pressure", positive="down")
 
     # XXX: use the dtype of the data to determine the precision of these coordinates
     # There are two competing conventions here:
@@ -2625,25 +2627,32 @@ def _add_vertical_coords(data: XArrayType) -> XArrayType:
     # It is more important for air_pressure and altitude to be grid-aligned than to be
     # coordinate-aligned, so we use the dtype of the data to determine the precision of
     # these coordinates
-    if isinstance(data, xr.Dataset):
-        dtype = np.result_type(*data.data_vars.values(), np.float32)
-    else:
-        dtype = data.dtype
-    level = data["level"].values.astype(dtype, copy=False)
+    dtype = (
+        np.result_type(*data.data_vars.values(), np.float32)
+        if isinstance(data, xr.Dataset)
+        else data.dtype
+    )
 
-    if "air_pressure" not in coords:
+    level = data["level"].values
+
+    if "air_pressure" not in data.coords:
         data = data.assign_coords(air_pressure=("level", level * 100.0))
         data.coords["air_pressure"].attrs.update(
             standard_name=AirPressure.standard_name,
             long_name=AirPressure.long_name,
             units=AirPressure.units,
         )
-    if "altitude" not in coords:
+    if data.coords["air_pressure"].dtype != dtype:
+        data.coords["air_pressure"] = data.coords["air_pressure"].astype(dtype, copy=False)
+
+    if "altitude" not in data.coords:
         data = data.assign_coords(altitude=("level", units.pl_to_m(level)))
         data.coords["altitude"].attrs.update(
             standard_name=Altitude.standard_name,
             long_name=Altitude.long_name,
             units=Altitude.units,
         )
+    if data.coords["altitude"].dtype != dtype:
+        data.coords["altitude"] = data.coords["altitude"].astype(dtype, copy=False)
 
     return data

{pycontrails-0.52.0 → pycontrails-0.52.1}/pycontrails/core/polygon.py

@@ -536,7 +536,7 @@ def multipolygon_to_geojson(
             else:
                 shape = len(ring.coords), 3
                 coords = np.empty(shape)
-                coords[:, :2] = ring.coords
+                coords[:, :2] = np.asarray(ring.coords)
                 coords[:, 2] = altitude
 
             poly_coords.append(coords.tolist())