HybridSolver API Client

This package contains the CLI and API to access the HybridSolver.

Installation

Python >= 3.8 is required. Then, do

python -m pip install hybridsolver

In order to use the cloud-based HybridSolver, you need to sign up for an API key at https://platform.quantagonia.com and set it system-wide by

export QUANTAGONIA_API_KEY=<your API key here>

Features

CLI

The package installs a hybridsolver CLI command for job submission, status checking, and solution retrieval:

hybridsolver submit problem.mps
hybridsolver status <job-id>
hybridsolver solution <job-id>

Supported Model Formats

• MPS/LP files — Submit standard optimization problem files directly
• PuLP — Integration with the PuLP modeling library
• QUBO — Support via Qiskit, D-Wave Ocean, and pyqubo
• SCIP — Integration with PySCIPOpt

Examples

The examples/ directory contains 14+ example scripts covering MIP, QUBO, batch solving, and various modeling interfaces. See Documentation for a Quick Start Guide and API reference.

Development

This project uses Hatch for environment management, testing, and building:

hatch test                    # run unit tests
hatch fmt --linter --check    # lint check
hatch fmt --formatter --check # format check
hatch build                   # build package

Changelog for Documentation

To include the changelog in the external documentation, please see the add the relevant section in the changelog fragment file in the changelog.d directory for the latest changes.

Steps to add a new changelog:

1. Create a new changelog fragment directory changelog.d if it doesn't exist.
2. Run hatch run changelog:create to create a new changelog fragment file.
3. Add relevant changes (Only include changes that are relevant to the external users) to the new changelog fragment file.
4. Commit the changes and push to the repository.