OMPython 3.6.0

OpenModelica-Python API Interface

OMPython

OMPython is a Python interface that uses ZeroMQ or CORBA (omniORB) to communicate with OpenModelica.

Dependencies

Using ZeroMQ

• Python 2.7 and 3.x supported
• PyZMQ is required

Using omniORB

• Currently, only Python 2.7 is supported
• omniORB is required:
  • Windows: included in the OpenModelica installation
  • Linux: Install omniORB including Python 2 support (the omniidl command needs to be on the PATH). On Ubuntu, this is done by running sudo apt-get install omniorb python-omniorb omniidl omniidl-python

Installation

Installation using pip is recommended.

Linux

Install the latest OMPython master by running:

python -m pip install -U https://github.com/OpenModelica/OMPython/archive/master.zip

Windows

Install the version packed with your OpenModelica installation by running:

cd %OPENMODELICAHOME%\share\omc\scripts\PythonInterface
python -m pip install -U .

Local installation

To Install the latest version of the OMPython master branch only, previously cloned into <OMPythonPath>, run:

cd <OMPythonPath>
python -m pip install -U .

Usage

Running the following commands should get you started

import OMPython
help(OMPython)

from OMPython import OMCSessionZMQ
omc = OMCSessionZMQ()
omc.sendExpression("getVersion()")

or read the OMPython documentation online.

Bug Reports

• See OMPython bugs on the OpenModelica trac or submit a new ticket.
• Pull requests are welcome.

Contact

• Adeel Asghar, [e-mail]
• Arunkumar Palanisamy, [e-mail]