ommx 1.1.1

Open Mathematical prograMming eXchange (OMMX)

OMMX

Open Mathematical prograMming eXchange (OMMX) is an open ecosystem that empowers mathematical programming and optimization developers and reserchers.

Design

OMMX introduces two specification to solve the problem of data exchange in optimization field:

• Protocol buffers based data schema called OMMX Message. This helps to store the optimization models and their solutions in language and framework agnostic way.
• OCI Artifact based packaging and distribution specification called OMMX Artifact. This helps to store your data with metadata and to exchange them with others as a container image.

Tutorial

Notebook	Open in Binder	Open in Colab
OMMX Message
OMMX Artifact
Cookbook
Create OMMX Adapters

To run the notebooks locally, you need to install required packages listed in requirements.txt

# Optional: create a virtual environment
python -m venv .venv && source .venv/bin/activate

# Install required packages (including Jupyter)
pip install -r requirements.txt

# Start Jupyter
jupyter lab

API Reference

See DEVELOPMENT.md about developing this project.

Rust SDK

Crate name	crates.io	API Reference (stable)	API Reference (main)
ommx

Python SDK

Package name	PyPI	API Reference (main)
ommx
ommx-python-mip-adapter

License

© 2024 Jij Inc.

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Contribution

TBW

Acknowledgement

This work was performed for Council for Science, Technology and Innovation (CSTI), Cross-ministerial Strategic Innovation Promotion Program (SIP), “Promoting the application of advanced quantum technology platforms to social issues”(Funding agency : QST).