API Reference#
Data#
Meteorology#
|
Meteorological dataset with multiple variables. |
|
Meteorological DataArray of single variable. |
Vector Data#
|
Base class to hold 1D arrays of consistent size. |
|
Base class to hold 1D geospatial arrays of consistent size. |
Flight & Aircraft#
|
A single flight trajectory. |
|
Data structure for holding a sequence of |
|
Flight phase enumeration. |
|
Base class for the physical parameters of the fuel. |
|
Jet A-1 Fuel. |
|
Jet A-1 / Sustainable Aviation Fuel Blend. |
|
Hydrogen Fuel. |
Datalib#
ECMWF#
|
Class to support ERA5 data access, download, and organization. |
|
Class to support HRES data access, download, and organization. |
Create forecast filename from ECMWF dissemination products. |
|
|
ECMWF Integrated Forecasting System (IFS) data source. |
ECMWF Parameter Support. |
GFS#
|
GFS Forecast data access. |
GFS Parameter Support. |
GOES#
Support for GOES access and analysis. |
Models#
Base Classes#
|
Base class for physical models. |
|
Class for constructing model parameters. |
SAC, ISSR & PCC#
Ice super-saturated regions (ISSR). |
|
Schmidt-Appleman criteria (SAC). |
|
Persistent contrail regions (PCR = SAC & ISSR). |
|
Probability of persistent contrail coverage (PCC). |
CoCiP#
|
Contrail Cirrus Prediction Model (CoCiP). |
|
Model parameters required by the CoCiP models. |
Contrail Property Calculations. |
|
Module for calculating radiative forcing of contrail cirrus. |
|
Wave-vortex downwash functions. |
|
Wind shear functions. |
ACCF#
|
Compute Algorithmic Climate Change Functions (ACCF). |
|
Default ACCF model parameters. |
Aircraft Performance#
In development
Abstract interfaces for aircraft performance models. |
|
Default parameters for |
|
|
Simulate aircraft performance using Poll-Schumann (PS) model. |
|
Compute nominal Poll-Schumann aircraft performance over a grid. |
Store extracted aircraft and engine parameters for each aircraft type. |
|
|
Calculate the nominal performance grid for a given aircraft type. |
Emissions#
|
Emissions handling using ICAO Emissions Databank (EDB) and black carbon correlations. |
Non-volatile particulate matter (nvPM) calculations. |
|
Calculate nitrogen oxide (NOx), carbon monoxide (CO) and hydrocarbon (HC) emissions. |
Cirrus Optical Depth (\(\tau_{cirrus}\))#
Calculate tau cirrus on Met data. |
Humidity Scaling#
Humidity scaling methodologies. |
Physics#
Meteorological, thermophysical, and aircraft constants. |
|
Thermodynamic relationships. |
|
Jet aircraft trajectory and performance parameters. |
|
Tools for spherical geometry, solar radiation, and wind advection. |
|
Unit conversion support. |
Cache#
|
Cache that uses a folder on the local filesystem. |
|
Google Cloud Platform (Storage) Cache. |
Core#
Airport data support. |
|
Pycontrails Caching Support. |
|
Coordinates utilities. |
|
Datalib utilities. |
|
A single data structure encompassing a sequence of |
|
Flight Data Handling. |
|
Fuel data support. |
|
Interpolation utilities. |
|
Meteorology data models. |
|
Module containing core met variables. |
|
Physical model data structures. |
|
Algorithm support for grid to polygon conversion. |
|
Lightweight data structures for vector paths. |
Utilities#
Convienence types. |
|
Utilites for iterating of sequences. |
|
Temp utilities. |
|
JSON utilities. |
Extensions#
BADA#
Requires pycontrails-bada extension and data files obtained through BADA license. See BADA Extension for more information.
BADA models along flight and on a regular grid. |
|
|
Compute aircraft properties and fuel consumption. |
|
|
|
Compute nominal BADA values for a large grid of independent points. |
|
|
|
BADA 3.15 Support. |
|
BADA 4.2 Support. |