The |ixmp|
==========

.. figure:: _static/ix_features.png
   :width: 320px
   :align: right
   
   Key features of the |ixmp| (source: :cite:`huppmann_messageix_2018`)

The |ixmp| (ixmp) is a data warehouse for high-powered numerical scenario analysis.
It is designed to provide an effective framework
for integrated and cross-cutting analysis (hence the abbreviation *ix*).

The framework allows an efficient workflow between original input data sources
and the implementation of the mathematical model formulation, via both 
a web-based user interface and application programming interfaces (API)
with the scientific programming languages Python and R.
The platform also includes an API with the mathematical programming
software system `GAMS`_.

For the scientific reference, see Huppmann et al. (submitted) :cite:`huppmann_messageix_2018`.

.. _`GAMS` : http://www.gams.com

License and user guidelines
---------------------------

| |MESSAGEix| and the |ixmp| are licensed under an `APACHE 2.0 open-source license`_. 
| See the `LICENSE`_ file included in this repository for the full text.

.. _`APACHE 2.0 open-source license`: http://www.apache.org/licenses/LICENSE-2.0

.. _`LICENSE`: https://github.com/iiasa/ixmp/blob/master/LICENSE

Please read the `NOTICE`_ included in this repository for the user guidelines
and further information.

The community mailing list for questions and discussions on new features is hosted using Googlegroups.
Please join at `groups.google.com/d/forum/message_ix`_
and use <message_ix@googlegroups.com> to send an email to the |MESSAGEix| user community.

.. toctree::
   :maxdepth: 1

   notice
   contributing
   contributor_license

.. _`NOTICE`: notice.html

.. _`groups.google.com/d/forum/message_ix` : https://groups.google.com/d/forum/message_ix

An overview of the |ixmp|
-------------------------

.. figure:: _static/ix_components.png 

   Components and their interlinkages in the |ixmp| (source :cite:`huppmann_messageix_2018`): 
   web-based user interface, scientific programming interface,  
   modeling platform, database backend, 
   implementation of the |MESSAGEix| mathematical model formulation

Getting started
---------------

Refer to the page on `technical requirements`_ for a list of dependencies,
installation instructions, and other information on getting started.

For an introduction to the |ixmp|, look at the tutorials at `tutorial/README`_.

Further information:

.. toctree::
   :maxdepth: 1

   technical_requirements
   tutorials

.. _`technical requirements`: technical_requirements.html

.. _`tutorial/README` : https://github.com/iiasa/ixmp/blob/master/tutorial/README.md

Scientific programming API documentation
----------------------------------------

The documentation of the scientific programming APIs
are built directly from documentation mark-up
in the source respective source codes.

.. toctree::
   :maxdepth: 2

   scientific_programming_api

Bibliography
------------

.. toctree::
   :maxdepth: 2
   
   bibliography