..  -*- coding: utf-8 -*-

=====
dimod
=====

.. include:: README.rst
  :start-after: index-start-marker1
  :end-before: index-end-marker1

(For explanations of the terminology, see the
:std:doc:`Ocean glossary <oceandocs:concepts/index>`.)

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

Find all solutions to a two-variable BQM using dimod's 
:class:`~dimod.reference.samplers.ExactSolver` reference
sampler, a brute-force solver useful for testing code on small problems.

.. include:: README.rst
  :start-after: index-start-marker2
  :end-before: index-end-marker2

Documentation
-------------

.. only:: html

  :Date: |today|

.. note:: This documentation is for the latest version of
   `dimod <https://github.com/dwavesystems/dimod>`_.
   Documentation for the version currently installed by
   `dwave-ocean-sdk <https://github.com/dwavesystems/dwave-ocean-sdk>`_
   is here: :std:doc:`dimod <oceandocs:docs_dimod/sdk_index>`.

.. sdk-start-marker

.. toctree::
  :maxdepth: 1

  intro/index
  reference/index
  release_notes

.. sdk-end-marker

.. toctree::
  :caption: Code
  :maxdepth: 1

  Source <https://github.com/dwavesystems/dimod>
  installation
  license

.. toctree::
  :caption: Ocean Software
  :maxdepth: 1

  Ocean Home <https://ocean.dwavesys.com/>
  Ocean Documentation <https://docs.ocean.dwavesys.com>
  Ocean Glossary <https://docs.ocean.dwavesys.com/en/stable/concepts/index.html>

.. toctree::
  :caption: D-Wave
  :maxdepth: 1

  D-Wave <https://www.dwavesys.com>
  Leap <https://cloud.dwavesys.com/leap/>
  D-Wave System Documentation <https://docs.dwavesys.com/docs/latest/index.html>

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`