Skip to content
/ pyam Public
forked from IAMconsortium/pyam

an open-source Python package for IAM scenario analysis and visualization

License

Notifications You must be signed in to change notification settings

znicholls/pyam

 
 

Repository files navigation

pyam: a Python toolkit for Integrated Assessment Modeling

Documentation: http://software.ene.iiasa.ac.at/pyam Questions? Start a discussion on our listserv

Overview and scope

The pyam package provides a range of diagnostic tools and functions for analyzing and working with IAMC-format timeseries data.

Features:

  • Summary of models, scenarios, variables, and regions included in a snapshot.
  • Display of timeseries data as pandas.DataFrame with IAMC-specific filtering options.
  • Simple visualization and plotting functions.
  • Diagnostic checks for non-reported variables or timeseries data to identify outliers and potential reporting issues.
  • Categorization of scenarios according to timeseries data or meta-identifiers for further analysis.

The package can be used with timeseries data that follows the data template convention of the Integrated Assessment Modeling Consortium (IAMC). An illustrative example is shown below; see data.ene.iiasa.ac.at/database for more information.

model scenario region variable unit 2005 2010 2015
MESSAGE V.4 AMPERE3-Base World Primary Energy EJ/y 454.5 479.6 ...
... ... ... ... ... ... ... ...

Tutorial

A comprehensive tutorial for the basic functions is included in the first tutorial using a partial snapshot of the IPCC AR5 scenario database.

Documentation

The documentation pages can be built locally. See the instruction in doc/README.

Authors

This package was developed and is currently maintained by Matthew Gidden (@gidden) and Daniel Huppmann (@danielhuppmann).

License

Copyright 2017-2018 IIASA Energy Program

The pyam package is licensed under the Apache License, Version 2.0 (the "License"); see LICENSE and NOTICE for details.

Install

For basic instructions see our website.

To install from source after cloning this repository, simply run

pip install -e .

Development

To setup a development environment, the simplest route is to make yourself a conda environment and then follow the Makefile.

# pyam can be replaced with any other name
# you don't have to specify your python version if you don't want
conda create --name pyam pip python=X.Y.Z
conda activate pyam  # may be  simply `source activate pyam` or just `activate pyam`
# use the make file to create your development environment
# (you only require the -B flag the first time, thereafter you can
# just run `make virtual-environment` and it will only update if
# environment definition files have been updaed)
make -B virtual-environment

To check everything has installed correctly,

pytest tests

All the tests should pass.

About

an open-source Python package for IAM scenario analysis and visualization

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.0%
  • TeX 2.6%
  • Other 1.4%