AMPL and all Solvers are now available as Python Packages

Announcements
1

AMPL and all Solvers are now available as Python Packages:

# Install Python API for AMPL:
$ python -m pip install amplpy --upgrade

# Install solver modules:
$ python -m amplpy.modules install highs gurobi 

# Activate your AMPL CE license:
$ python -m amplpy.modules run amplkey activate --uuid <license-uuid>

# Import, load, and instantiate in Python:
$ python
>>> from amplpy import AMPL, modules
>>> modules.load() # load all AMPL modules
>>> ampl = AMPL() # instantiate AMPL object

Python API (amplpy) Documentation

Commands available:

List usage instructions:

$ python -m amplpy.modules usage

Install modules:

$ python -m amplpy.modules install <solver 1> <solver 2> ...

Example:

$ python -m amplpy.modules install highs gurobi

Uninstall modules:

$ python -m amplpy.modules uninstall <solver 1> <solver 2> ...

Example:

$ python -m amplpy.modules uninstall gurobi highs

List installed modules:

$ python -m amplpy.modules installed

Example:

$ python -m amplpy.modules installed
You have the following modules installed:
	base
	gurobi
	highs

List modules available to be installed:

$ python -m amplpy.modules available
You can install any of the following modules:
	amplgsl
	baron
	base
	cbc
	coin
	conopt
	copt
	cplex
	gokestrel
	gurobi
	highs
	knitro
	lgo
	lindoglobal
	loqo
	minos
	octeract
	open
	plugins
	snopt
	xpress

Value to append to the environment variable PATH to access modules:

$ python -m amplpy.modules path

Example:

export PATH=$PATH:`python -m amplpy.modules path`

Generate requirements.txt for the modules currently installed

$ python -m amplpy.modules requirements
--index-url https://pypi.ampl.com
--extra-index-url https://pypi.org/simple
ampl_module_base==20221226
ampl_module_gurobi==20221228
ampl_module_highs==20221228

Run command in the same environment as the modules:

$ python -m amplpy.modules run <command>

Example:

$ python -m amplpy.modules run ampl -v
AMPL Version 20221013 (Darwin-20.6.0, 64-bit)
Demo license with maintenance expiring 20240131.
ampl:

Also available programmatically

All of this is also available from Python programmatically:

>>> from amplpy import modules
>>> modules.installed()
['base', 'gurobi', 'highs']
>>> modules.available()
['baron', 'cbc', 'lindoglobal', 'xpress', 'gurobi', 'lgo', 'open', 'minos', 'octeract', 'copt', 'plugins', 'amplgsl', 'loqo', 'conopt', 'base', 'cplex', 'snopt', 'coin', 'knitro', 'highs', 'gokestrel']
>>> modules.install('cplex')
>>> modules.installed()
['base', 'cplex', 'gurobi', 'highs']
>>> modules.uninstall('cplex')
>>> modules.installed()
['base', 'gurobi', 'highs']

Docker containers

This also makes AMPL really simple to use with Docker containers:

# Use any image as base image
FROM python:3.9-slim-bullseye
RUN python -m pip install amplpy # Install amplpy
RUN python -m amplpy.modules install highs gurobi  # Install modules
2 Likes