Getting Started
This document describes how to work with the AIMMS Python Bridge. The Python Bridge allows you to seamlessly integrate an AIMMS model and Python scripts in your project.
The AIMMS Python Bridge consists of two components:
pyaimms, an AIMMS library repository, that allows you to execute a Python script from within an AIMMS procedure in your model.aimmspy, a Python module, that allows you to write Python scripts that communicate with an existing AIMMS model.
You might need both in your project, but each of the above components can operate independently. We distinguish two typical examples of use cases, but these don’t have to be mutually exclusive:
AIMMS in the lead: when you just want to run a Python script form within your AIMMS model that does nothing with data from your model, the Library Repository would be sufficient.
Python in the lead: when you want to create a Python script that pushes data to an AIMMS project, runs a solve and retrieves a solution.
And of course, when, from within AIMMS, you want to run a Python procedure that retrieves the data from an AIMMS identifier, perform some data analysis using another Python library and send it back to AIMMS again, you would need both components in your project.
Installation
The aimmspy Python module can be installed from the Python Package Index.
The AIMMS library repository pyaimms can be installed from within the AIMMS IDE using the AIMMS Library Manager.
AIMMS License
To use the AIMMS Python library, you need to have an AIMMS Developer version installed, a valid license and an already existing AIMMS project.