Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure and update references for unified documentation #250

Merged
merged 7 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
build
_build
dist
dwave_networkx.egg-info
*.pyc

venv/

docs/reference/generated/
docs/reference/algorithms/generated/
docs/reference/drawing/generated/
docs/generated/
docs/algorithms/generated/
docs/drawing/generated/

htmlcov/
.coverage
Expand Down
36 changes: 15 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,42 @@
.. image:: https://circleci.com/gh/dwavesystems/dwave-networkx.svg?style=svg
:target: https://circleci.com/gh/dwavesystems/dwave-networkx

D-Wave NetworkX
===============
==============
dwave-networkx
==============

.. index-start-marker
.. start_dnx_about

D-Wave NetworkX is an extension of `NetworkX <https://networkx.org>`_\ ---a
dwave-networkx is an extension of `NetworkX <https://networkx.org>`_\ ---a
Python language package for exploration and analysis of networks and network
algorithms---for users of D-Wave quantum computers. It provides tools for working
with Quantum Processing Unit (QPU) topology graphs, such as the Pegasus used on
the Advantage\ |TM| system, and implementations of graph-theory algorithms on D-Wave
quantum computers and other binary quadratic model samplers.

.. |TM| replace:: :sup:`TM`
algorithms---for users of D-Wave quantum computers. It provides tools for
working with quantum processing unit (QPU) topology graphs, such as the Pegasus
used on the Advantage\ :sup:`TM` quantum computer, and implementations of
graph-theory algorithms on D-Wave quantum computers and other binary quadratic
model (BQM) samplers.

This example generates a Pegasus graph of the size used by Advantage QPUs.

>>> import dwave_networkx as dnx
>>> graph = dnx.pegasus_graph(16)

See the documentation for more examples.

.. index-end-marker
.. end_dnx_about

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

.. installation-start-marker

**Installation from PyPi:**

.. code-block:: bash

pip install dwave_networkx
pip install dwave_networkx

**Installation from source:**

.. code-block:: bash

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

.. installation-end-marker
pip install -r requirements.txt
python setup.py install

License
=======
Expand All @@ -58,5 +52,5 @@ Released under the Apache License 2.0.
Contributing
============

Ocean's `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_
Ocean's `contributing guide <https://docs.dwavequantum.com/en/latest/ocean/contribute.html>`_
has guidelines for contributing to Ocean packages.
1 change: 0 additions & 1 deletion docs/LICENSE.txt

This file was deleted.

Loading