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

Add visualization to retworkx for networkx users guide #344

Merged
merged 5 commits into from
May 29, 2021

Conversation

mtreinish
Copy link
Member

This commit adds a section to the retworkx for networkx users guide on
visualizations. This is important especially for the mpl_draw
function since it's mostly identical to the networkx_drawer function
but there are some key differences to keep in mind.

This commit also makes small change to the graphviz drawer, the name of
the function is renamed from pydot_draw to graphviz_draw and the
Python module is renamed from pydot to graphviz. This was done to
be more descriptive as graphviz is the backend not pydot. It also makes
it easier to migrate away from pydot in the future if we needed to since
the key piece is using graphviz not a particular python interface to it.

Fixes #341

This commit adds a section to the retworkx for networkx users guide on
visualizations. This is important especially for the ``mpl_draw``
function since it's mostly identical to the ``networkx_drawer`` function
but there are some key differences to keep in mind.

This commit also makes small change to the graphviz drawer, the name of
the function is renamed from `pydot_draw` to `graphviz_draw` and the
Python module is renamed from `pydot` to `graphviz`. This was done to
be more descriptive as graphviz is the backend not pydot. It also makes
it easier to migrate away from pydot in the future if we needed to since
the key piece is using graphviz not a particular python interface to it.

Fixes Qiskit#341
@mtreinish mtreinish requested a review from t-imamichi May 28, 2021 16:00
@mtreinish mtreinish added this to the 0.9.0 milestone May 28, 2021
@coveralls
Copy link

coveralls commented May 28, 2021

Pull Request Test Coverage Report for Build 886799581

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 18 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+1.03%) to 96.811%

Files with Coverage Reduction New Missed Lines %
src/isomorphism.rs 1 97.44%
src/lib.rs 17 99.33%
Totals Coverage Status
Change from base Build 886750138: 1.03%
Covered Lines: 8439
Relevant Lines: 8717

💛 - Coveralls

Copy link
Member

@t-imamichi t-imamichi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mtreinish mtreinish merged commit aad90f7 into Qiskit:main May 29, 2021
@mtreinish mtreinish deleted the add-viz-docs-for-nx-users branch May 29, 2021 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename edge_list arg with edgelist to be compatible with networkx
3 participants