Add guide on using retworkx for networkx users #252
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new documentation guide for current networkx users on how to start using retworkx or how to migrate existing networkx code. It provides a high level explanation of the differences in behavior between the 2 libraries and how you can you can switch between them. Fixes Qiskit#248
Pull Request Test Coverage Report for Build 603654702
💛 - Coveralls |
|
I think there is still some more we can add here, but this is a decent starting point we can always expand the guide over time. But if people think there are obvious gaps we can add to this before merging. |
kdk
approved these changes
Feb 25, 2021
Co-authored-by: Kevin Krsulich <kevin@krsulich.net>
elfrocampeador
suggested changes
Feb 26, 2021
docs/source/networkx.rst
Outdated
Comment on lines
29
to
30
| While retworkx being written in Rust puts more constraints on how | ||
| you interact with graph object. With retworkx you can still attach any Python |
There was a problem hiding this comment.
This sentence feels like a fragment.
Co-authored-by: Corey Mendell <corey.mendell@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a new documentation guide for current networkx users on
how to start using retworkx or how to migrate existing networkx code. It
provides a high level explanation of the differences in behavior between
the 2 libraries and how you can you can switch between them.
Fixes #248
TODO: