rustworkx Documentation

Note

The project has been renamed to rustworkx. You can still use the legavcy retworkx name for now but starting in the 1.0.0 release the retworkx name will no longer be supported.

rustworkx is a Python package for working with graphs and complex networks. It enables the creation, interaction with, and study of graphs and networks.

It provides:

• Data structures for creating graphs including directed graphs and multigraphs

• A library of standard graph algorithms

• Generators for various types of graphs including random graphs

• Visualization functions for graphs

It is licensed under the Apache 2.0 license and the source code is hosted on Github at:

https://github.com/Qiskit/rustworkx

rustworkx is written in the Rust programming language to leverage Rust’s inherent performance and safety. While this provides numerous advantages including significantly improved performance it does mean that the library needs to be compiled when being installed from source (as opposed to a pure Python library which can just be installed). rustworkx supports and publishes pre-compiled binaries for Linux on x86, x86_64, aarch64, s390x, and ppc64le, MacOS on x86_64, and arm64, and Windows 32bit and 64bit systems. However, if you are not running on one of these platforms, you will need a rust compiler to install rustworkx.

Project history

rustworkx was originally called retworkx and was created to be a high performance replacement for the Qiskit project’s internal usage of the NetworkX library (which is where the name came from: Rust + NetworkX = rustworkx) but it is not a drop-in replacement for NetworkX (see rustworkx for NetworkX users for more details). However, since it was originally created it has grown to be an independent high performance general purpose graph library that can be used for any application that needs to interact with graphs or complex networks.

Contents:

• Getting Started
• Installing Rustworkx
  • Installing on a platform without precompiled binaries
• Platform Support
  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4
• Using rustworkx
• Rustworkx Tutorials and Guides
  • Introduction to rustworkx
  • Directed Acyclic Graphs
  • Working with Betweenness Centrality
• Rustworkx API
  • Graph Classes
  • Algorithm Functions
  • Generators
  • Random Graph Generator Functions
  • Layout Functions
  • Serialization
  • Converters
  • API functions for PyDigraph
  • API functions for PyGraph
  • Exceptions
  • Custom Return Types
• Visualization
  • Visualization API
• Release Notes
  • 0.13.0
  • 0.12.0
  • 0.11.0
  • 0.10.2
  • 0.10.1
  • 0.10.0
  • 0.9.0
  • 0.8.0
  • 0.7.1
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.0
• Contributing Guide
  • Contributing to rustworkx
• rustworkx for NetworkX users
  • Some Key Differences
  • Graph Data and Attributes
  • API Equivalents
  • Converting from a networkx graph
  • Functionality Gaps
• Benchmarks
  • Graph Creation
  • Single Source Shortest Path
  • All-Pairs Shortest Path
  • Subgraph Isomorphism