Installation

This package is tested using python 3.11, 3.12 and 3.13.

Attention

Due to the better dependency resolution installing with pip>=22 is recommended.

Using pip

pip is Python’s default package management system. If you install Anaconda, then pip is also usable. pip can also be used when Python is installed directly, without using Anaconda.

  1. Ensure pip is installed—with Anaconda, or according to the pip documentation.

  2. Open a command prompt and run:

    $ pip install climate-assessment

From source

  1. (Optional) If you intend to contribute changes to climate-assessment, first register a Github account, and fork the climate-assessment-repository. This will create a new repository <user>/climate-assessment.

  2. Clone either the main repository, or your fork; using the Github Desktop client, or the command line:

    $ git clone git@github.com:iiasa/climate-assessment.git

# or:
$ git clone git@github.com:USER/climate-assessment.git

  3. Make sure that you have a working python installation with versions 3.11, 3.12 or 3.13. Install poetry (https://python-poetry.org/docs/#installation), minimum poetry version 2.x, and the poetry dynamic versioning plugin (https://pypi.org/project/poetry-dynamic-versioning/).

  1. Open a command prompt in the climate-assessment directory and type:

    $ poetry install --with dev --with tests --with docs

    The --with dev --with tests --with docs extra requirements ensure additional dependencies are installed.

  2. (Optional) If installed from source, run the built-in test suite to check that climate-assessment functions correctly on your system:

    $ poetry run pytest tests/integration -m "not nightly and not wg3"

Credits

The message_ix documentation was the main source of the text in this installation guide.

Infiller database

To reproduce the results from the Sixth Assessment Report Working Group III, one must download the AR6 infiller database from the AR6 Scenario Explorer. Go to https://data.ene.iiasa.ac.at/ar6/, log in, and under “Downloads” you will find “Infiller database for silicone: IPCC AR6 WGIII version (DOI: 10.5281/zenodo.6390768)”. Download that file, and place it in your folder of choice (we suggest climate-assessment/data). After that, you can use the following option --infilling-database data/1652361598937-ar6_emissions_vetted_infillerdatabase_10.5281-zenodo.6390768.csv when using the command-line interface.

Climate emulator configuration files

To reproduce the results from the Sixth Assessment Report Working Group III, one must download the relevant specific configuration files for the climate emulator you want to use. See (see Climate emulators) for more information.