Thank you for using ! We hope this documentation can help you with your modelling journey.
First, choose which install process to use. Use the install-quick
steps on this page if all of the following apply:
- You plan to use:
- …the latest releases of
message_ix
andixmp
. - …Python (not R) to interact with
message_ix
. - …the default terminal for an operating system (OS) like Ubuntu Linux, macOS, or Windows.
- …a virtual environment to contain your installation, as we
strongly recommend <install-venv>
.
- …the latest releases of
- You have already installed on your system:
Python <install-python>
(version 3.8 or later) installed, along with eitherpip
orconda
;- a
Java Runtime Environment (JRE) <install-java>
(if not usingconda
; seehere <install-java>
); and GAMS <install-gams>
(version 24.8.1 or later).
If any of the above does not apply, instead consult the install-adv
. If the terms above are unfamiliar, you may need to review the prereqs
for using before you proceed. For issues encountered during installation, see “common-issues
” in the guide, and further resources linked there.
install-adv
Choose one of the install methods below. Depending on your choice, you should have either pip
or conda
installed on your system. If in doubt, we recommend pip
because it is quick, easy to use and to troubleshoot. (For more considerations, see “install-pip-or-conda
” in the advanced guide.)
- Open a terminal/command prompt.
- Activate your virtual environment.
Run1:
pip install message_ix[docs,report,tests,tutorial]
This will install the latest release of from the Python Package Index (PyPI).
- Open a terminal/command prompt.
- Activate your virtual environment.
Configure
conda
to installmessage_ix
from the conda-forge channel:conda config --prepend channels conda-forge
Install and configure the mamba solver, which is faster and more reliable than conda's default solver:
conda install conda-libmamba-solver conda config --set solver libmamba
Install the
message-ix
package into the current environment:conda install message-ix
This will install the latest release of from conda-forge.
Verify that the version installed corresponds to the latest release by running the following commands on the command line. Show versions of message_ix
, ixmp
, and key dependencies:
message-ix show-versions
The versions should correspond to the latest version shown on the whatsnew
page.
Show the list of platforms (~databases) that have been configured and the path to the ixmp
config file:
message-ix platform list
See the advanced guide <check-install>
for further details.
See “
install-extras
” in the advanced guide for an explanation of the[docs,report,tests,tutorial]
extra requirements. See “Graphviz <install-graphviz>
” if you want to use.visualize
or run the test suite.↩