API Reference

This page gives an overview of the public pyam features, objects, functions and methods.

Notebook logging behaviour

pyam wants to provide sensible defaults for users unfamiliar with setting up python’s logging library, and therefore will provide a basic configuration by invoking

import logging
logging.basicConfig(level="INFO", format="%(name)s - %(levelname)s: %(message)s")

if (and only if):

  1. it determines to be running within a notebook, and

  2. logging is still unconfigured by the time the first logging message by |pyam| is to be emitted.

Intersphinx mapping

To use sphinx.ext.intersphinx for generating automatic links from your project to the documentation of pyam classes and functions, please add the following to your project’s conf.py:

intersphinx_mapping = {
    'pyam': ('https://pyam-iamc.readthedocs.io/en/stable/', None),