Metadata-Version: 2.1
Name: dwave-networkx
Version: 0.6.7
Summary: A NetworkX extension providing graphs and algorithms relevent to working with the D-Wave System
Home-page: https://github.com/dwavesystems/dwave_networkx
Author: D-Wave Systems Inc.
Author-email: acondello@dwavesys.com
License: Apache 2.0
Download-URL: https://github.com/dwavesystems/dwave_networkx/archive/0.5.0.tar.gz
Platform: UNKNOWN
Requires-Dist: networkx (<3.0,>=2.0)
Requires-Dist: decorator (<5.0.0,>=4.1.0)
Requires-Dist: dimod (<0.8.0,>=0.6.8)

.. image:: https://img.shields.io/pypi/v/dwave-networkx.svg
    :target: https://pypi.python.org/pypi/dwave-networkx

.. image:: https://readthedocs.com/projects/d-wave-systems-dwave-networkx/badge/?version=latest
    :target: https://docs.ocean.dwavesys.com/projects/dwave-networkx/en/latest/?badge=latest

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

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

.. inclusion-marker-do-not-remove

D-Wave NetworkX
====================

D-Wave NetworkX is an extension of `NetworkX <http://networkx.github.io>`_\ ---a
Python language package for exploration and analysis of networks and network
algorithms---for users of D-Wave Systems. It provides tools for working with
Chimera graphs and implementations of graph-theory algorithms on the D-Wave
system and other binary quadratic model samplers.

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

This example generates a graph for a Chimera unit cell (eight nodes in a 4-by-2
bipartite architecture). 

.. code: python

>>> import dwave_networkx as dnx
>>> graph = dnx.chimera_graph(1, 1, 4)

See the documentation for more examples.

Installation
====================

.. installation-start-marker

**Installation from PyPi:**

.. code-block:: bash

  pip install dwave_networkx

**Installation 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.


