OpenJij

(β˜… 132)

OpenJij : Framework for the Ising model and QUBO.

  • .coveragerc
  • .gitattribute
  • .gitignore
  • CITATION.cff
  • CMakeLists.txt
  • codecov.yml
  • Doxyfile
  • LICENSE
  • MANIFEST.in
  • pyproject.toml
  • README.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/Jij-Inc/OpenJij

Downloads the entire project code from GitHub to your computer.

cd OpenJij

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
$ pip install -U cmake

Installs the Python libraries listed in requirements.txt (or similar).

$ cmake -DCMAKE_BUILD_TYPE=Debug -S . -B build

Type this command into your terminal and run it.

$ cmake --build build --parallel

Type this command into your terminal and run it.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ pip install openjij

Installs the Python libraries listed in requirements.txt (or similar).

$ pip install --no-binary=openjij openjij

Installs the Python libraries listed in requirements.txt (or similar).

$ pip install -U cmake

Installs the Python libraries listed in requirements.txt (or similar).

$ python -m pip install -vvv .

Installs the Python libraries listed in requirements.txt (or similar).

$ pip install uv # Recommended

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation