API reference

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

Intersphinx mapping

To use sphinx.ext.intersphinx for generating automatic links from your project to the documenation 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),
}