Metadata-Version: 2.4
Name: scenariocompass
Version: 1.0.0
Summary: Evaluation and analysis of integrated-assessment scenarios
License-Expression: MIT
License-File: LICENSE
Author: Daniel Huppmann
Author-email: huppmann@iiasa.ac.at
Requires-Python: >=3.11, <3.14
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: nomenclature-iamc (>=0.29.6)
Requires-Dist: pandas (>=2.1.1)
Requires-Dist: pyam-iamc (>=3.3.0)
Project-URL: Homepage, https://scenariocompass.org
Project-URL: Repository, https://github.com/IAMconsortium/scenariocompass
Description-Content-Type: text/markdown

# Evaluation and analysis for the Scenario Compass Initiative

[![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/IAMconsortium/scenariocompass/blob/main/LICENSE)
[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pytest](https://img.shields.io/github/actions/workflow/status/IAMconsortium/scenariocompass/pytest.yml?logo=GitHub&label=pytest)](https://github.com/IAMconsortium/scenariocompass/actions/workflows/pytest.yml)

Copyright 2026 IIASA Scenario Services team and the Scenario Compass consortium

This repository is licensed under the [MIT License](LICENSE).

## Overview

This package provides utility functions for evaluation and analysis
of Integrated-Assessement scenarios.

Visit https://scenariocompass.org for more information.

### Scenario evaluation

The Scenario Compass Initiative develops criteria for scenario evaluation, specifically
validation of key variables against historical reference data. The criteria are
given in the directory [scenariocompass/criteria](scenariocompass/criteria) and the
package source code.

The current package implementation is (mostly) consistent with **Release v1.0**
of the Scenario Compass ensemble (doi: https:/doi.org/10.5281/zenodo.18598251 ) released
on February 16, 2026.

### Climate categorization

The Scenario Compass Initiative developed a new set of climate categories, incorporating
insights from IPCC AR6 WG3 and recent publications. Refer to the supplementary material
of [Riahi et al. (in review)](https://doi.org/10.21203/rs.3.rs-8891091/v1) for more information.

## Using the package

To use the **scenariocompass** package, you can use the following code, where `df`
is a **pyam.IamDataFrame** following the
[common-definitions](https://github.com/IAMconsortium/common-definitions) variable template.

```python
from scenariocompass import ScenarioCompassProcessor, ClimateCategorization

# run the scenario evaluation on the scenario data
sci_processor = ScenarioCompassProcessor()
df = sci_processor.apply(df)

# assign the SCI climate categorization
sci_categories = ClimateCategorization()
df = sci_categories.apply(df)
```

Refer to the [documentation](https://scenariocompass.readthedocs.io) for more information.

## Acknowledgement

<img src="./docs/_static/iamc-logo.png" width="300" align="right" alt="PRISMA logo" />

This package and related tools build on the work by the 
[Integrated Assessment Modeling Consortium (IAMC)](https://www.iamconsortium.org).

The Scenario Compass Initiative is grateful for the generous support from the 
[Bezos Earth Fund](https://www.bezosearthfund.org).

This package is developed and maintained by the |ScSe team|. It is released under the
[MIT License](LICENSE).


