Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • Institutional organization owner
    Organization dlr-pa has institutional domain (www.dlr.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

OpenAirClim

Basic Info
  • Host: GitHub
  • Owner: dlr-pa
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 32.8 MB
Statistics
  • Stars: 12
  • Watchers: 2
  • Forks: 1
  • Open Issues: 35
  • Releases: 4
Created over 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

OpenAirClim

DOI Install and Test workflow

Description

OpenAirClim is a model for simplified evaluation of the approximate chemistry-climate impact of air traffic emissions. The model represents the major responses of the atmosphere to emissions in terms of composition and climate change. Instead of applying time-consuming climate-chemistry models, a response model is developed and applied which reproduces the response of a climate-chemistry model without actually calculating ab initio all the physical and chemical effects. The responses are non-linear relations between localized emissions and Radiative Forcing and further climate indicators. These response surfaces are contained within look-up tables. OpenAirClim builds upon the previous AirClim framework (see section References). In comparison with AirClim, following new features are introduced:

  • Standardized formats for configuration file (user interface) and emission inventories (input) and program results (output)
  • Possibility of full 4D emission inventories (3D for several time steps)
  • Non-linear response functions for NOx including contribution approach (tagging) and dependency on background
  • Contrail formation also depending on fuels and overall efficiencies
  • Inclusion of different fuels
  • Choice of different CO2 response models
  • Choice of temperature models and sea-level rise
  • Uncertainty assessment and Robustness Metric based on Monte Carlo Simulations
  • Parametric scenarios as sensitivities, e.g. at post-processing level: climate optimized routings

Scientific Background

The impact of aviation on climate amounts to approximately 5% of the total anthropogenic climate warming. A large part of the aviation’s impact arises from non-CO2 effects, especially contrails and nitrogen oxide emissions. Impact of non-CO2 effects depend in particular on the location and time of emissions, hence a regional dependence of impacts exists. As impacts of individual non-CO2 effects show a different spatial dependence, the relationship between impacts and associated emissions can be best described in non-linear relationships, i.e. equations or algorithms based on look-up tables. Specifically, the climate impact of an aircraft depends on where (and when) an aircraft is operated. In addition, using different types of fuel generally changes the importance of the non-CO2 effects.

Layout

Overview on the layout of the OpenAirClim 3.0 framework

Overview on the layout of the OpenAirClim 3.0 framework

  • User interface for settings in the run control and outputs (grey)
  • Definition of background conditions, such as aviation scenarios, uncertainty ranges and aviation inventories (orange)
  • A link to a pre-processor for aviation inventories (light blue).
  • Processor for a full 4D-emission inventory at multiple timesteps (violet)
  • A framework for the application of non-linear response functions (red) to these emission inventories.
  • Response functions for CO2 and climate / temperature and sea-level changes
  • Parametric scenarios as sensitivities (yellow), e.g. at post-processing level: climate optimized routings
  • Output: Warnings, errors (log files), climate indicators and diagnostics (green), values of climate metrics and robustness metrics (grey)

Installation

If you build OpenAirClim from source, you first have to access the repository. To obtain the repository, the most convenient way is using following Git command: git clone https://github.com/dlr-pa/oac.git

There are two options to install the package:

Installation via conda environment

If you have chosen this method, the conda or mamba package manager has to be installed first.

The source code includes configuration files environment_xxx.yaml that enable the installation of a virtual conda environment with all required dependencies. This installation method is suitable for working across platforms. To create an environment from that file, change directory to the root folder of the downloaded source and execute following command: conda env create -f environment_xxx.yaml

This installation method allows you to run OpenAirClim locally within the downloaded directory only. In order to be able to run OpenAirClim system-wide, the PYTHONPATH variable has to be changed properly that the Python interpreter finds the openairclim package.

After having installed the conda ennvironment and required dependencies, proceed with the steps described in section Getting started.

Installation via pip

The prerequesite for this installation method is to have installed Python version >= 3.4. Then, the installer program pip is included by default. In your console, change directory to the root folder of the dowloaded source and execute following command: pip install . In order to install OpenAirClim in editable mode, use the -e flag: pip install -e . If you contribute to the software development of OpenAirClim, extra packages are required. In order to install both, normal and extra dependencies, execute following command (with or without -e flag): pip install ".[dev]" After having installed the conda ennvironment and required dependencies, proceed with the steps described in section Getting started.

Getting started

Download emission inventories

Air traffic emission inventories are essential input to OpenAirClim. You can download example emission inventories based on the DLR project Development Pathways for Aviation up to 2050 (DEPA 2050). These inventories comprise realistic emission data sets.

Depending on the settings made in the configuration file, the computational time of the configured simulations could be long. If you are more interested in testing or developing OpenAirClim software, you might want to generate artificial data.

Create input data

If you do not have custom input files available, input files with artificial data can be autogenerated using command line scripts. For that, change directory to utils/ and execute following commands in order to create artificial input files: cd utils/ python create_artificial_inventories.py python create_time_evolution.py The script create_artificial_inventories.py creates a series of inventories comprising random emission data. The script create_time_evolution.py creates two time evolution files, controlling the temporal evolution of the emission data: one file is intended for normalizing inventory emission data, and the other file is intended for scaling inventory emission data along the time axis. Emission inventories and time evolution files are both .nc files and are located in directory example/input.

Create test files

If you contribute to the software development of OpenAirClim, you will probably execute the testing procedures which require additional test files. Following command creates these files: python create_test_files.py

Documentation

Build API documentation

OpenAirClim modules, classes and functions are documented by docstrings. This application programming interface (API) documentation is written alongside the code itself. The API documentation can by extracted and converted into nice looking formats such as html pages. In order to build OpenAirClim's API documentation, first make sure that you have installed the Sphinx package. Then execute following commands for building the API documentation in html format:

cd docs/ make html

The generated html files can be found under docs/_build/html/.

Program workflows

Some of the most relevant program workflows are described separately. These descriptions give an overview over high-level routines which would be difficult to understand by the API documentation alone.

Scientific bases

A description of the scientific bases of OpenAirClim will be added in the upcoming versions.

Usage

After installation, the package can be imported and used in Python scripts: import openairclim as oac

Refer to the example/ folder in the repository for a minimal example demonstrating the OpenAirClim framework.

Roadmap

Major planned software releases and milestones for the project planning are:

  • OpenAirClim 2.8
    • 4D-Emission-module finalized
    • CO2 concentration changes finalized
    • Temperature evolution and climate metrics finalized
    • Some response functions available, e.g. for ozone
  • OpenAirClim 3.0

References

  • Grewe, V., & Stenke, A. (2008). AirClim: an efficient tool for climate evaluation of aircraft technology. Atmospheric Chemistry and Physics, 8(16), 4621-4639.
  • Dahlmann, K. (2011). A method for the efficient evaluation of climate optimisation measures for air transport Eine Methode zur effizienten Bewertung von Maßnahmen zur Klimaoptimierung des Luftverkehrs.
  • Hüttenhofer, L. (2013). Parametrisierung von Kondensstreifenzirren für AirClim 2.0 (Bachelor Thesis, Ludwig-Maximilians-Universität München, Munich).
  • Dahlmann, K., Grewe, V., Frömming, C., & Burkhardt, U. (2016). Can we reliably assess climate mitigation options for air traffic scenarios despite large uncertainties in atmospheric processes?. Transportation Research Part D: Transport and Environment, 46, 40-55.
  • Grewe, V., Bock, L., Burkhardt, U., et al. (2017). Assessing the climate impact of the AHEAD multi-fuel blended wing body. Meteorologische Zeitschrift, 26(6), 711-725.
  • Leipold, A. et al. (2021) DEPA 2050 – Development Pathways for Aviation up to 2050 (Final Report). https://elib.dlr.de/142185/
  • Megill, L. and Grewe, V.: Investigating the limiting aircraft-design-dependent and environmental factors of persistent contrail formation, Atmos. Chem. Phys., 25, 4131–4149, https://doi.org/10.5194/acp-25-4131-2025, 2025.

Support

Contributing

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

Authors and acknowledgment

License

The license of the OpenAirClim sofware can be found here.

Owner

  • Name: DLR Institute of Atmospheric Physics
  • Login: dlr-pa
  • Kind: organization
  • Location: Oberpfaffenhofen, Germany

German Aerospace Center (DLR) e.V.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: OpenAirClim
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Stefan
    family-names: Völk
    email: Stefan.Voelk@dlr.de
    orcid: 'https://orcid.org/0000-0001-9720-6504'
    affiliation: German Aerospace Center (DLR)
  - orcid: 'https://orcid.org/0000-0003-2458-1826'
    given-names: Hiroshi
    family-names: Yamashita
    affiliation: German Aerospace Center (DLR)
    email: Hiroshi.Yamashita@dlr.de
  - given-names: Liam
    family-names: Megill
    email: Liam.Megill@dlr.de
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0000-0002-4199-6962'
  - given-names: Katrin
    family-names: Dahlmann
    email: Katrin.Dahlmann@dlr.de
    orcid: 'https://orcid.org/0000-0003-3198-1713'
    affiliation: German Aerospace Center (DLR)
  - given-names: Volker
    family-names: Grewe
    email: Volker.Grewe@dlr.de
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0000-0002-8012-6783'
abstract: >-
  OpenAirClim is a model for simplified evaluation of the
  approximate chemistry-climate impact of air traffic
  emissions. The model represents the major responses of the
  atmosphere to emissions in terms of composition and
  climate change. Instead of applying time-consuming
  climate-chemistry models, a response model is developed
  and applied which reproduces the response of a
  climate-chemistry model without actually calculating ab
  initio all the physical and chemical effects. The
  responses are non-linear relations between localized
  emissions and Radiative Forcing and further climate
  indicators. These response surfaces are contained within
  look-up tables.
keywords:
  - climate impact
  - aviation
  - response modelling
  - assessment
license: Apache-2.0
version: 2.8.3
date-released: '2024-08-05'

GitHub Events

Total
  • Create event: 23
  • Release event: 3
  • Issues event: 68
  • Watch event: 11
  • Delete event: 13
  • Member event: 3
  • Issue comment event: 24
  • Push event: 131
  • Pull request review event: 66
  • Pull request review comment event: 53
  • Pull request event: 34
  • Fork event: 2
Last Year
  • Create event: 23
  • Release event: 3
  • Issues event: 68
  • Watch event: 11
  • Delete event: 13
  • Member event: 3
  • Issue comment event: 24
  • Push event: 131
  • Pull request review event: 66
  • Pull request review comment event: 53
  • Pull request event: 34
  • Fork event: 2

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 115
  • Total Committers: 3
  • Avg Commits per committer: 38.333
  • Development Distribution Score (DDS): 0.417
Past Year
  • Commits: 115
  • Committers: 3
  • Avg Commits per committer: 38.333
  • Development Distribution Score (DDS): 0.417
Top Committers
Name Email Commits
Stefan Voelk s****k@d****e 67
Liam Megill l****l@d****e 47
Liam Megill l****m@a****u 1
Committer Domains (Top 20 + Academic)
dlr.de: 2 avy.eu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 59
  • Total pull requests: 28
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Total issue authors: 6
  • Total pull request authors: 3
  • Average comments per issue: 0.36
  • Average comments per pull request: 0.14
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 59
  • Pull requests: 28
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Issue authors: 6
  • Pull request authors: 3
  • Average comments per issue: 0.36
  • Average comments per pull request: 0.14
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • liammegill (30)
  • stefan-voelk (23)
  • fagunter (5)
  • ahsawa (1)
  • harjotsingh21 (1)
  • joesalamoneiii (1)
Pull Request Authors
  • liammegill (20)
  • stefan-voelk (17)
  • AbaniKaurKohli (2)
Top Labels
Issue Labels
type: feature (26) module: contrails (14) module: core (12) good first issue (9) type: docs (6) module: utils (5) type: fix (5) type: bug (5) type: testing (3) type: discussion (3) module: calc_ch4 (2) module: interpolate_space (2) module: write_output (2) module: interpolate_time (2) module: plot (1) module: construct_conc (1) module: calc_dt (1) enhancement (1) contrails (1) module: co2 (1) module: nox (1)
Pull Request Labels
type: feature (14) module: contrails (12) module: core (6) type: docs (6) type: chore (5) type: fix (5) type: bug (3) module: utils (3) module: nox (2) module: calc_ch4 (2) module: write_output (1)