The integrated assessment and energy systems model MESSAGEix
Branch: master
Clone or download
khaeru and gidden Improve documentation (#138)
* update links in tutorial docs

- Link to Github notebook viewer of Austrian tutorial from README.
- Update doc link *from* Austrian tutorial to live docs, rather than
  (outdated) internal.

* add #138 to release notes

* change tutorials README from .md → .rst

…so that markup is processed correctly when included in docs.

* index all tutorial notebooks; include directly on 'Getting Started'

* move tutorial instructions from top-level README

* increase toctree maxdepth in docs index; section levels in model docs

* consolidate installation docs

- doc/index: link to IIASA and spell out the name
- doc/contributing: link to Github issues/PRs

* add message_ix.utils to API docs

* improve use of toctree, automodule in API docs

* document Scenario.add_cat, utils.make_df

* tidy markup in model docs

* convert grab_gams_doc into a Sphinx module

* add explanatory text to westeros_baseline tutorial

* incorporate installation tips from #72

* use pip in INSTALL instructions

* get cells by name instead of index when testing tutorials

* revert change to westeros grid_efficiency to clear infeasibility

* test_tutorials.get_cell_by_name(): return the cell, not its name

* fix URL typo in doc/source/index.rst

* document ixmp.model_settings.register_model

* remove notebook cell output from westeros_baseline tutorial

- Also update contributor guidelines.

* shim for docs build on Python 2.7 w/o pathlib

* disable grab_gams_docs Sphinx ext on Python3
Latest commit 7ea8663 Jan 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci revamping CI (#153) Jan 19, 2019
doc Improve documentation (#138) Jan 25, 2019
message_ix Improve documentation (#138) Jan 25, 2019
rmessageix MESSAGEix manuscript reference update #107 (#140) Dec 20, 2018
tests Improve documentation (#138) Jan 25, 2019
tutorial Improve documentation (#138) Jan 25, 2019
.gitignore Add requirements file + update readme (#139) Dec 13, 2018
.gitmodules Install model (#15) Jun 4, 2018
.stickler.yml add pr template, release notes, and stickler (#58) Jun 26, 2018
.travis.yml revamping CI (#153) Jan 19, 2019
AUTHORS.md added tzipperle to the authors (#11) Apr 5, 2018
CONTRIBUTING.rst Improve documentation (#138) Jan 25, 2019
CONTRIBUTOR_LICENSE.rst release updates of doc-pages, license info, publication reference (#37) Mar 12, 2018
Dockerfile Adding CI for testing scenarios on circleci. Additionally add initial… Nov 14, 2018
INSTALL.rst Improve documentation (#138) Jan 25, 2019
LICENSE Initial commit Dec 4, 2017
NOTICE.rst MESSAGEix manuscript reference update #107 (#140) Dec 20, 2018
PULL_REQUEST_TEMPLATE.md add pr template, release notes, and stickler (#58) Jun 26, 2018
README.md Improve documentation (#138) Jan 25, 2019
RELEASE_NOTES.md Improve documentation (#138) Jan 25, 2019
appveyor.yml add ability to dump data directly to excel and read it back (#60) Jul 10, 2018
install.bat add ci for config cli, fixes #41 (#54) Jun 21, 2018
requirements.txt Add requirements file + update readme (#139) Dec 13, 2018
setup.py Add requirements file + update readme (#139) Dec 13, 2018

README.md

The MESSAGEix framework

Overview

MESSAGEix is a versatile, open-source, dynamic systems-optimization model. It was developed for strategic energy planning and integrated assessment of energy-engineering-economy-environment systems (E4). The framework includes the possibility for integration with the general-economy MACRO model to incorporate the feedback from price changes on demand for commodities or energy services. The mathematical formulation is based on the MESSAGE Integrated Assessment model developed at IIASA since the 1980s.

The MESSAGEix and MACRO models are implemented in GAMS. This repository contains the GAMS code and a number of tutorials and examples using stylized national energy system models.

The MESSAGEix framework is fully integrated with IIASA's ix modeling platform (ixmp), a data warehouse for high-powered numerical scenario analysis.

License

Copyright © 2018 IIASA Energy Program

The MESSAGEix framework is licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Please refer to the NOTICE for details and user guidelines.

Getting started

Documentation

Documentation of the MESSAGEix framework, including the complete mathematical formulation and associated files, is automatically created from mark-up comments in the GAMS, Python, and R code. The online documentation is synchronized with the contents of the master branch of the message_ix Github repository.

For offline use, the documentation can be built from the source code. Navigate to the doc folder and in a command prompt type:

$ make doc

See doc/README.md for further details.

Installation

See ‘Installation’ in the documentation or the file INSTALL.rst.

Tutorials

Several introductory tutorials are provided. See ‘Tutorials’ in the documentation or the file tutorial/README.rst.

Scientific reference

Please cite the following manuscript when using the MESSAGEix framework and/or the ix modeling platform for scientific publications or technical reports:

Daniel Huppmann, Matthew Gidden, Oliver Fricko, Peter Kolp, Clara Orthofer, Michael Pimmer, Nikolay Kushin, Adriano Vinca, Alessio Mastrucci, Keywan Riahi, and Volker Krey.
"The |MESSAGEix| Integrated Assessment Model and the ix modeling platform".
Environmental Modelling & Software 112:143-156, 2019.
doi: 10.1016/j.envsoft.2018.11.012
electronic pre-print available at pure.iiasa.ac.at/15157/