Skip to content

Latest commit

 

History

History
198 lines (128 loc) · 8.6 KB

install.rst

File metadata and controls

198 lines (128 loc) · 8.6 KB
Raw

Installation

Most users will have :mod:`ixmp` installed automatically when installing MESSAGEix. The sections below cover other use cases.

Ensure you have first read the :doc:`prerequisites <message_ix:prereqs>` for understanding and using |MESSAGEix|. These include specific points of knowledge that are necessary to understand these instructions and choose among different installation options.

To use :mod:`ixmp` from R, see :ref:`message_ix:install-r` in the |MESSAGEix| documentation.

Use cases for installing ixmp directly include:

Contents:

Install system dependencies

Python

Python version 3.8 or later is required.

GAMS (required)

:mod:`ixmp` requires GAMS.

  1. Download GAMS for your operating system; either the latest version or, for users not familiar with GAMS licenses, version 29 (see note below).

  2. Run the installer.

  3. Ensure that the PATH environment variable on your system includes the path to the GAMS program:

    • on Windows, in the GAMS installer…

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

    • on other platforms (macOS or Linux), add the following line to a file such as :file:`~/.bash_profile` (macOS), :file:`~/.bashrc`, or :file:`~/.profile`:

      export PATH=$PATH:/path/to/gams-directory-with-gams-binary

Note

:mod:`message_ix` requires GAMS version 24.8; :mod:`ixmp` has no minimum requirement per se. The latest version is recommended.

GAMS is proprietary software and requires a license to solve optimization problems. To run both the :mod:`ixmp` and :mod:`message_ix` tutorials and test suites, a “free demonstration” license is required; the free license is suitable for these small models. Versions of GAMS up to version 29 include such a license with the installer; since version 30, the free demo license is no longer included, but may be requested via the GAMS website.

Note

If you only have a license for an older version of GAMS, install both the older and the latest versions.

Graphviz (optional)

:meth:`ixmp.Reporter.visualize <genno.Computer.visualize>` uses Graphviz, a program for graph visualization. Installing ixmp causes the graphviz Python package to be installed. If you want to use :meth:`~genno.Computer.visualize` or run the test suite, the Graphviz program itself must also be installed; otherwise it is optional.

If you install :mod:`ixmp` using Anaconda, Graphviz is installed automatically via its conda-forge package. For other methods of installation, see the Graphviz download page for downloads and instructions for your system.

Install :mod:`ixmp`

Using Anaconda

After installing GAMS, we recommend that new users install Anaconda, and then use it to install :mod:`ixmp`. Advanced users may choose to install :mod:`ixmp` from source code (next section).

  1. Install Python via either Miniconda or Anaconda. [1] We recommend the latest version; currently Python 3.10. [2]

  2. Open a command prompt. We recommend Windows users use the “Anaconda Prompt” to avoid issues with permissions and environment variables when installing and using :mod:`ixmp`. This program is available in the Windows Start menu after installing Anaconda.

  3. Configure conda to install :mod:`ixmp` from the conda-forge channel [3]:

    $ conda config --prepend channels conda-forge

  4. Create a new conda enviroment. This step is required if using Anaconda, but optional if using Miniconda. This example uses the name ixmp_env, but you can use any name of your choice:

    $ conda create --name ixmp_env
$ conda activate ixmp_env

  1. Install the ixmp package into the current environment (either base, or another name from step 7, e.g. ixmp_env):

    $ conda install -c conda-forge ixmp
[1]See the conda glossary for the differences between Anaconda and Miniconda, and the definitions of the terms ‘channel’ and ‘environment’ here.
[2]On newer macOS systems with "Apple M1" processors: the Miniconda or Anaconda installers provided for M1 lead to errors in ixmp. Instead, we recommend to use the macOS installers for "x86_64" processors on these systems. See also :issue:`473`.
[3]The ‘$’ character at the start of these lines indicates that the command text should be entered in the terminal or prompt, depending on the operating system. Do not retype the ‘$’ character itself.

Note

When using Anaconda (not Miniconda), steps (5) through (8) can also be performed using the graphical Anaconda Navigator. See the Anaconda Navigator documentation for how to perform the various steps.

From source

  1. (Optional) If you intend to contribute changes to ixmp, first register a Github account, and fork the ixmp repository. This will create a new repository <user>/ixmp. (Please also see :doc:`message_ix:contributing`.)

  2. Clone either the main repository, or your fork; using the Github Desktop client, or the command line:

    $ git clone git@github.com:iiasa/ixmp.git

# or:
$ git clone git@github.com:USER/ixmp.git

  3. Open a command prompt in the :file:`ixmp/` directory that is created, and type:

    $ pip install --editable .[docs,tests,tutorial]

    The --editable flag ensures that changes to the source code are picked up every time import ixmp is used in Python code. The [docs,tests,tutorial] extra dependencies ensure additional dependencies are installed.

  4. (Optional) Run the built-in test suite to check that :mod:`ixmp` functions correctly on your system:

    $ pytest

Troubleshooting

Run ixmp show-versions on the command line to check that you have all dependencies installed, or when reporting issues.

For Anaconda users experiencing problems during installation of ixmp, check that the following paths are part of the PATH environment variable, and add them if missing:

C:\[YOUR ANACONDA LOCATION]\Anaconda3;
C:\[YOUR ANACONDA LOCATION]\Anaconda3\Scripts;
C:\[YOUR ANACONDA LOCATION]\Anaconda3\Library\bin;

Install development tools

Developers making changes to the :mod:`ixmp` source may need one or more of the following tools. Users developing models using existing functionality should not need these tools.

Git

Use one of:

Java Development Kit (JDK)