pycontrails 0.40.0__tar.gz → 0.40.1__tar.gz

{pycontrails-0.40.0 → pycontrails-0.40.1}/.github/workflows/release.yaml

@@ -50,7 +50,7 @@ jobs:
         CIBW_TEST_EXTRAS: "complete,dev"
         CIBW_TEST_COMMAND: >
           mv {project}/pycontrails {project}/pycontrails-bak &&
-          python -m pytest {project}/tests &&
+          python -m pytest {project}/tests -vv &&
           mv {project}/pycontrails-bak {project}/pycontrails
 
     - uses: actions/upload-artifact@v3
@@ -91,6 +91,7 @@ jobs:
         verify-metadata: true
 
   upload_pypi:
+    if: ${{ github.event_name == 'release' }}
     needs: [build_wheels, build_sdist, check-main-test-status]
     runs-on: ubuntu-latest
     steps:
@@ -101,7 +102,6 @@ jobs:
 
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
-      if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'release' }}
       with:
         user: __token__
         password: ${{ secrets.PYPI_API_TOKEN }}

{pycontrails-0.40.0 → pycontrails-0.40.1}/.github/workflows/test.yaml

@@ -126,4 +126,4 @@ jobs:
         ruff pycontrails tests
         mypy pycontrails
         pydocstyle pycontrails --verbose
-        pytest tests/unit
+        pytest tests/unit -vv

{pycontrails-0.40.0 → pycontrails-0.40.1}/CHANGELOG.md

@@ -1,6 +1,13 @@
 
 # Changelog
 
