Merge pull request sequence-toolbox#276 from sequence-toolbox/RnD

Merge recent commits from RnD to Master --  version 0.8.2

Author: hayekr

.github/workflows/development.yml

@@ -4,82 +4,114 @@ on:
   push:
     branches: [RnD]
   workflow_dispatch:
+
+env:
+  PYTHON_VERSION: '3.x'
+  PROD_PYPI_NAME: 'sequence'
+  TEST_PYPI_NAME: 'ssequence'
+
 jobs:
-  build-test-rnd:
-    name: Build RnD Development Package
+  build-rnd:
+    if: github.repository == 'sequence-toolbox/SeQUeNCe'
+    name: Build RnD Package
     runs-on: ubuntu-latest
+    outputs:
+      dev_version: ${{ steps.version.outputs.dev_version }}
+      commit_hash: ${{ steps.version.outputs.commit_hash }}
+
+    strategy:
+      matrix:
+        target: [pypi, testpypi]
 
     steps:
-    - uses: actions/checkout@v5
-      with:
-        persist-credentials: 'true'
-        ref: RnD
-
-    - name: Setup Python
-      uses: actions/setup-python@v6
-      with:
-        python-version: '3.x'
-
-    - name: Install pypa/build
-      run: >-
-        python3 -m
-        pip install 
-        build
-        --user
-
-    - name: Update version for dev
-      run: |
-        # Get current date for dev versioning
-        DEV_DATE=$(date +%Y%m%d)
-        
-        # Read current version from pyproject.toml
-        CURRENT_VERSION=$(grep '^version = ' pyproject.toml | cut -d'"' -f2)
-        
-        # Create development version from RnD: e.g., 0.8.1.dev20241218
-        DEV_VERSION="${CURRENT_VERSION}.dev${DEV_DATE}"
-        
-        # Update version in pyproject.toml
-        sed -i "s/^version = .*/version = \"${DEV_VERSION}\"/" pyproject.toml
-        
-        echo "DEV_VERSION=${DEV_VERSION}" >> $GITHUB_ENV
-        echo "Building development version from RnD: ${DEV_VERSION}"
-
-    - name: Modify package name for TestPyPI
-      run: |
-        sed -i 's/^name = "sequence"/name = "ssequence"/' pyproject.toml
-
-    - name: Build wheel and tarball
-      run: python3 -m build
-
-    - name: Store development build as artifact
-      uses: actions/upload-artifact@v4
-      with:
-        name: test-dev-build-RnD-${{ env.DEV_VERSION }}
-        path: dist/
-        retention-days: 4
-
-  publish-dev-to-test-pypi:
-    name: Publish RnD Development to TestPyPI
-    needs: build-test-rnd
+      - name: Checkout RnD branch
+        uses: actions/checkout@v5
+        with:
+          persist-credentials: 'true'
+          ref: RnD
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install 
+          build
+          --user
+
+      - name: Generate development version
+        id: version
+        run: |
+          GIT_HASH=$(git rev-parse --short HEAD)
+          NUMERIC_HASH=$((0x${GIT_HASH}))
+          CURRENT_VERSION=$(grep '^version = ' pyproject.toml | cut -d'"' -f2)
+          
+          DEV_VERSION="${CURRENT_VERSION}.dev${NUMERIC_HASH}"
+          
+          echo "dev_version=${DEV_VERSION}" >> $GITHUB_OUTPUT
+          echo "commit_hash=${GIT_HASH}" >> $GITHUB_OUTPUT
+          echo "DEV_VERSION=${DEV_VERSION}" >> $GITHUB_ENV
+  
+          echo "Building development version from RnD: ${DEV_VERSION}"
+
+      - name: Update package configuration
+        run: |
+          # Update version in pyproject.toml
+          sed -i "s/^version = .*/version = \"${DEV_VERSION}\"/" pyproject.toml
+          
+          if [ "${{ matrix.target }}" = "testpypi" ]; then
+            sed -i "s/^name = \"sequence\"/name = \"ssequence\"/" pyproject.toml
+          fi
+
+      - name: Build wheel and tarball
+        run: python3 -m build
+
+      - name: Store build as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-RnD-${{ matrix.target }}-${{ steps.version.outputs.dev_version }}
+          path: dist/
+          retention-days: 4
+
+  publish-rnd:
+    name: Publish RnD to TestPyPI and PyPI
+    needs: build-rnd
     runs-on: ubuntu-latest
+    if: success() && github.repository == 'sequence-toolbox/SeQUeNCe'
+
+    strategy:
+      matrix:
+        include:
+          - target: pypi
+            environment: pypi
+            repository_url: https://pypi.org/p/sequence
+            package_name: sequence
+          - target: testpypi
+            environment: testpypi
+            repository_url: https://test.pypi.org/p/ssequence
+            package_name: ssequence
+            pypi_url: https://test.pypi.org/legacy/
 
     environment:
-      name: testpypi
-      url: https://test.pypi.org/p/ssequence
+      name: ${{ matrix.environment }}
+      url: ${{ matrix.repository_url }}
 
     permissions:
       id-token: write
 
     steps:
-    - name: Download development build
-      uses: actions/download-artifact@v4
-      with:
-        pattern: test-dev-build-RnD-*
-        path: dist/
-        merge-multiple: true
-
-    - name: Publish development build to TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        repository-url: https://test.pypi.org/legacy/
-        skip-existing: true
+      - name: Download the builds
+        uses: actions/download-artifact@v4
+        with:
+          name: build-RnD-${{ matrix.target }}-${{ needs.build-rnd.outputs.dev_version }}
+          path: dist/
+
+      - name: Publish dist
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: ${{ matrix.pypi_url || '' }}
+          skip-existing: true
+          verbose: true

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
   build-release:
     name: Build the release
     runs-on: ubuntu-latest
-    if: github.event_name == 'release'
+    if: github.event_name == 'release' && github.repository == 'sequence-toolbox/SeQUeNCe'
     steps:
       - uses: actions/checkout@v5
         with:
@@ -37,7 +37,7 @@ jobs:
   build-test-release:
     name: Build the test release
     runs-on: ubuntu-latest
-    if: github.event_name == 'push'
+    if: github.event_name == 'push' && github.repository == 'sequence-toolbox/SeQUeNCe'
     steps:
       - uses: actions/checkout@v5
         with:
@@ -65,7 +65,7 @@ jobs:
 
   publish-to-pypi:
     name: Publish dist to PyPi
-    if: github.event_name == 'release' && github.event.action == 'published'
+    if: github.event_name == 'release' && github.event.action == 'published' && github.repository == 'sequence-toolbox/SeQUeNCe'
     needs:
       - build-release
     runs-on: ubuntu-latest
@@ -86,7 +86,7 @@ jobs:
 
   publish-to-test-pypi:
     name: Publish dist to TestPyPi
-    if: github.event_name == 'push'
+    if: github.event_name == 'push' && github.repository == 'sequence-toolbox/SeQUeNCe'
     needs:
       - build-test-release
     runs-on: ubuntu-latest

.github/workflows/validation.yml

@@ -9,6 +9,7 @@ on:
 
 jobs:
   validation:
+    if: github.repository == 'sequence-toolbox/SeQUeNCe'
     name: Run Unit Tests
     runs-on: ubuntu-latest
     strategy:

.gitignore

@@ -143,3 +143,6 @@ sequence/gui/test_run.py
 
 # tmp folder
 tmp/
+
+# config file
+utils/json_config_generators/*.json

CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [0.8.2] - 2025-11-19
+### Added
+- A new state `PURIFIED` in `MemoryInfo` is introduced to enable the new purify strategy `once`, i.e. only purify one time. The previous existing stragety is renamed to `until_target`, i.e., keep purifing until reaching the target fidelity.
+- `QuantumManagerKet.get_ascending_keys()`: call `reorder_qubits_ascending_keys()` before getting the state
+- `QuantumManagerKet.reorder_qubits_ascending_keys()`: reorder the quantum state such that the corresponding keys are in ascending order.
+- `QuantumManagerDensity.get_ascending_keys()` and `QuantumManagerDensity.reorder_qubits_ascending_keys()`: same reording qubits for density matrix formalism.
+- `quantum_utils.pretty_ket()`: return a pretty-looking state vector string
+- `NetworkManager.get_reservation_protocol()`: Method to get the resource reservation protocol in the network manager's protocol stack.
+
+### Changed
+- Updated workflows `development.yml`, `publish.yml`, `validation.yml`. Only run on the main repository (sequence-toolbox/SeQUeNCe), preventing unintended builds and publishes from forks.
+- Standardized `gmpy2` context precision to 80 bits in timing-related modules (`detector.py`, `optical_channel.py`) for computation efficiency and sufficient accuracy.
+- `quantum_utils.measure_entangled_state_with_cache_ket()`: make code more mathematically sound.
+- A lot of minor refactoring (spacing, indentation, f-string, comments, docstring, etc.)
+- Updated related `pytest`
+
+### Fixed
+- Improved time calculations in `Detector.record_detection` to use high-precision `gmpy2`
+
+### Removed
+- Remove all parallel module related stuff under `utils/json_config_gnerators/*`, `config_generator.py` and `router_net_topo.py`.
+
+
+
 ## [0.8.1] - 2025-09-17
 ### Changed
 - Migrate code to fit PEP requirements for py3.11

README.md

@@ -78,16 +78,7 @@ python gui.py
 ```
 
 ## Usage Examples
-Many examples of SeQUeNCe in action can be found in the [example](/example) folder. These include both quantum key distribution and entanglement distribution examples.
-
-### Starlight Experiments
-Code for the experiments performed in our paper can be found in the file `starlight_experiments.py`. This script uses the `starlight.json` file (also within the example folder) to specify the network topology.
-
-### Jupyter Notebook Examples
-The example folder contains several scripts that can be run with jupyter notebook for easy editing and visualization. These examples include:
-* `BB84_eg.ipynb`, which uses the BB84 protocol to distribute secure keys between two quantum nodes
-* `two_node_eg.ipynb`, which performs entanglement generation between two adjacent quantum routers
-* `three_node_eg_ep_es.ipynb`, which performs entanglement generation, purification, and swapping for a linear network of three quantum routers
+Many examples of SeQUeNCe in action can be found in the [example](/example) folder. The example includes jupyter notebook demos, and code used in published papers.
 
 ## Additional Tools
 

docs/source/conf.py

@@ -22,7 +22,7 @@
 author = 'Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara'
 
 # The full version, including alpha/beta/rc tags
-release = '0.8.1'
+release = '0.8.2'
 
 
 # -- General configuration ---------------------------------------------------