Skip to main content

Ising: a Python package for exactly solving abritrary Ising model instances using exhaustive search.

Project description

K. Jałowiecki, M. Rams and B. Gardas

Documentation: https://ising.readthedocs.io/en/latest/

Ising is an open source package for exactly solving abritrary Ising model instances via exhaustive search. It can be used as an excellent tool for benchmarking other solvers or generating low energy spectra. The package is compatible with *NIX systems (and in principle should work on Windows too). Ising supports parallel computation via OpenMP or GPU, if it was build with CUDA support.

Build status

Build Status Documentation Status

Installation

If you are running Linux and are interested in CPU-only implementation, you can install Ising from Python Package Index.

pip install ising

For other installation options, including building with CUDA support, please visit the official documentation.

Usage example

The below example finds 4 lowest energy states of the Ising model defined by

\begin{equation*} H(s_0, s_1, s_2) = -2s_0s_1 + 3s_1s_2 + 2.5s_2s_3 -s_0 \end{equation*}
import ising

graph = {(0, 1): 2, (1, 2): -3, (2, 3): 2.5, (0, 0): 1}

result = ising.search(graph, num_states=4)
print(result.energies)

For advanced usage, including GPU support and tweaking execution parameters see documentation.

Project details


Download files

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

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distributions

ising-0.1.23-cp37-cp37m-manylinux1_x86_64.whl (801.1 kB view hashes)

Uploaded cp37

ising-0.1.23-cp36-cp36m-manylinux1_x86_64.whl (801.1 kB view hashes)

Uploaded cp36

ising-0.1.23-cp35-cp35m-manylinux1_x86_64.whl (802.3 kB view hashes)

Uploaded cp35

ising-0.1.23-cp34-cp34m-manylinux1_x86_64.whl (802.2 kB view hashes)

Uploaded cp34

ising-0.1.23-cp27-cp27m-manylinux1_x86_64.whl (799.1 kB view hashes)

Uploaded cp27

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page