+## v0.40.1
+
+#### Fixes
+
+- Use [oldest-supported-numpy](https://pypi.org/project/oldest-supported-numpy/) for building pycontrails wheels. This allows pycontrails to be compatible with environments that use old versions of numpy. The [pycontrails v0.40.0 wheels](https://pypi.org/project/pycontrails/0.40.0/#files) are not compatible with numpy 1.22.
+- Fix a unit test (`test_dtypes.py::test_issr_sac_grid_output`) that occasionally hangs.
+
 ## v0.40.0
 
 Support scipy 1.10, improve interpolation performance, and fix many windows issues.

{pycontrails-0.40.0/pycontrails.egg-info → pycontrails-0.40.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.40.0
+Version: 0.40.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0

{pycontrails-0.40.0 → pycontrails-0.40.1}/docs/_static/pycontrails.bib

@@ -382,6 +382,22 @@
   langid = {english}
 }
 
+@inproceedings{schumannContrailCirrusPrediction2010,
+  title = {A Contrail Cirrus Prediction Tool},
+  booktitle = {Proceedings of the 2nd {{International Conference}} on {{Transport}}, {{Atmosphere}} and {{Climate}} ({{TAC-2}})},
+  author = {Schumann, Ulrich},
+  editor = {Sausen, Robert and van Velthoven, Peter F. J. and Br{\"u}ning, Claus and Blum, Anja},
+  year = {2010},
+  volume = {2010--10},
+  pages = {69--74},
+  publisher = {{DLR}},
+  address = {{Aachen, Germany and Maastricht, The Netherlands}},
+  issn = {1434-8454},
+  urldate = {2023-04-16},
+  abstract = {An new ``Contrail Cirrus Prediction Tool'' (CoCiP) has been developed to simulate contrail cirrus resulting from a single flight as well as from a fleet of cruising aircraft, flight by flight, regionally or globally. The method predicts contrail cirrus for given air traffic and weather prediction data. The method describes the life cycle of each contrail individually using a Lagrangian Gaussian plume model with simple bulk contrail ice properties, without feedback to meteorology. Contrails are initiated when the Schmidt-Appleman criterion is satisfied and when the ambient atmosphere is humid enough to allow for contrail persistence. The initial plume properties reflect properties of the originating aircraft. The evolution of individual contrails of cruising aircraft is computed using wind, temperature, humidity, and ice water content from numerical weather prediction (NWP) output. The plume trajectory follows horizontal and vertical wind. The model simulates shear and turbulence driven spreading, ice water content as a function of ice supersaturation, and some ice particle loss processes (turbulent mixing, aggregation and sedimentation). Radiative cloud forcing is estimated for the sum of all contrails using radiative fluxes without contrails from NWP output. The tool is kept simple to allow for efficient contrail simulations. The method has been tested for case studies with some comparisons to observations. The most critical input parameter is the NWP humidity field. The results compare favourably with observations and support interpretations of insitu, satellite and lidar observed aviation impact on cirrus clouds. CoCiP can be used to predict and minimize the climate impact of contrails.},
+  langid = {english}
+}
+
 @article{schumannContrailCirrusPrediction2012,
   title = {A Contrail Cirrus Prediction Model},
   author = {Schumann, U.},
@@ -431,6 +447,23 @@
   langid = {english}
 }
 
+@inproceedings{schumannDeterminationContrailsSatellite1990,
+  title = {Determination of {{Contrails}} from {{Satellite Data}} and {{Observational Results}}},
+  booktitle = {Air {{Traffic}} and the {{Environment}} \textemdash{} {{Background}}, {{Tendencies}} and {{Potential Global Atmospheric Effects}}},
+  author = {Schumann, U. and Wendling, P.},
+  editor = {Schumann, U.},
+  year = {1990},
+  series = {Lecture {{Notes}} in {{Engineering}}},
+  pages = {138--153},
+  publisher = {{Springer}},
+  address = {{Berlin, Heidelberg}},
+  doi = {10.1007/978-3-642-51686-3_9},
+  abstract = {Condensation trails (contrails) from air traffic in the upper troposphere may have an effect on the earth's climate. We first discuss the state of knowledge. Then some results of radiation transfer calculations are reported which help to estimate the order of magnitude of the effects of cirrus clouds and water vapour in comparison to doubling of the concentration of CO2. The main part of the paper describes the analysis of contrails from satellite data. Based on NOAA-AVHRR data we present results for a specific case where contrails covered a few percent of a region including southern Germany and the Alps. Preliminary results are reported for 99 further cases. A pattern recognition method is described to identify contrails and the related cloud cover automatically. Laser observations reflect contrail cross-sections which are several km in width and about 700 m thick. The optical thickness reaches values up to 1.},
+  isbn = {978-3-642-51686-3},
+  langid = {english},
+  keywords = {Advanced Very High Resolution Radiometer,Cloud Cover,Optical Thickness,Sunshine Duration}
+}
+
 @article{schumannEffectiveRadiusIce2011,
   title = {Effective {{Radius}} of {{Ice Particles}} in {{Cirrus}} and {{Contrails}}},
   author = {Schumann, U. and Mayer, B. and Gierens, K. and Unterstrasser, S. and Jessberger, P. and Petzold, A. and Voigt, C. and Gayet, J.-F.},
@@ -496,6 +529,19 @@
   langid = {english}
 }
 
+@incollection{schumannPotentialReduceClimate2011a,
+  title = {Potential to Reduce the Climate Impact of Aviation by Flight Level Changes},
+  booktitle = {3rd {{AIAA Atmospheric Space Environments Conference}}},
+  author = {Schumann, Ulrich and Graf, Kaspar and Mannstein, Hermann},
+  year = {2011},
+  month = jun,
+  series = {Fluid {{Dynamics}} and {{Co-located Conferences}}},
+  publisher = {{American Institute of Aeronautics and Astronautics}},
+  doi = {10.2514/6.2011-3376},
+  urldate = {2023-04-16},
+  keywords = {Aviation,Base of Aircraft Data,Contrails,Cruise Altitude,Earth,Earth Atmosphere,Fuel Consumption,Greenhouse Effect,Numerical Weather Prediction,Optical Depth}
+}
+
 @article{schumannPropertiesIndividualContrails2017,
   title = {Properties of Individual Contrails: A Compilation of Observations and Some Comparisons},
   shorttitle = {Properties of Individual Contrails},
@@ -678,6 +724,23 @@
   howpublished = {http://solardat.uoregon.edu/SolarRadiationBasics.html}
 }
 
+@article{voigtInsituObservationsYoung2010,
+  title = {In-Situ Observations of Young Contrails \textendash{} Overview and Selected Results from the {{CONCERT}} Campaign},
+  author = {Voigt, C. and Schumann, U. and Jurkat, T. and Sch{\"a}uble, D. and Schlager, H. and Petzold, A. and Gayet, J.-F. and Kr{\"a}mer, M. and Schneider, J. and Borrmann, S. and Schmale, J. and Jessberger, P. and Hamburger, T. and Lichtenstern, M. and Scheibe, M. and Gourbeyre, C. and Meyer, J. and K{\"u}bbeler, M. and Frey, W. and Kalesse, H. and Butler, T. and Lawrence, M. G. and Holz{\"a}pfel, F. and Arnold, F. and Wendisch, M. and D{\"o}pelheuer, A. and Gottschaldt, K. and Baumann, R. and Z{\"o}ger, M. and S{\"o}lch, I. and Rautenhaus, M. and D{\"o}rnbrack, A.},
+  year = {2010},
+  month = sep,
+  journal = {Atmospheric Chemistry and Physics},
+  volume = {10},
+  number = {18},
+  pages = {9039--9056},
+  publisher = {{Copernicus GmbH}},
+  issn = {1680-7316},
+  doi = {10.5194/acp-10-9039-2010},
+  urldate = {2023-04-16},
+  abstract = {Lineshaped contrails were detected with the research aircraft Falcon during the CONCERT \textendash{} CONtrail and Cirrus ExpeRimenT \textendash{} campaign in October/November 2008. The Falcon was equipped with a set of instruments to measure the particle size distribution, shape, extinction and chemical composition as well as trace gas mixing ratios of sulfur dioxide (SO2), reactive nitrogen and halogen species (NO, NOy, HNO3, HONO, HCl), ozone (O3) and carbon monoxide (CO). During 12 mission flights over Europe, numerous contrails, cirrus clouds and a volcanic aerosol layer were probed at altitudes between 8.5 and 11.6 km and at temperatures above 213 K. 22 contrails from 11 different aircraft were observed near and below ice saturation. The observed NO mixing ratios, ice crystal and soot number densities are compared to a process based contrail model. On 19 November 2008 the contrail from a CRJ-2 aircraft was penetrated in 10.1 km altitude at a temperature of 221 K. The contrail had mean ice crystal number densities of 125 cm-3 with effective radii reff of 2.6 {$\mu$}m. The presence of particles with r{$>$}50 {$\mu$}m in the less than 2 min old contrail suggests that natural cirrus crystals were entrained in the contrail. Mean HONO/NO (HONO/NOy) ratios of 0.037 (0.024) and the fuel sulfur conversion efficiency to H2SO4 (\εS{$\downarrow$}) of 2.9 \% observed in the CRJ-2 contrail are in the range of previous measurements in the gaseous aircraft exhaust. On 31 October 2010 aviation NO emissions could have contributed by more than 40\% to the regional scale NO levels in the mid-latitude lowest stratosphere. The CONCERT observations help to better quantify the climate impact from contrails and will be used to investigate the chemical processing of trace gases on contrails.},
+  langid = {english}
+}
+
 @article{wasiukAircraftPerformanceModel2015,
   title = {An Aircraft Performance Model Implementation for the Estimation of Global and Regional Commercial Aviation Fuel Burn and Emissions},
   author = {Wasiuk, D. K. and Lowenberg, M. H. and Shallcross, D. E.},

{pycontrails-0.40.0 → pycontrails-0.40.1}/docs/examples/ECMWF.ipynb

@@ -14,9 +14,8 @@
     "\n",
     "Support provided for:\n",
     "\n",
-    "- [ERA5](https://www.ecmwf.int/en/forecasts/dataset/ecmwf-reanalysis-v5) via the [Copernicus Data Store (CDS)](https://cds.climate.copernicus.eu/) and locally downloaded files\n",
-    "- [HRES](https://confluence.ecmwf.int/display/FUG/HRES+-+High-Resolution+Forecast) and [ENS](https://confluence.ecmwf.int/display/FUG/ENS+-+Ensemble+Forecasts?src=contextnavpagetreemode) via [MARS](https://confluence.ecmwf.int/display/UDOC/MARS+user+documentation) and locally downloaded files\n",
-    "- [IFS](https://www.ecmwf.int/en/publications/ifs-documentation) for locally downloaded files\n"
+    "- [ERA5](https://www.ecmwf.int/en/forecasts/dataset/ecmwf-reanalysis-v5) via the [Copernicus Data Store (CDS)](https://cds.climate.copernicus.eu/) using [cdsapi](https://github.com/ecmwf/cdsapi) or user provided files\n",
+    "- [HRES](https://confluence.ecmwf.int/display/FUG/HRES+-+High-Resolution+Forecast) and [ENS](https://confluence.ecmwf.int/display/FUG/ENS+-+Ensemble+Forecasts?src=contextnavpagetreemode) via [MARS](https://confluence.ecmwf.int/display/UDOC/MARS+user+documentation) using [ecmwf-api-client](https://github.com/ecmwf/ecmwf-api-client) or user provided files"
    ]
   },
   {
@@ -28,7 +27,7 @@
     "### Access\n",
     "\n",
     "- Requires account with [Copernicus Data Portal](https://cds.climate.copernicus.eu/cdsapp#!/home)\n",
-    "- Refer to the [CDS API Documentation](https://github.com/ecmwf/cdsapi#configure) for how to create `~/.cdsapirc` file to configure access to CDS.\n",
+    "- Provide `url` and `key` credentials on input, or refer to the [CDS API Documentation](https://github.com/ecmwf/cdsapi#configure) for how to create `~/.cdsapirc` file to configure access.\n",
     "\n",
     "### Reference\n",
     "\n",
@@ -82,6 +81,8 @@
     "    time=\"2022-03-01 00:00:00\",\n",
     "    variables=[\"t\", \"q\", \"u\", \"v\", \"w\", \"ciwc\", \"z\", \"cc\"],  # supports CF name or short names\n",
     "    pressure_levels=[300, 250, 200],\n",
+    "    # url=\"https://cds.climate.copernicus.eu/api/v2\",\n",
+    "    # key=\"<key>\"\n",
     ")\n",
     "era5"
    ]
@@ -123,6 +124,8 @@
     "        \"cc\",\n",
     "    ],  # supports CF name or short names\n",
     "    pressure_levels=[300, 250, 200],\n",
+    "    # url=\"https://cds.climate.copernicus.eu/api/v2\",\n",
+    "    # key=\"<key>\"\n",
     ")\n",
     "era5"
    ]
@@ -1412,7 +1415,12 @@
     }
    ],
    "source": [
-    "era5 = ERA5(time=(\"2022-03-01 00:00:00\", \"2022-03-01 03:00:00\"), variables=[\"tsr\", \"ttr\"])\n",
+    "era5 = ERA5(\n",
+    "    time=(\"2022-03-01 00:00:00\", \"2022-03-01 03:00:00\"),\n",
+    "    variables=[\"tsr\", \"ttr\"],\n",
+    "    # url=\"https://cds.climate.copernicus.eu/api/v2\",\n",
+    "    # key=\"<key>\"\n",
+    ")\n",
     "era5"
    ]
   },
@@ -2061,7 +2069,7 @@
     "Users within ECMWF Member and Co-operating States may contact their Computing Representative to obtain access to MARS. \n",
     "All other users may [request a username and password](https://accounts.ecmwf.int/auth/realms/ecmwf/protocol/openid-connect/registrations?client_id=apps&response_type=code&scope=openid%20email&redirect_uri=https://www.ecmwf.int) and then [get an api key](https://api.ecmwf.int/v1/key/).\n",
     "\n",
-    "- See [ECMWF API Client documentatino](https://github.com/ecmwf/ecmwf-api-client#configure) to configure  local `~/.ecmwfapirc` file:\n",
+    "Provide `url`, `key`, and `email` credentials on input, or see [ECMWF API Client documentation](https://github.com/ecmwf/ecmwf-api-client#configure) to configure  local `~/.ecmwfapirc` file:\n",
     "\n",
     "```json\n",
     "{\n",
@@ -2073,7 +2081,7 @@
     "\n",
     "### Reference\n",
     "\n",
-    "- [HRES](https://confluence.ecmwf.int/display/FUG/HRES+-+High-Resolution+Forecast) Hi-res forecast\n",
+    "- [HRES](https://confluence.ecmwf.int/display/FUG/HRES+-+High-Resolution+Forecast) High resolution forecast\n",
     "- [ENS](https://confluence.ecmwf.int/display/FUG/ENS+-+Ensemble+Forecasts?src=contextnavpagetreemode) Ensemble forecast"
    ]
   },
