pycontrails 0.47.3__tar.gz → 0.48.1__tar.gz

{pycontrails-0.47.3 → pycontrails-0.48.1}/.github/workflows/docs.yaml

@@ -41,7 +41,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.11'
+          python-version: '3.12'
           cache: 'pip'
           cache-dependency-path: pyproject.toml
 

{pycontrails-0.47.3 → pycontrails-0.48.1}/.github/workflows/doctest.yaml

@@ -41,7 +41,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.11'
+          python-version: '3.12'
           cache: 'pip'
           cache-dependency-path: pyproject.toml
 

{pycontrails-0.47.3 → pycontrails-0.48.1}/.github/workflows/release.yaml

@@ -46,7 +46,7 @@ jobs:
           CIBW_SKIP: '*-win32 *-manylinux_i686 *-musllinux*'
           CIBW_BUILD_VERBOSITY: 3
           CIBW_ARCHS_MACOS: x86_64 arm64
-          CIBW_TEST_SKIP: '*-macosx_arm64 cp312-*'
+          CIBW_TEST_SKIP: '*-macosx_arm64'
           # 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"

{pycontrails-0.47.3 → pycontrails-0.48.1}/.github/workflows/scorecard.yaml

@@ -30,7 +30,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Run OpenSSF Security Scorecard
-        uses: ossf/scorecard-action@v2.3.0
+        uses: ossf/scorecard-action@v2.3.1
         with:
           results_file: results.sarif
           results_format: sarif

{pycontrails-0.47.3 → pycontrails-0.48.1}/.github/workflows/test.yaml

@@ -1,8 +1,6 @@
 # Run unit tests from the ground up
 # installing "pycontrails" into the Github OS environments
 
-# TODO: Include windows platforms testing here
-
 name: Unit tests
 
 on:
@@ -40,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        pyversion: ['3.9', '3.10', '3.11']
+        pyversion: ['3.9', '3.10', '3.11', '3.12']
     runs-on: ${{ matrix.os }}
 
     steps:

{pycontrails-0.47.3 → pycontrails-0.48.1}/.gitignore

@@ -6,6 +6,7 @@
 .DS_Store
 .idea
 _main_debug.py
+debug.ipynb
 *.swp
 *.swo
 
@@ -55,6 +56,7 @@ docs/examples/airports
 # data
 .ecmwf
 *.nc
+*.grib
 bada/
 
 # docker

{pycontrails-0.47.3 → pycontrails-0.48.1}/CHANGELOG.md

@@ -1,6 +1,68 @@
 
 # Changelog
 
