[joss] Who uses retworkx and for what purpose?

Open
#513 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, rust
Domain
documentation

Research direction

Start by reviewing the current retworkx documentation and the linked JOSS software-paper discussion; the issue names no specific file or test. Add short, non-trivial examples outside Qiskit that demonstrate network analysis, graph theory, or a simple graph algorithm, and ensure they satisfy the JOSS example-usage requirement.

Written by the indexing model from the issue text.

Description

I am wondering if you could show a few uses cases (outside of Qiskit) that illustrate what kinds retworkx is currently suitable for. Do you have some short but non-trivial examples of analysing complex networks? Demonstrating some graph theory problems? Implementing a simple graph algorithm?

This ties into my comments about the software paper.

One of the items to check off for JOSS reads:

Documentation:

Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).

Dominant language
Rust
Stars
1.8k
Forks
220
Avg merge
3d 16h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Qiskit/rustworkx

All issues in Qiskit/rustworkx

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.