Install

The most basic installation of pyam is trivial.

Via Conda

conda install -c conda-forge pyam

Via Pip

pyam can also be installed via pip.

pip install pyam-iamc

By default, this will not install the optional extras (see Depedencies). To install the optional extras, execute the following command.

pip install pyam-iamc[geoplots]

As a word of warning, if you want to make geospatial plots this may not be the simplest route. The reason is that many geospatial plotting libraries, including cartopy, may not install properly with pip because pip cannot handle the installation of the complicated c-level libraries required.

From Source

pyam can also be installed from source. As with installation via pip, if you want to make geospatial plots this may not be the simplest route. You will have to handle the installation of any c-level libraries which are required for geospatial plotting yourself.

pip install -e git+https://github.com/IAMconsortium/pyam.git#egg=pyam

Depedencies

Like any software project, we stand on the shoulders of giants. Our particular giants include numpy [3], matplotlib [1], and pandas [2]. Explicit requirements are fully enumerated below.

The required depedencies for pyam are:

Traceback (most recent call last):
  File "<string>", line 1, in <module>
AttributeError: module 'setup' has no attribute 'REQUIREMENTS'

The optional depedencies for pyam are:

Traceback (most recent call last):
  File "<string>", line 1, in <module>
AttributeError: module 'setup' has no attribute 'EXTRA_REQUIREMENTS'

The depedencies for building this documentation are:

sphinx
sphinxcontrib-bibtex
sphinxcontrib-fulltoc
sphinxcontrib-programoutput
sphinx-gallery
nbsphinx
numpydoc
cloud_sptheme
nbformat
ipython
jupyter
jupyter_contrib_nbextensions
pillow

References

1

J. D. Hunter. Matplotlib: a 2d graphics environment. Computing In Science & Engineering, 9(3):90–95, 2007. doi:10.1109/MCSE.2007.55.

2

Wes McKinney. Data structures for statistical computing in python. In Stefan van der Walt and Jarrod Millman, editors, Proceedings of the 9th Python in Science Conference, 51 – 56. 2010.

3

Travis Oliphant. NumPy: a guide to NumPy. USA: Trelgol Publishing, 2006–. URL: http://www.numpy.org/.