Rename retworkx to rustworkx #644

mtreinish · 2022-07-25T14:43:53Z

This commit renames the retworkx project to rustworkx. The maintainers of
NetworkX requested that we change the name of the library because they
viewed networkx as being too similar to retworkx. Out of respect for
this request and the NetworkX library which inspired retworkx we are
renaming the library to rustworkx. Rustworkx is a similar name to
retworkx and enables us to keep using the rx abbreviation for imports
which is commonly used.

This commit, migrates all the internal usage and names from retworkx to
rustworkx. This includes the retworkx-core crate which has similarly been
renamed to rustworkx-core. However, for backwards compatibility and to
ease the migration of our existing user base the retworkx package is
still included in rustworkx. An import redirect is added so that
import retworkx.foo will return return rustworkx.foo. Additionally, the
README and documentation are updated to mention the rename.

The migration plan this commit takes is that for the pending 0.12.0
release we'll migrate to rustworkx for everything but keep the backwards
compatibility shim in place with no warning. In the 0.13.0 release we'll
emit a DeprecationWarning (or a FutureWarning) that the name is
deprecated (this waits a release to ensure there is upgrade path where
more than 1 version works without raising a warning to ease migration). We can
then remove the deprecated retworkx name as part of the 1.0.0 release.
During the transition period we'll continue to publish releases to both
the rustworkx and retworkx names through at least 0.14.0 (but with the option
to keep publishing both until 1.0.0) so that users will see the deprecation
warnings when importing retworkx.

Closes #641

This commit renames the retworkx project to rustworkx. The maintainers of NetworkX requested that we change the name of the library because they viewed networkx as being too similar to retworkx. Out of respect for this request and the NetworkX library which inspired retworkx we are renaming the library to rustworkx. Rustworkx is a similar name to retworkx and enables us to keep using the rx abbreviation for imports which is commonly used. This commit, migrates all the internal usage and names from retworkx to rustworkx. This includes the retworkx-core crate which has similarly been renamed to rustworkx-core. However, for backwards compatibility and to ease the migration of our existing user base the retworkx package is still included in rustworkx. An import redirect is added so that import retworkx.foo will return return rustworkx.foo. Additionally, the README and documentation are updated to mention the rename. The migration plan this commit takes is that for the pending 0.12.0 release we'll migrate to rustworkx for everything but keep the backwards compatibility shim in place with no warning. In the 0.13.0 release we'll emit a DeprecationWarning (or a FutureWarning) that the name is deprecated (this waits a release to ensure there is upgrade path where > 1 version works without raising a warning to ease migration). We can then remove the deprecated retworkx name as part of the 1.0.0 release. During the transition period we'll continue to publish releases to both the rustworkx and retworkx names through at least 0.14.0 (but with the option to keep publishing both until 1.0.0) so that users will see the deprecation warnings when importing retworkx. Closes Qiskit#641

This commit splits out the retworkx component from the rustworkx package. This makes the new rustworkx package solely contain the rustworkx piece and the retworkx piece becomes an independent package that depends on rustworkx (and will internally redirect everything to rustworkx). Co-authored-by: Ivan Carvalho <ivancarv@student.ubc.ca>

It turns out that adding a dependency is not going to work prior to the rustworkx package being released because pip won't be able to resolve the rustworkx dependency. This commit reverts this structure for the time being. Closer to the 0.12.0 release we can revisit this and plan to do this structure (maybe by releasing rustworkx first, making this change and then releasing retworkx with the dependency). This reverts commit 2ae3ffd.

coveralls · 2022-07-25T17:11:19Z

Pull Request Test Coverage Report for Build 2750474154

54 of 55 (98.18%) changed or added relevant lines in 8 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.009%) to 97.142%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/union.rs	0	1	0.0%

Files with Coverage Reduction	New Missed Lines	%
src/shortest_path/all_pairs_bellman_ford.rs	2	98.88%

Totals
Change from base Build 2691937771:	0.009%
Covered Lines:	12540
Relevant Lines:	12909

💛 - Coveralls

tox.ini

IvanIsCoding · 2022-07-26T00:45:51Z

I think if we install rustworkx locally before installing retworkx we will not need to relly on rustworkx being on PyPI, as pip will find it is already installed. I commented a possible workaround.

…kages"" This reverts commit 1d04a30.

tox.ini

Co-authored-by: georgios-ts <45130028+georgios-ts@users.noreply.github.com>

laurencap · 2022-08-01T21:16:11Z

sgtm

