Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hybridsolver-0.17.0.tar.gz (4.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hybridsolver-0.17.0-py3-none-any.whl (67.6 kB view details)

Uploaded Python 3

File details

Details for the file hybridsolver-0.17.0.tar.gz.

File metadata

  • Download URL: hybridsolver-0.17.0.tar.gz
  • Upload date:
  • Size: 4.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hybridsolver-0.17.0.tar.gz
Algorithm Hash digest
SHA256 36a8fbae3179e7e7a10eacf761032298ee2bd37d43b69d655d9aea14deaf4a84
MD5 fa3f65db04276db27d7226cb8c74ba2e
BLAKE2b-256 6b9a5d0caf394cf70bead9a02c7ca989cd8b57ae8812b79909606ad1ff9d4d35

See more details on using hashes here.

Provenance

The following attestation bundles were made for hybridsolver-0.17.0.tar.gz:

Publisher: api-client-publish.yml on strangeworks/HybridSolver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hybridsolver-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: hybridsolver-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 67.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hybridsolver-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c55014ce911588a39a7ad787d15da863db8b42263b0f1be7df7a05d92eaf6f3
MD5 0f0dcc0263801801648985b9511b2b0a
BLAKE2b-256 70301aea2bad9bc00e7232d241f94ea12e97b37fbfa95339c11d1dae6114a1e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for hybridsolver-0.17.0-py3-none-any.whl:

Publisher: api-client-publish.yml on strangeworks/HybridSolver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page