Merge branch 'main' into numpy-array-fix

Qiskit · Aug 9, 2022 · 526e021 · 526e021
2 parents e475b17 + e9edfdc
commit 526e021
Show file tree

Hide file tree

Showing 16 changed files with 747 additions and 61 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -117,15 +117,16 @@ jobs:
           default: true
       - name: 'Install dependencies'
         run: python -m pip install --upgrade tox
-      - name: 'Install coreutils to set environment variable'
-        run: cargo install coreutils
       - name: 'Install binary dependencies'
         run: sudo apt-get install -y graphviz
         if: runner.os == 'Linux'
-      - name: 'Run tests'
+      - name: 'Build rustworkx'
         run: |
           tox -epy --notest
-          coreutils env RUSTWORKX_PKG_NAME="retworkx" tox -epy -- -t ./retworkx_backwards_compat
+      - name: 'Run retworkx tests'
+        env:
+          RUSTWORKX_PKG_NAME: "retworkx"
+        run: tox -epy -- -t ./retworkx_backwards_compat
   coverage:
     needs: [tests]
     name: Coverage

diff --git a/.zenodo.json b/.zenodo.json
@@ -1,6 +1,6 @@
 {
-    "title":"retworkx",
-    "description":"retworkx is a general-purpose graph theory library focused on performance. It wraps low-level Rust code into a flexible Python API, providing fast implementations for popular graph algorithms.",
+    "title":"rustworkx",
+    "description":"rustworkx is a general-purpose graph theory library focused on performance. It wraps low-level Rust code into a flexible Python API, providing fast implementations for popular graph algorithms.",
     "license":"Apache-2.0",
     "upload_type":"software",
     "access_right":"open",
@@ -22,7 +22,7 @@
           "orcid":"0000-0002-3234-8154"
        }
     ],
-    "notes":"retworkx is the work of many people who contribute to the project at different levels. See the full list of contributors on Github: https://github.com/Qiskit/retworkx/graphs/contributors",
+    "notes":"rustworkx is the work of many people who contribute to the project at different levels. See the full list of contributors on Github: https://github.com/Qiskit/rustworkx/graphs/contributors",
     "keywords":[
        "graph-theory",
        "rust",

diff --git a/CITATION.bib b/CITATION.bib
@@ -1,8 +1,17 @@
-@misc{treinish2021retworkx,
-      title={retworkx: A High-Performance Graph Library for Python}, 
-      author={Matthew Treinish and Ivan Carvalho and Georgios Tsilimigkounakis and Nahum Sá},
-      year={2021},
-      eprint={2110.15221},
-      archivePrefix={arXiv},
-      primaryClass={cs.DS}
+@misc{treinish2021rustworkx,
+  doi = {10.48550/ARXIV.2110.15221},
+
+  url = {https://arxiv.org/abs/2110.15221},
+
+  author = {Treinish, Matthew and Carvalho, Ivan and Tsilimigkounakis, Georgios and Sá, Nahum},
+
+  keywords = {Data Structures and Algorithms (cs.DS), FOS: Computer and information sciences, FOS: Computer and information sciences, E.1},
+
+  title = {rustworkx: A High-Performance Graph Library for Python},
+
+  publisher = {arXiv},
+
+  year = {2021},
+
+  copyright = {Creative Commons Attribution 4.0 International}
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,7 +16,7 @@ contributing to rustworkx, these are documented below.
 
 ### Making changes to the code
 
-Retworkx is implemented primarily in Rust with a thin layer of Python.
+Rustworkx is implemented primarily in Rust with a thin layer of Python.
 Because of that, most of your code changes will involve modifications to
 Rust files in `src`. To understand which files you need to change, we invite
 you for an overview of our simplified source tree:

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -30,6 +30,8 @@ num-traits = "0.2"
 num-bigint = "0.4"
 num-complex = "0.4"
 quick-xml = "0.22.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
 rustworkx-core = { path = "rustworkx-core", version = "=0.12.0" }
 
 [dependencies.pyo3]

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,8 +1,8 @@
 .. _rustworkx:
 
-######################
-Retworkx API Reference
-######################
+#######################
+Rustworkx API Reference
+#######################
 
 Graph Classes
 =============
@@ -243,14 +243,15 @@ Layout Functions
    rustworkx.spiral_layout
 
 
-.. _graphml:
+.. _serialization:
 
-GraphML
-==========
+Serialization
+=============
 
 .. autosummary::
    :toctree: apiref
 
+   rustworkx.node_link_json
    rustworkx.read_graphml
 
 .. _converters:
@@ -316,14 +317,15 @@ the functions from the explicitly typed based on the data type.
    rustworkx.digraph_unweighted_average_shortest_path_length
    rustworkx.digraph_bfs_search
    rustworkx.digraph_dijkstra_search
+   rustworkx.digraph_node_link_json
 
 .. _api-functions-pygraph:
 
 API functions for PyGraph
 =========================
 
 These functions are algorithm functions that are type specific for
-:class:`~rustworkx.PyGraph` objects. Universal functions from Retworkx API that
+:class:`~rustworkx.PyGraph` objects. Universal functions from Rustworkx API that
 work for both graph types internally call the functions from the explicitly
 typed API based on the data type.
 
@@ -369,6 +371,7 @@ typed API based on the data type.
    rustworkx.graph_unweighted_average_shortest_path_length
    rustworkx.graph_bfs_search
    rustworkx.graph_dijkstra_search
+   rustworkx.graph_node_link_json
 
 Exceptions
 ==========
@@ -386,6 +389,7 @@ Exceptions
    rustworkx.NullGraph
    rustworkx.visit.StopSearch
    rustworkx.visit.PruneSearch
+   rustworkx.JSONSerializationError
 
 Custom Return Types
 ===================