API Reference

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

Logging behaviour in Jupyter notebooks

The pyam package wants to provide sensible defaults for users unfamiliar with setting up python’s logging library (read more), and therefore will add a streamhandler if (and only if) it determines to be running within a notebook.

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),