Update

.github/codecov.yml

@@ -3,6 +3,7 @@ coverage:
     project:
       default:
         informational: true
+
     patch:
       default:
         informational: true

.github/workflows/check_py.yml

@@ -8,8 +8,12 @@ on:
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  ruff_check:
+  ruff:
     runs-on: ubuntu-latest
 
     steps:
@@ -19,7 +23,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
 
       - name: Setup Ruff
         run: |
@@ -31,7 +35,15 @@ jobs:
           pip install ruff
           ruff check
 
-  ruff_format:
+      - name: Run ruff isort
+        run: |
+          ruff check --select I --fix
+
+      - name: Run ruff format
+        run: |
+          ruff format
+
+  staticcheck:
     runs-on: ubuntu-latest
 
     steps:
@@ -41,17 +53,16 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
 
-      - name: Setup Ruff
-        run: |
+      - run: |
           python3 -m pip install -U pip
-          pip install ruff
+          pip install .[dev]
 
-      - name: Run ruff format
+      - name: Run mypy
         run: |
-          ruff format
+          mypy
 
-      - name: Run ruff isort
+      - name: Run pyright
         run: |
-          ruff check --select I --fix
+          pyright

.github/workflows/check_rs.yml

@@ -8,44 +8,30 @@ on:
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  rustfmt:
+  lint_rs:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
 
-      - run: rustup update
+      - run: |
+          rustup update
+          # Use nightly for rustfmt
+          rustup toolchain install --allow-downgrade nightly
+          rustup component add --toolchain nightly rustfmt
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-
-      # Necessary for nektos/act
-      # - uses: actions-rust-lang/setup-rust-toolchain@v1
-      #   with:
-      #     components: rustfmt
+          python-version: "3.8"
 
       - name: Run rustfmt
         run: |
-          cargo fmt -- --check
-
-  clippy:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - run: rustup update
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.8
-
-      # Necessary for nektos/act
-      # - uses: actions-rust-lang/setup-rust-toolchain@v1
-      #   with:
-      #     components: clippy
+          cargo +nightly fmt -- --check
 
       - name: Run clippy
         run: |

.github/workflows/cov.yml

@@ -24,7 +24,7 @@ jobs:
           pip install pipenv
           # Use development build
           pipenv install -e .[dev]
-          pipenv run pytest --cov=./python --cov-report=xml
+          pipenv run pytest --cov-report=xml
 
       - uses: codecov/codecov-action@v4
         with:

.github/workflows/doc.yml

@@ -0,0 +1,31 @@
+name: doc
+
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: rustup update
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: |
+          python3 -m pip install -U pip
+          pip install -e .[dev,doc]
+
+      - name: Run examples
+        run: |
+          for file in examples/*.py; do
+            python3 ${file}
+          done
+
+      - run: sphinx-build docs/source docs/build --fail-on-warning

.github/workflows/test_py.yml

@@ -8,13 +8,17 @@ on:
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   pytest:
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest", "windows-latest", "macos-latest"]
-        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     name: "py${{ matrix.python }}_${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
@@ -28,9 +32,6 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
 
-      # Necessary for nektos/act
-      # - uses: actions-rust-lang/setup-rust-toolchain@v1
-
       - name: Run Python tests
         # MEMO: DO NOT use `pip install .`
         #  We need to test with debug build

.github/workflows/test_rs.yml

@@ -8,6 +8,10 @@ on:
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   cargo_test:
     runs-on: ubuntu-latest
@@ -19,11 +23,28 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-
-      # Necessary for nektos/act
-      # - uses: actions-rust-lang/setup-rust-toolchain@v1
+          python-version: "3.8"
 
       - name: Run Rust tests
         run: |
           cargo test
+
+  cargo_miri:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: |
+          rustup update
+          # Use nightly for miri
+          rustup toolchain install --allow-downgrade nightly
+          rustup component add --toolchain nightly miri
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+
+      - name: Run Rust tests with miri
+        run: |
+          cargo +nightly miri test

.github/workflows/wheel.yml

@@ -5,6 +5,13 @@ on:
     branches: ["master"]
   workflow_dispatch:
 
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   windows:
     runs-on: windows-latest
@@ -21,7 +28,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
           architecture: ${{ matrix.target }}
 
       - run: |
@@ -58,7 +65,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
           architecture: x64
 
       - run: |
@@ -102,7 +109,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
           architecture: x64
 
       - run: |
@@ -139,7 +146,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
           architecture: x64
 
       - run: |
@@ -186,7 +193,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
 
       - run: |
           python3 -m pip install -U pip
@@ -232,7 +239,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.8"
 
       - run: |
           python3 -m pip install -U pip

Cargo.toml

@@ -18,13 +18,14 @@ crate-type = ["cdylib"]
 [dependencies]
 anyhow = "1"
 fixedbitset = "0.5"
-hashbrown = "0.14"
+hashbrown = "0.14"                                                 # Cannot use 0.15 for compatibility with pyo3
 itertools = "0.13"
 pyo3 = { version = "0.22", features = ["abi3-py38", "hashbrown"] }
+thiserror = "1"
 tracing = "0.1"
 
 [dev-dependencies]
 rand = "0.8"
-rstest = "0.22"
+rstest = "0.23"
 rstest_reuse = "0.7"
 test-log = { version = "0.2", features = ["trace"] }

Pipfile

@@ -4,7 +4,7 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-fastflow = {extras = ["dev"], file = ".", editable = true}
+fastflow = {extras = ["dev", "doc"], file = ".", editable = true}
 
 [dev-packages]
 maturin = "<2,>=1"

README.md

@@ -1,3 +1,13 @@
 # fastflow
 
+[![License](https://img.shields.io/github/license/TeamGraphix/fastflow)](https://github.com/TeamGraphix/fastflow?tab=Apache-2.0-1-ov-file)
+[![test_rs](https://github.com/TeamGraphix/fastflow/actions/workflows/test_rs.yml/badge.svg)](https://github.com/TeamGraphix/fastflow/actions/workflows/test_rs.yml)
+[![test_py](https://github.com/TeamGraphix/fastflow/actions/workflows/test_py.yml/badge.svg)](https://github.com/TeamGraphix/fastflow/actions/workflows/test_py.yml)
+[![codecov](https://codecov.io/github/TeamGraphix/fastflow/graph/badge.svg?token=JPLJWWPNF4)](https://codecov.io/github/TeamGraphix/fastflow)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 Rust binding of generalized and pauli flow finding algorithms.
+
+## License
+
+This project is licensed under the Apache-2.0 License.