@@ -2127,6 +2135,9 @@
     "    variables=[\"t\", \"q\", \"u\", \"v\", \"w\", \"z\"],\n",
     "    pressure_levels=[300, 250, 200],\n",
     "    grid=1,\n",
+    "    # url=\"https://api.ecmwf.int/v1\",\n",
+    "    # key=\"<key>\"\n",
+    "    # email=\"<email>\"\n",
     ")\n",
     "hres"
    ]
@@ -3240,7 +3251,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "hres = HRES(time=time, variables=[\"tsr\", \"ttr\"], grid=1)"
+    "hres = HRES(\n",
+    "    time=time,\n",
+    "    variables=[\"tsr\", \"ttr\"],\n",
+    "    grid=1,\n",
+    "    # url=\"https://api.ecmwf.int/v1\",\n",
+    "    # key=\"<key>\"\n",
+    "    # email=\"<email>\"\n",
+    ")"
    ]
   },
   {
@@ -3934,6 +3952,9 @@
     "    variables=[\"t\", \"q\"],\n",
     "    pressure_levels=[300, 250, 200],\n",
     "    forecast_time=\"2022-03-25 12:00:00\",\n",
+    "    # url=\"https://api.ecmwf.int/v1\",\n",
+    "    # key=\"<key>\"\n",
+    "    # email=\"<email>\"\n",
     ")\n",
     "hres"
    ]
