Skip to main content

Evaluation and analysis for the Scenario Compass Initiative

license Code style: ruff pytest

Copyright 2026 IIASA Scenario Services team and the Scenario Compass consortium

This repository is licensed under the MIT 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 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) 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 variable template.

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 for more information.

Acknowledgement

PRISMA logo

This package and related tools build on the work by the Integrated Assessment Modeling Consortium (IAMC).

The Scenario Compass Initiative is grateful for the generous support from the Bezos Earth Fund.

This package is developed and maintained by the |ScSe team|. It is released under the MIT License.

Release files for scenariocompass 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scenariocompass 1.0.0
File Size Uploaded
scenariocompass-1.0.0.tar.gz 11.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scenariocompass 1.0.0
File Interpreter ABI Platform
scenariocompass-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 27.8 kB

Release files / scenariocompass-1.0.0.tar.gz

Download URL scenariocompass-1.0.0.tar.gz
Size 11.5 kB
Tags Source
SHA-256 checksum
How to use checksums
da0d6e3448613c85dce7c33173c6558716bf8148bc5e7fa69f5f699f225e187e
BLAKE2b-256 checksum
How to use checksums
3bed229b32f980ca101d1f91edd16366598e036ea3ef66a0cd460b4a2f3699c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.

Transparency log

Release files / scenariocompass-1.0.0-py3-none-any.whl

Download URL scenariocompass-1.0.0-py3-none-any.whl
Size 16.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4edd49f1f87a3b556917fbe508947784a72fce2827e33565d345ada0183278de
BLAKE2b-256 checksum
How to use checksums
273dc9054e0720b4c30fe6e9b32f2a47d2736752c82e2f6f99c3309e42891e7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.

Transparency log

Release history Release notifications | RSS feed

1.1.0

2 release files

This release

1.0.0 This release

2 release files

0.1.0

2 release 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