Metadata-Version: 2.4
Name: ommx
Version: 3.0.0a3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: ipython>=7.0.0
Requires-Dist: numpy>=1.23.0,<3.0.0
Requires-Dist: opentelemetry-sdk>=1.20.0
Requires-Dist: pandas>=2.0.0,<3.0.0
Requires-Dist: pyarrow>=16.0.0,<23.0.0
Requires-Dist: python-dateutil>=2.9.0,<3.0.0
Requires-Dist: typing-extensions>=4.12.2,<5.0.0
Summary: Open Mathematical prograMming eXchange (OMMX)
Author-email: "Jij Inc." <info@j-ij.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Issues, https://github.com/Jij-Inc/ommx/issues
Project-URL: Repository, https://github.com/Jij-Inc/ommx

# OMMX

[![Docs/en](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/)
[![Docs/ja](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/)
[![Discord-EN](https://img.shields.io/badge/Discord-English-default?logo=Discord)](https://discord.gg/QPMbdJCbAB)
[![Discord-JP](https://img.shields.io/badge/Discord-日本語-default?logo=Discord)](https://discord.gg/CPd9ZsxtR5)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Jij-Inc/ommx)

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

# Tutorial

## English

| Title | Docs |
|:------|:-----|
| Solving Optimization Problems with OMMX Adapter | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/solve_with_ommx_adapter.html) |
| Sampling from QUBO with OMMX Adapter | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/tsp_sampling_with_openjij_adapter.html) |
| Comparing Results from Multiple Adapters | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/switching_adapters.html) |
| Sharing Various Types of Data in an OMMX Artifact | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/share_in_ommx_artifact.html) |
| Downloading a MIPLIB Instance | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/download_miplib_instance.html) |
| Implementing an OMMX Adapter | [![Docs](https://img.shields.io/badge/Docs-English-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/tutorial/implement_adapter.html) |

## 日本語

| タイトル | Docs |
|:------|:-----|
| OMMX Adapterで最適化問題を解く | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/solve_with_ommx_adapter.html) |
| OMMX AdapterでQUBOからサンプリングする | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/tsp_sampling_with_openjij_adapter.html) |
| 複数のAdapterで最適化問題を解いて結果を比較する | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/switching_adapters.html) |
| 様々なデータをOMMX Artifact形式で共有する | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/share_in_ommx_artifact.html) |
| MIPLIBインスタンスをダウンロードする | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/download_miplib_instance.html) |
| OMMX Adapterを実装する | [![Docs](https://img.shields.io/badge/Docs-日本語-blue)](https://jij-inc-ommx.readthedocs-hosted.com/ja/latest/tutorial/implement_adapter.html) |

# SDK

[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/Jij-Inc/ommx?utm_source=badge)

See [DEVELOPMENT.md](./DEVELOPMENT.md) about developing this project.

| SDK | Package | API Reference |
|:----|:--------|:--------------|
| Rust | [![crates.io](https://img.shields.io/crates/v/ommx)](https://crates.io/crates/ommx) | [![docs.rs](https://docs.rs/ommx/badge.svg)](https://docs.rs/ommx) |
| Python | [![PyPI](https://img.shields.io/pypi/v/ommx)](https://pypi.org/project/ommx/) | [![Docs](https://img.shields.io/badge/API_Reference-main-blue)](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/api/index.html) |

See [Supported Adapters](https://jij-inc-ommx.readthedocs-hosted.com/en/latest/user_guide/supported_ommx_adapters.html) about a complete list of supported adapters for each solver/sampler.

# License
© 2024 Jij Inc.

This project is licensed under either of

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

at your option.

# Contribution
TBW

# Acknowledgement
![BRIDGE](./BRIDGE.png)
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).