@@ -3944,6 +3965,8 @@
    "source": [
     "## IFS\n",
     "\n",
+    "> In development\n",
+    "\n",
     "Integrated Forecasting System from ECMWF\n",
     "\n",
     "- [IFS Documentation](https://www.ecmwf.int/en/publications/ifs-documentation)\n",
@@ -4118,6 +4141,8 @@
     "    variables=variables,\n",
     "    pressure_levels=[300, 250, 150],\n",
     "    cachestore=gcp,\n",
+    "    # url=\"https://cds.climate.copernicus.eu/api/v2\",\n",
+    "    # key=\"<key>\"\n",
     ")"
    ]
   },

{pycontrails-0.40.0 → pycontrails-0.40.1}/docs/examples/Flight.ipynb

@@ -723,7 +723,7 @@
     }
    ],
    "source": [
-    "# Air pressure at waypoint, in Pa\n",
+    "# Altitude, in ft\n",
     "fl.altitude_ft"
    ]
   },

{pycontrails-0.40.0 → pycontrails-0.40.1}/pycontrails/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '0.40.0'
-__version_tuple__ = version_tuple = (0, 40, 0)
+__version__ = version = '0.40.1'
+__version_tuple__ = version_tuple = (0, 40, 1)

{pycontrails-0.40.0 → pycontrails-0.40.1}/pycontrails/core/met.py

