.. highlight:: shell

============
Installation
============


Stable release
--------------

To install ReFramed, run this command in your terminal:

.. code-block:: console

    $ pip install reframed

Please note that ReFramed is a pure Python 3 library (>= 3.6).

Solvers
-------

ReFramed directly supports CPLEX_ and Gurobi_.
Additionally, it provides an interface to OptLang_, allowing to use any solver implemented in its latest release.

.. _CPLEX: https://www.ibm.com/analytics/cplex-optimizer
.. _Gurobi: https://www.gurobi.com
.. _OptLang: https://optlang.readthedocs.io

Please note that you will need an academic license to use these solvers.
Please read the respective manuals for detailed installation instructions.