Skip to main content

Framework for the Ising model and QUBO.

Project description

OpenJij : Framework for the Ising model and QUBO.

PyPI version PyPI pyversions PyPI implementation PyPI format PyPI license PyPI download month Downloads

CPP Test Python Test Build Documentation CodeQL Codacy Badge Maintainability codecov

Coverage Graph

Sunburst Grid Icicle
  • python >= 3.7
  • (optional) gcc >= 7.0.0
  • (optional) cmake >= 3.22
  • (optional) Ninja


  • OpenJij >= v0.5.0

    import openjij.cxxjij
  • OpenJij <= v0.4.9

    import cxxjij
  • Documents

  • C++ Docs


install via pip

Note: To use GPGPU algorithms, please follow the section install via pip from source codes below. GPGPU algorithms are automatically enabled once CMake finds CUDA frameworks during installation.

# Binary
$ pip install openjij 
# From Source (CUDA)
$ pip install --no-binary=openjij openjij

install via pip from source codes

To install OpenJij from source codes, please install CMake first then install OpenJij.

cmake setup

If you want to use instead of PIP, You will need to install CMake>=3.22.
We are Highly recommended install CMake via PYPI.

$ pip install -U cmake

Make sure the enviroment path for CMake is set correctly.

install OpenJij

$ pip install --no-binary=openjij openjij

install from github repository

$ git clone
$ cd openjij
$ python -m pip install -vvv .

For Contributor

Use pre-commit for auto chech before git commit. .pre-commit-config.yaml

# pipx install pre-commit 
# or 
# pip install pre-commit
pre-commit install



$ python -m venv .venv
$ . .venv/bin/activate
$ pip install pip-tools 
$ pip-compile setup.cfg
$ pip-compile
$ pip-sync requirements.txt dev-requirements.txt
$ source .venv/bin/activate
$ export CMAKE_BUILD_TYPE=Debug
$ python --force-cmake install --build-type Debug -G Ninja
$ python --build-type Debug test 
$ python -m coverage html


$ mkdir build 
$ cmake -DCMAKE_BUILD_TYPE=Debug -S . -B build
$ cmake --build build --parallel
$ cd build
$ ./tests/cxxjij_test
# Alternatively  Use CTest 
$ ctest --extra-verbose --parallel --schedule-random

Needs: CMake > 3.22, C++17

  • Format
$ pip-compile
$ pip-sync format-requirements.txt
$ python -m isort 
$ python -m black 
  • Aggressive Format
$ python -m isort --force-single-line-imports --verbose ./openjij
$ python -m autoflake --in-place --recursive --remove-all-unused-imports --ignore-init-module-imports --remove-unused-variables ./openjij
$ python -m autopep8 --in-place --aggressive --aggressive  --recursive ./openjij
$ python -m isort ./openjij
$ python -m black ./openjij
  • Lint
$ pip-compile setup.cfg
$ pip-compile
$ pip-compile
$ pip-sync requirements.txt dev-requirements.txt lint-requirements.txt
$ python -m flake8
$ python -m mypy
$ python -m pyright

Python Documentation

Use Juyter Book for build documentation.
With KaTeX
Need: Graphviz

$ pip-compile setup.cfg
$ pip-compile
$ pip-compile
$ pip-sync requirements.txt build-requirements.txt doc-requirements.txt

Please place your document to docs/tutorialeither markdown or jupyter notebook style.

$ pip install -vvv .
$ jupyter-book build docs --all

How to use

Python example

import openjij as oj
sampler = oj.SASampler()
response = sampler.sample_ising(h={0: -1}, J={(0,1): -1})
# [[1,1]]

# with indices
response = sampler.sample_ising(h={'a': -1}, J={('a','b'): 1})
[{index: s for index, s in zip(response.indices, state)} for state in response.states]
# [{'b': -1, 'a': 1}]


About us

This product is maintained by Jij Inc.

Please visit our website for more information!


Copyright 2023 Jij Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at  

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

openjij-0.7.2.tar.gz (152.8 kB view hashes)

Uploaded source

Built Distributions

openjij-0.7.2-cp310-cp310-win_amd64.whl (966.1 kB view hashes)

Uploaded cp310

openjij-0.7.2-cp310-cp310-macosx_12_0_arm64.whl (598.8 kB view hashes)

Uploaded cp310

openjij-0.7.2-cp310-cp310-macosx_11_0_arm64.whl (603.6 kB view hashes)

Uploaded cp310

openjij-0.7.2-cp39-cp39-win_amd64.whl (965.9 kB view hashes)

Uploaded cp39

openjij-0.7.2-cp39-cp39-macosx_12_0_arm64.whl (598.0 kB view hashes)

Uploaded cp39

openjij-0.7.2-cp39-cp39-macosx_11_0_arm64.whl (602.7 kB view hashes)

Uploaded cp39

openjij-0.7.2-cp38-cp38-win_amd64.whl (986.5 kB view hashes)

Uploaded cp38

openjij-0.7.2-cp38-cp38-macosx_12_0_arm64.whl (598.0 kB view hashes)

Uploaded cp38

openjij-0.7.2-cp38-cp38-macosx_11_0_arm64.whl (602.7 kB view hashes)

Uploaded cp38

openjij-0.7.2-cp37-cp37m-win_amd64.whl (981.9 kB view hashes)

Uploaded cp37

Supported by

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