@@ -94,7 +94,14 @@ class MetBase(ABC, Generic[XArrayType]):
         """
         for dim in self.dim_order:
             if dim not in self.data.dims:
-                raise ValueError(f"Meteorology data must contain dimension '{dim}'")
+                if dim == "level":
+                    raise ValueError(
+                        f"Meteorology data must contain dimension '{dim}'. "
+                        "For single level data, set 'level' coordinate to constant -1 "
+                        "using `ds = ds.expand_dims({'level': [-1]})`"
+                    )
+                else:
+                    raise ValueError(f"Meteorology data must contain dimension '{dim}'.")
 
     def _validate_longitude(self) -> None:
         """Check longitude bounds.
@@ -220,11 +227,12 @@ class MetBase(ABC, Generic[XArrayType]):
     def _preprocess_dims(self, wrap_longitude: bool) -> None:
         """Confirm DataArray or Dataset include required dimension in a consistent format.
 
-        Expects DataArray or Dataset to contain dimensions "latitude", "longitude", "time",
-        and "level" (in hPa/mbar). Adds additional coordinate variables ``air_pressure``
-        and ``altitude`` coordinates mapped to "level" dimension if "level" > 0.
+        Expects DataArray or Dataset to contain dimensions ``latitude`, ``longitude``, ``time``,
+        and ``level`` (in hPa/mbar).
+        Adds additional coordinate variables ``air_pressure`` and ``altitude`` coordinates
+        mapped to "level" dimension if "level" > 0.
 
-        Set "level" to -1 to signify surface level.
+        Set ``level`` to -1 to signify single level.
 
         .. versionchanged:: 0.40.0
 
@@ -280,7 +288,7 @@ class MetBase(ABC, Generic[XArrayType]):
         dim_order = self.dim_order + [d for d in self.data.dims if d not in self.dim_order]
         self.data = self.data.transpose(*dim_order)
 
-        # surface level data
+        # single level data
         if self.is_single_level:
             # add level attributes to reflect surface level
             self.data["level"].attrs.update(units="", long_name="Single Level")

{pycontrails-0.40.0 → pycontrails-0.40.1}/pycontrails/core/models.py

@@ -147,12 +147,13 @@ class Model(ABC):
     #: Require meteorology is not None on __init__()
     met_required: bool = False
 
-    #: Required meteorology variables
-    #: Each element in the list is a MetVariable or a list[MetVariable].
-    #: If a list[MetVariable], only one variable in the list is required by input :attr:`met`.
+    #: Required meteorology pressure level variables.
+    #: Each element in the list is a :class:`MetVariable` or a ``tuple[MetVariable]``.
+    #: If element is a ``tuple[MetVariable]``, the variable depends on the data source.
+    #: Only one variable in the tuple is required.
     met_variables: tuple[MetVariable | tuple[MetVariable, ...], ...]
 
-    #: Minimal set of required parameters if processing already complete on met input.
+    #: Set of required parameters if processing already complete on ``met`` input.
     processed_met_variables: tuple[MetVariable, ...]
 
     #: Optional meteorology variables