Metadata-Version: 2.4
Name: openairclim
Version: 0.18.0
Summary: A response model for calculating the climate impact of air traffic emissions
Author-email: OpenAirClim Team <openairclim@dlr.de>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://openairclim.org/
Project-URL: Repository, https://github.com/dlr-pa/oac
Project-URL: Documentation, https://openairclim.org/
Project-URL: Bug Tracker, https://github.com/dlr-pa/oac/issues
Project-URL: Changelog, https://github.com/dlr-pa/oac/blob/main/CHANGELOG.md
Keywords: climate,aviation,air traffic,aircraft emissions,climate impact,atmospheric science,non-CO2 effects,contrails,radiative forcing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11.5
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: joblib
Requires-Dist: numpy
Requires-Dist: pandas<3
Requires-Dist: matplotlib
Requires-Dist: pint
Requires-Dist: xarray
Requires-Dist: netcdf4
Requires-Dist: scipy
Requires-Dist: deepmerge
Requires-Dist: ambiance
Requires-Dist: pydantic
Requires-Dist: platformdirs
Requires-Dist: requests
Provides-Extra: gui
Requires-Dist: panel; extra == "gui"
Requires-Dist: param; extra == "gui"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: ipykernel; extra == "docs"
Requires-Dist: genbadge; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: dev
Requires-Dist: openairclim[docs,gui,test]; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: prospector; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pyroma; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: readme_renderer[md]; extra == "dev"
Dynamic: license-file

# OpenAirClim

![Pip installation](https://github.com/dlr-pa/oac/actions/workflows/pip-install-test.yml/badge.svg)
![Conda installation](https://github.com/dlr-pa/oac/actions/workflows/conda-install-test.yml/badge.svg)
[![Docs](https://github.com/dlr-pa/oac/actions/workflows/build-docs.yml/badge.svg)](https://openairclim.org)
![Coverage](https://openairclim.org/_static/coverage.svg)
<br>
[![pypi](https://img.shields.io/pypi/v/openairclim?color=orange&label=pypi&logo=python&logoColor=white)](https://pypi.org/project/openairclim/)
[![pypi - python version](https://img.shields.io/pypi/pyversions/openairclim.svg?color=orange&logo=python&label=python&logoColor=white)](https://pypi.org/project/openairclim/)
[![downloads](https://img.shields.io/pypi/dm/openairclim)](https://pypi.org/project/openairclim/)
<br>
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Latest tag](https://img.shields.io/github/v/tag/dlr-pa/oac)](https://github.com/dlr-pa/oac/tags)
[![Commits since last release](https://img.shields.io/github/commits-since/dlr-pa/oac/latest.svg)](https://github.com/dlr-pa/oac/commits/main)
[![Contributors](https://img.shields.io/github/contributors/dlr-pa/oac)](https://github.com/dlr-pa/oac/graphs/contributors)
[![License](https://img.shields.io/github/license/dlr-pa/oac)](https://github.com/dlr-pa/oac/blob/main/LICENSE)
<br>
[![DOI](https://zenodo.org/badge/851165490.svg)](https://zenodo.org/doi/10.5281/zenodo.13682728)


## 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](https://raw.githubusercontent.com/dlr-pa/oac/main/docs/source/_static/OAC-chart.png)
<figcaption>Overview of the OpenAirClim framework</figcaption>


## Documentation

Please refer to [openairclim.org](https://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](https://pip.pypa.io/en/stable/)
(Python 3.11 or later required):

```bash
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:

```bash
# 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](https://docs.conda.io/en/latest/) or
[mamba](https://mamba.readthedocs.io/en/latest/) package manager is installed
on your system. Currently, the only installation possibility with conda is by
first cloning the [GitHub repository](https://github.com/dlr-pa/oac) and then
installing the required dependencies using the provided `environment_xxx.yaml`
files:

```bash
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](https://github.com/dlr-pa/oac-data).
To download the data to a shared cache, use:

```bash
oac-download-data
```

See the [installation guide](https://openairclim.org/installation.html) 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](https://elib.dlr.de/142185/)
[here](https://doi.org/10.5281/zenodo.11442322).
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/](https://github.com/dlr-pa/oac/tree/main/openairclim/utils):

```bash
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:

```bash
oac-gui
```

### Run OpenAirClim
OpenAirClim can be run from the command line using:

```bash
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:

```bash
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](CHANGELOG.md). The full
development stage as currently planned is shown in the [layout](#layout).

## Contributing
Contributions are very welcome. Please read our
[contribution guidelines](CONTRIBUTING.md) to get started.

## License
OpenAirClim is licensed under Apache 2.0, a copy of which can be found
[here](LICENSE).
