Skip to main content

OpenAirClim

Pip installation Conda installation Docs Coverage
pypi pypi - python version downloads
Code style: black Latest tag Commits since last release Contributors License
DOI

Description

OpenAirClim is an open-source response model for quantifying the climate impact of air traffic emissions. Rather than explicitly simulating physical processes, it uses response functions derived from comprehensive climate-chemistry models. This makes OpenAirClim particularly fast and efficient, with individual runs taking seconds to minutes on a conventional computer.

Motivation

Aviation operations account for around 3.5% of Effective Radiative Forcing and its share is expected to grow. A large part of aviation's impact arises from non-CO2 effects, in particular nitrogen oxide emissions and the formation of contrails. The impact of non-CO2 effects is highly dependent on the location and time of the emission, as well as on the characteristics of the emitting aircraft. Emerging aircraft and fuels (e.g. SAF, hydrogen, hybrid-electric) demand new, open and efficient tools to quantify their climate impacts. However, existing models are either closed, too general or computationally intense.

OpenAirClim and its add-ons constitute an open-source framework to rapidly model aviation emissions and their climate response: supporting science, industry and policy. Development is being led by the German Aerospace Center (Deutsches Zentrum für Luft- und Raumfahrt, DLR) and includes various research and industry partners.

Highlights

OpenAirClim builds upon the previous AirClim framework. Compared to AirClim, the new OpenAirClim framework:

  • Provides standardised, open formats for the simulation configuration file, emission inventories and results
  • Provides a Graphical User Interface (GUI) for interactive configuration and results exploration
  • Handles multiple emission inventories over time (4D dependence)
  • Allows attribution of climate impact to specific aircraft or fleets
  • Implements tagging for atmospheric chemistry
  • Extends contrail calculations to novel aviation fuels
  • Enables the calculation of parametric scenarios at post-processing level, e.g. climate optimised routing
  • Provides uncertainty and robustness metrics (work in progress)
  • Provides various outputs, including time series of radiative forcing and temperature change, various climate metrics and sea-level rise

Typical use cases

OpenAirClim is aimed both at research and industry. Typical research questions that can be answered by using OpenAirClim relate to:

  • fleet-wide scenarios, e.g. the introduction of a new aircraft type; climate impact of operations from a specific airline or airport
  • aviation industry scenarios, e.g. the introduction of a new fuel type; climate-optimal distribution of SAF
  • operational procedures, e.g. intermediate stop operations; flying lower and slower

Layout

Overview on the layout of the OpenAirClim framework

Overview of the OpenAirClim framework

Documentation

Please refer to openairclim.org for the documentation of the OpenAirClim framework. The documentation includes installation manuals, quick-start and user guides, example demonstrations, an API reference, as well as information on the scientific background and OpenAirClim governance.

Installation

OpenAirClim is currently available from PyPI at https://pypi.org/project/openairclim or from source at https://github.com/dlr-pa/oac. Later OpenAirClim versions will also be available from conda-forge (work in progress).

Install with pip

To install OpenAirClim from PyPI with pip (Python 3.11 or later required):

pip install openairclim

# install with optional dependencies (gui, docs, test, dev)
pip install openairclim[dev]

To install the latest development version directly from GitHub, you have two options:

# with git
git clone https://github.com/dlr-pa/oac.git

# with pip
pip install git+https://github.com/dlr-pa/oac.git

Install with conda

To install OpenAirClim with conda, make sure that either the conda or mamba package manager is installed on your system. Currently, the only installation possibility with conda is by first cloning the GitHub repository and then installing the required dependencies using the provided environment_xxx.yaml files:

git clone https://github.com/dlr-pa/oac-git
cd oac
conda env create -f environment_xxx.yaml
conda activate <env>

# optional: install GUI dependencies
conda env update -f environment_gui.yaml -n <env>

# install OpenAirClim in the conda environment with pip
pip install .

Replace xxx with either minimal or dev (full installation) and <env> with the correct name of the conda environment (e.g. oac or oac_minimal). To install an editable version of the openairclim package, allowing you to make changes to the source code and see those changes reflected immediately, use pip install -e . instead.

Getting started

Download repository data

OpenAirClim's response surfaces and background concentration scenarios are published separately, in dlr-pa/oac-data. To download the data to a shared cache, use:

oac-download-data

See the installation guide for override options.

Emission inventories

Air traffic emission inventories are an essential input to OpenAirClim. You can download example emission inventories based on the DLR project DEPA 2050 here. These inventories comprise realistic air traffic between 2020 and 2070.

If you are interested in testing or developing OpenAirClim, you might want to generate artificial data. This can be done using command line scripts from openairclim/utils/:

oac-create-artificial-inventories -o example/input/
oac-create-time-evolution -o example/input/

Graphical User Interface

OpenAirClim ships with an optional GUI for creating, loading and editing configuration files, inspecting input data, running simulations and exploring results. Provided the gui dependencies have been installed, it can be launched using:

oac-gui

Run OpenAirClim

OpenAirClim can be run from the command line using:

cd path/to/working/directory
oac-run <config-name>.toml

Note that if there are any relative links in the config file (e.g. dir = input/), you must be in the right working directory for OpenAirClim to run successfully.

Create test files

If you contribute to the development of OpenAirClim, you will require additional test files. To create them, use:

python -m openairclim.utils.create_test_files -o tests/core/repository/

Roadmap

The scheduling of major software releases and milestone planning are partially dependent on the contractual framework with our stakeholders. For the version history of the completed releases, see the changelog. The full development stage as currently planned is shown in the layout.

Contributing

Contributions are very welcome. Please read our contribution guidelines to get started.

License

OpenAirClim is licensed under Apache 2.0, a copy of which can be found here.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openairclim-0.18.0.tar.gz (140.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openairclim-0.18.0-py3-none-any.whl (158.1 kB view details)

Uploaded Python 3

File details

Details for the file openairclim-0.18.0.tar.gz.

File metadata

  • Download URL: openairclim-0.18.0.tar.gz
  • Upload date:
  • Size: 140.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for openairclim-0.18.0.tar.gz
Algorithm Hash digest
SHA256 3b0de870fc80595b79b81771c56960c758c06b6b375fa2baaeb3408673d7f063
MD5 8bf4d90c373e3c8c54cce84f944f4282
BLAKE2b-256 0887bcff8e08e8a348a0894b35d292d87d61443f69dcbe188d84c41832e6eddc

See more details on using hashes here.

Provenance

The following attestation bundles were made for openairclim-0.18.0.tar.gz:

Publisher: publish.yml on dlr-pa/oac

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openairclim-0.18.0-py3-none-any.whl.

File metadata

  • Download URL: openairclim-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 158.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for openairclim-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14b31070f8d8ce0164b93ac20340f516bfb41c0a3176bc9c45d6ddbd6add036a
MD5 035b9528f151dc1ee9aac4d11f42f980
BLAKE2b-256 2b3862a5710d12e05756f6c2035fd7c4f1f6f9b6c088aca5c7d6e4c36c4dfc78

See more details on using hashes here.

Provenance

The following attestation bundles were made for openairclim-0.18.0-py3-none-any.whl:

Publisher: publish.yml on dlr-pa/oac

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.18.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page