Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.93 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.93 KB
Raw

CircleCI

d2ix

A model input data management and analysis tool for MESSAGEix.

Installation

To start using the open source Python package d2ix, you must to ensure that your environment is equipped with the MESSAGEix requirements (Python 3.7 via Anaconda, GAMS and Java) as described in the README instructions found alongside the MESSAGEix repository. Once all requirements are fulfilled, the cloned or forked d2ix repository can be installed. To install d2ix:

  1. Install Python via Anaconda. We recommend the latest version, e.g., Python 3.7+.

  2. Install GAMS. Importantly:

    • Check the box labeled Use advanced installation mode
    • Check the box labeled Add GAMS directory to PATH environment variable on the Advanced Options page.

  3. Open a command prompt and type

    conda env create -f environment.yml

  4. To use d2ix, you need to activate the d2ix environment each time. On Windows:

    conda activate d2ix

Tutorial

A introductory tutorial is provided for d2ix in the repository under https://github.com/tum-ewk/d2ix/tutorial.ipynb.

Further Documentation

Scientific reference

Please cite the following manuscript when using the d2ix for scientific publications or technical reports:

Thomas Zipperle and Clara Luisa Orthofer. d2ix: A Model Input-Data Management and Analysis Tool for MESSAGEix. Energies 12 (8): 1483. 2019. doi: https://doi.org/10.3390/en12081483.