+## v0.48.1
+
+### Features
+
+- Generalize `met.shift_longitude()` to translate longitude coordinates onto any domain bounds.
+- Add `VectorDataset.to_dict()` methods to output Vector data as dictionary. This method enables `Flight.to_dict()` objects to be serialized for input to the [Contrails API](https://api.contrails.org).
+- Add `VectorDataset.from_dict()` class method to create `VectorDataset` class from dictionary.
+- Support more time formats, including timezone aware times, in `VectorDataset` creation. All timezone aware `"time"`` coordinates are converted to UTC and stripped of timezone identifier.
+
+### Fixes
+
+- Fix issue in the `wake_vortex.max_downward_displacement` function in which float32 dtypes were promoted to float64 dtypes in certain cases.
+- Ignore empty vectors in `VectorDataset.sum`.
+
+### Internals
+
+- Set `frozen=True` on the `MetVariable` dataclass.
+- Test against python 3.12 in the GitHub Actions CI. Use python 3.12 the docs and doctest workflows.
+
+## v0.48.0
+
+This release includes a number of breaking changes and new features. If upgrading from a previous version of `pycontrails`, please read the changelog carefully. Open an [issue](https://github.com/contrailcirrus/pycontrails/issues) if you experience problems.
+
+### Breaking changes
+
+- When running `Cocip` and other `pycontrails` models, the `met` and `rad` parameter must now contain predefined metadata attributes `provider`, `dataset`, and `product` describing the met source. An error will now be raised in `Cocip` if these attributes are not present.
+- Deprecate passing arbitrary `kwargs` into the `MetDataArray` constructor.
+- No longer convert accumulated radiation data to average instantaneous data in `ERA5` and `HRES` interfaces. This logic is now handled downstream by the model (e.g., `Cocip`). This change allows for more flexibility in the `rad` data passed into the model and avoids unnecessary computation in the `MetDataSource` interfaces.
+- Add new `MetDataSource.set_met_source_metadata` abstract method. This should be called within the implementing class `open_metdataset` method.
+- No longer take a finite difference in the time dimension for HRES radiation data. This is now also handled natively in `Cocip`.
+- No longer convert relative humidity from a percentage to a fraction in `ERA5` and `HRES` interfaces.
+- Require the `HRES` `stream` parameter to be one of `["oper", "enfo"]`. Require the `field_type` parameter to be one of `["fc", "pf", "cf", "an"]`.
+- Remove the `steps` and `step_offset` properties in the `GFSForecast` interface. Now the `timesteps` attribute is the only source of truth for determining AWS S3 keys. Change the `filename` method to take in a `datatime` timestep instead of an `int` step. No longer assign the first step radiation data to the zeroth step.
+- Change the return type of `ISSR.eval`, `SAC.eval`, and `PCR.eval` from `MetDataArray` to `MetDataset`. This is more consistent with the return type of other `pycontrails` models and more closely mirrors the behavior of vector models. Set output `attrs` metadata on the global `MetDataset` instead of the individual `MetDataArray` in each case.
+
+### Features
+
+- Rewrite parts of the `pycontrails.core.datalib` module for higher performance and readability.
+- Add optional `attrs` and `attrs_kwargs` parameters to `MetDataset` constructor. This allows the user to customize the attributes on the underlying `xarray.Dataset` object. This update makes `MetDataset` more consistent with `VectorDataset`.
+- Add three new properties `provider_attr`, `dataset_attr`, and `product_attr` to `MetDataset`. These properties give metadata describing the underlying meterological data source.
+- Add new `Model.transfer_met_source_attrs` method for more consistent handling of met source metadata on the `source` parameter passed into `Model.eval`.
+- No longer require `geopotential` data when computing `tau_cirrus`. If neither `geopotential` nor `geopotential_height` are available, geopotential is approximated from the geometric height. No longer require geopotential on the `met` parameter in `Cocip` or `CocipGrid`.
+- Remove the `Cocip` `shift_radiation_time` parameter. This is now inferred directly from the `rad` metadata. An error is raised if the necessary metadata is not present.
+- Allow `Cocip` to run with both instantaneous (`W m-2`) and accumulated (`J m-2`) radiation data.
+- Allow `Cocip` to run with accumulated ECMWF HRES radiation data.
+
+### Fixes
+
+- Correct radiation unit in the `ACCF` wrapper model [#64]. Both instantaneous (`W m-2`) and accumulated (`J m-2`) radiation data are now supported, and the `ACCF` wrapper will handle each appropriately.
+- Avoid unnecessary writing and reading of temporary files in `ERA5.cache_dataset` and `HRES.cache_dataset`.
+- Fix timestep resolution bug in `GFSForecast`. When the `grid` parameter is 0.5 or 1.0, forecasts are only available every 3 hours. Previously, the `timesteps` property would define an hourly timestep.
+
+### Internals
+
+- Include `name` parameter in `MetDataArray` constructor.
+- Make the `coordinates.slice_domain` function slightly more performant by explicitly dropping nan values from the `request` parameter.
+- Round unwieldy floating point numbers in `GeoVectorDataset._display_attrs`.
+- Remove the `ecmwflibs` package from the `ecmwf` optional dependencies.
+- Add NPY to `ruff` rules.
+- Add convenience `MetDataset.standardize_variables` method.
+- Remove the `p_settings` attribute on the `ACCF` interface. This is now constructed internally within `ACCF.eval`. Replace the `ACCF._update_accf_config` method with a `_get_accf_config` function.
+
 ## v0.47.3
 
 ### Fixes

{pycontrails-0.47.3/pycontrails.egg-info → pycontrails-0.48.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycontrails
-Version: 0.47.3
+Version: 0.48.1
 Summary: Python library for modeling aviation climate impacts
 Author-email: Breakthrough Energy <py@contrails.org>
 License: Apache-2.0
@@ -68,7 +68,6 @@ 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: ecmwflibs>=0.4; 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"
@@ -84,6 +83,7 @@ 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: aiohttp>=3.9.0b0; python_version >= "3.12" and extra == "goes"
 Requires-Dist: cartopy>=0.22; extra == "goes"
 Requires-Dist: gcsfs>=2022.3; extra == "goes"
 Requires-Dist: h5netcdf>=1.2; extra == "goes"

{pycontrails-0.47.3 → pycontrails-0.48.1}/docs/api.rst

@@ -35,6 +35,7 @@ Flight & Aircraft
     :toctree: api/
 
     Flight
+    FlightPhase
     Fuel
     JetA
     SAFBlend