The retworkx project was recently renamed rustworkx (see Qiskit/rustworkx#644) however the documentation is still being published to the retworkx url. The project will soon start uploading builds to qiskit.org/documentation/rustworkx in order to prepare for that this commit adds the path to the exlude list so syncs of the main qiskit documentation do not accidently delete the rustworkx documentation.

In Qiskit#644 we added the build/install of the rust coreutils package to the retworkx backwards compat CI job to have a consistent cross platform way to set environment variables between different OSes. However, this adds significant time to the CI job while we build this package. This commit reconfigures the job to leverage github actions native environment variable handling and drops the coreutils usage. This should speed up the backwards compat jobs since we no longer are compiling coreutils from source.

The retworkx project was recently renamed rustworkx (see Qiskit/rustworkx#644) however the documentation is still being published to the retworkx url. The project will soon start uploading builds to qiskit.org/documentation/rustworkx in order to prepare for that this commit adds the path to the exlude list so syncs of the main qiskit documentation do not accidently delete the rustworkx documentation.

In #644 we added the build/install of the rust coreutils package to the retworkx backwards compat CI job to have a consistent cross platform way to set environment variables between different OSes. However, this adds significant time to the CI job while we build this package. This commit reconfigures the job to leverage github actions native environment variable handling and drops the coreutils usage. This should speed up the backwards compat jobs since we no longer are compiling coreutils from source. Co-authored-by: Ivan Carvalho <8753214+IvanIsCoding@users.noreply.github.com>

The rustworkx mpl_draw() function was originally adapted from networkx's matplotlib based drawer and heavily modified to work with rustworkx and also conform more to rustworkx's interface style. Attribution to the original source and the license terms of the original networkx code are present in a comment at a top of the module. This port was originally done when rustworkx was still called retworkx. As part of the name migration in Qiskit#644 an overzealous find/replace broke the URL to the permalink to the original networkx source code that the mpl_draw() function was based on. This commit corrects this oversight so that the link correctly resolves to the proper url.

The rustworkx mpl_draw() function was originally adapted from networkx's matplotlib based drawer and heavily modified to work with rustworkx and also conform more to rustworkx's interface style. Attribution to the original source and the license terms of the original networkx code are present in a comment at a top of the module. This port was originally done when rustworkx was still called retworkx. As part of the name migration in #644 an overzealous find/replace broke the URL to the permalink to the original networkx source code that the mpl_draw() function was based on. This commit corrects this oversight so that the link correctly resolves to the proper url. Co-authored-by: Ivan Carvalho <8753214+IvanIsCoding@users.noreply.github.com>

mtreinish added this to the 0.12.0 milestone Jul 25, 2022

mtreinish force-pushed the renase-retworkx branch from 704dd50 to 7d5f3f6 Compare July 25, 2022 15:00

mtreinish and others added 3 commits July 25, 2022 12:43

Update lint doc job definition for new package name

d931304

IvanIsCoding reviewed Jul 26, 2022

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

mtreinish and others added 5 commits July 26, 2022 14:36

Revert "Revert "Make rustworkx and retworkx independent dependent pac…

b963782

…kages"" This reverts commit 1d04a30.

Remove unsupported set command

79babb7

Use coreutils to set environment variable on Windows

c16cdcc

Use coreutils command in .cargo/bin

5d1b130

Fix Sphinx warnings

0df538f

IvanIsCoding approved these changes Jul 27, 2022

View reviewed changes

mtreinish requested review from georgios-ts, itoko and lcapelluto July 27, 2022 19:34

georgios-ts approved these changes Jul 27, 2022

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

Update tox.ini

af14575

Co-authored-by: georgios-ts <45130028+georgios-ts@users.noreply.github.com>

IvanIsCoding merged commit 7d253ce into Qiskit:main Aug 1, 2022

mtreinish deleted the renase-retworkx branch August 2, 2022 21:02

mtreinish mentioned this pull request Aug 5, 2022

Add rustworkx to other docs build list Qiskit/qiskit-metapackage#1583

Merged

mtreinish mentioned this pull request Aug 5, 2022

Remove coreutils build from retworkx backwards compat tests #652

Merged

josh146 mentioned this pull request Sep 28, 2022

Update PennyLane to depend on rustworkx instead of retworkx PennyLaneAI/pennylane#3116

Open

mtreinish mentioned this pull request Aug 1, 2023

Support Obsoletes-Dist in project metadata pypa/pip#12196

Open

1 task

mtreinish mentioned this pull request Jan 8, 2024

Fix URL in comment around origin of matplotlib drawer #1051

Merged

johnthagen mentioned this pull request Feb 5, 2024

Fix remaining usages of retworkx #1079

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename retworkx to rustworkx #644

Rename retworkx to rustworkx #644

mtreinish commented Jul 25, 2022 •

edited

coveralls commented Jul 25, 2022 •

edited

IvanIsCoding commented Jul 26, 2022 •

edited

laurencap commented Aug 1, 2022

Rename retworkx to rustworkx #644

Rename retworkx to rustworkx #644

Conversation

mtreinish commented Jul 25, 2022 • edited

coveralls commented Jul 25, 2022 • edited

Pull Request Test Coverage Report for Build 2750474154

💛 - Coveralls

IvanIsCoding commented Jul 26, 2022 • edited

laurencap commented Aug 1, 2022

mtreinish commented Jul 25, 2022 •

edited

coveralls commented Jul 25, 2022 •

edited

IvanIsCoding commented Jul 26, 2022 •

edited