AMPLPY

AMPL API is an interface that allows developers to access the features of the AMPL interpreter from within a programming language. All model generation and solver interaction is handled directly by AMPL, which leads to great stability and speed; the library just acts as an intermediary, and the added overhead (in terms of memory and CPU usage) depends mostly on how much data is read back from AMPL, the size of the model as such is irrelevant. Functions for directly assigning data to AMPL parameters and sets are provided, which can be used instead of the normal AMPL data reading procedures. AMPL API has been written with usability in mind, and it is easy to access its functionalities from C++, Java, C#, MATLAB, R and Python.

The AMPL API can function as an add-on to any existing AMPL installation. If you do not yet have an AMPL installation on the computer where you will be working with the API, see our demo page or trial page to download a working version that can be installed quickly.

Documentation

• http://amplpy.readthedocs.io
• http://ampl.com/api/nightly/python/

Examples

• Quick start: Introductory Tutorial

• More examples:

  • examples/
  • notebooks/

Repositories

• GitHub Repository: https://github.com/ampl/amplpy
• PyPI Repository: https://pypi.python.org/pypi/amplpy
• Conda-Forge: https://anaconda.org/conda-forge/amplpy

Setup

PyPI

Install from the PyPI repository:

$ pip install amplpy

Or:

$ python -m pip install amplpy

Note: For Windows, Linux, and macOS, the amplpy package comes with binary wheels for Python 2.7, 3.5, 3.6, 3.7, 3.8, and 3.9. Please make sure that you are using the latest version of pip before installing amplpy (upgrade using pip install pip --upgrade or python -m pip install pip --upgrade). If a binary wheel for your platform is not available, a C++ compiler and python development libraries will be required.

Conda

Install from the Conda repository:

$ conda install -c conda-forge amplpy

Build locally

You can build and install the package locally as follows:

$ git clone [email protected]:ampl/amplpy.git
$ cd amplpy
$ python updatelib.py
$ python setup.py build
$ pip install . --upgrade

License

BSD-3

Copyright © 2017-2021 AMPL Optimization inc. All rights reserved.