Metadata-Version: 2.1
Name: dwavebinarycsp
Version: 0.0.2
Summary: Solves constraints satisfaction problems with binary quadratic model samplers
Home-page: https://github.com/dwavesystems/dwavebinarycsp
Author: D-Wave Systems Inc.
Author-email: oshklarsky@dwavesys.com
License: Apache 2.0
Platform: UNKNOWN
Requires-Dist: penaltymodel[all] (<0.15.0,>=0.14.0)
Requires-Dist: networkx (<3.0,>=2.0)
Requires-Dist: dimod (<0.7.0six>=1.11.0,<2.0.0,>=0.6.7)

.. image:: https://img.shields.io/pypi/v/dwavebinarycsp.svg
    :target: https://pypi.python.org/pypi/dwavebinarycsp

.. image:: https://coveralls.io/repos/github/dwavesystems/dwavebinarycsp/badge.svg?branch=master
    :target: https://coveralls.io/github/dwavesystems/dwavebinarycsp?branch=master

.. image:: https://readthedocs.org/projects/dwavebinarycsp/badge/?version=latest
    :target: http://dwavebinarycsp.readthedocs.io/en/latest/?badge=latest

.. image:: https://circleci.com/gh/dwavesystems/dwavebinarycsp.svg?style=svg
    :target: https://circleci.com/gh/dwavesystems/dwavebinarycsp

.. index-start-marker

dwavebinarycsp
==============

Library to construct a binary quadratic model from a constraint satisfaction problem with
small constraints over binary variables.

Example Usage
-------------

.. code-block:: python

    import dwavebinarycsp
    import dimod

    csp = dwavebinarycsp.factories.random_2in4sat(8, 4)  # 8 variables, 4 clauses

    bqm = dwavebinarycsp.stitch(csp)

    resp = dimod.ExactSolver().sample(bqm)

    for sample, energy in resp.data(['sample', 'energy']):
        print(sample, csp.check(sample), energy)

.. index-end-marker

Installation
------------

.. installation-start-marker

To install:

.. code-block:: bash

    pip install dwavebinarycsp

To build from source:

.. code-block:: bash

    pip install -r requirements.txt
    python setup.py install

.. installation-end-marker

License
-------

Released under the Apache License 2.0. See LICENSE file.

Contribution
------------

See CONTRIBUTING.rst file.


