Qiskit Metal v0.5: PySide6, Removing GDSPY to GDSTK, PYAEDT v1.0, and many more changes

.github/workflows/docs.yml

@@ -6,21 +6,22 @@ on:
 
 jobs:
   deploy:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
-          python-version: "3.9"
+          python-version: "3.12"
+          cache: "pip"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip==23.0
-          pip install -U tox==4.11.0 setuptools==67.3.1 virtualenv==20.24.3 wheel==0.38.4
+          python -m pip install --upgrade pip==25.2
+          pip install -U tox==4.30.3 setuptools==80.9.0 virtualenv==20.34.0 wheel==0.45.1
           sudo apt update
-          sudo apt install graphviz=2.42.2-6 pandoc=2.9.2.1-3ubuntu2 qtbase5-dev=5.15.3+dfsg-2ubuntu0.2 qt5-qmake=5.15.3+dfsg-2ubuntu0.2
+          sudo apt install graphviz=2.42.2-9ubuntu0.1 pandoc=3.1.3+ds-2 qtbase5-dev=5.15.13+dfsg-1ubuntu1 qt5-qmake=5.15.13+dfsg-1ubuntu1
       - name: Build docs
         run: tox -edocs -- -j auto
       - name: Bypass Jekyll Processing # Necessary for setting the correct css path

.github/workflows/main.yml

@@ -6,147 +6,108 @@ on:
   pull_request:
     branches: [main, "stable/*"]
 jobs:
-  # NOTE: The ubuntu-22.04 and macos-latest tests have been separated out because ubuntu
+  # NOTE: The ubuntu-24.04 and macos-latest tests have been separated out because ubuntu
   # requires installing some additional libraries (libglu1-mesa) for Gmsh to run. Please
   # consider this aspect before combining the tests for both the OS platforms.
   ubuntu-tests:
     # Name the Job
     name: tests-python${{ matrix.python-version }}-ubuntu-latest
     # Set the type of machine to run on
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     # Set matrix for runs-on
     strategy:
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.11", "3.12"]
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Pip cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: ubuntu-latest-${{ matrix.python-version }}-pip-tests-${{ hashFiles('setup.py','requirements-dev.txt','requirements.txt') }}
-          restore-keys: |
-            ubuntu-latest-${{ matrix.python-version }}-pip-tests-
-            ubuntu-latest-${{ matrix.python-version }}-pip-
-            ubuntu-latest-${{ matrix.python-version }}
+          cache: "pip"
       - name: Install Deps
         run: |
-          python -m pip install -U tox==4.11.0 setuptools==67.3.1 virtualenv==20.24.3 wheel==0.38.4
-          sudo apt install libglu1-mesa=9.0.2-1 libglu1-mesa-dev=9.0.2-1
+          python -m pip install -U tox setuptools virtualenv wheel
+          sudo apt update
+          sudo apt install libglu1-mesa libglu1-mesa-dev libegl1-mesa-dev
       - name: Install and Run Tests
         run: tox -e py
   macos-tests:
     # Name the Job
     name: tests-python${{ matrix.python-version }}-macOS-latest
     # Set the type of machine to run on
-    runs-on: macos-12
+    runs-on: macos-15
     # Set matrix for runs-on
     strategy:
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.11", "3.12"]
     steps:
       - name: Chekout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Pip cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: macOS-latest-${{ matrix.python-version }}-pip-tests-${{ hashFiles('setup.py','requirements-dev.txt','requirements.txt') }}
-          restore-keys: |
-            macOS-latest-${{ matrix.python-version }}-pip-tests-
-            macOS-latest-${{ matrix.python-version }}-pip-
-            macOS-latest-${{ matrix.python-version }}
+          cache: "pip"
       - name: Install Deps
-        run: python -m pip install -U tox==4.11.0 setuptools==67.3.1 virtualenv==20.24.3 wheel==0.38.4
+        run: python -m pip install -U tox setuptools virtualenv wheel
       - name: Install and Run Tests
         run: tox -e py
   windows-tests:
     name: tests-python${{ matrix.python-version }}-windows
-    runs-on: windows-2022
+    runs-on: windows-2025
     strategy:
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Pip cache
-        uses: actions/cache@v3
-        with:
-          path: ~\AppData\Local\pip\Cache
-          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-tests-${{ hashFiles('setup.py','requirements-dev.txt','requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.python-version }}-pip-tests-
-            ${{ runner.os }}-${{ matrix.python-version }}-pip-
-            ${{ runner.os }}-${{ matrix.python-version }}-
+          cache: "pip"
       - name: Install deps
         run: |
-          python -m pip install -U tox==4.11.0 cvxopt==1.3.0 setuptools==67.3.1 virtualenv==20.24.3 wheel==0.38.4
+          python -m pip install -U tox cvxopt setuptools virtualenv wheel
         shell: pwsh
       - name: Install and Run Tests
         run: tox --sitepackages -e py
         shell: bash -l {0}
   lint:
     name: lint
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-      - name: Pip cache
-        uses: actions/cache@v3
+      - uses: actions/checkout@v5
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-lint-${{ hashFiles('setup.py','requirements-dev.txt','requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.python-version }}-pip-lint-
-            ${{ runner.os }}-${{ matrix.python-version }}-pip-
-            ${{ runner.os }}-${{ matrix.python-version }}-
+          python-version: 3.12
+          cache: "pip"
       - name: Install Deps
-        run: python -m pip install -U tox==4.11.0
+        run: python -m pip install -U tox
       - name: Run lint
         run: tox -elint
   docs:
     name: docs
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-      - name: Pip cache
-        uses: actions/cache@v3
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-docs-${{ hashFiles('setup.py','requirements-dev.txt','requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-docs-
-            ${{ runner.os }}-pip-
-            ${{ runner.os }}-
+          python-version: 3.12
+          cache: "pip"
       - name: Install Deps
         run: |
-          python -m pip install -U tox==4.11.0
+          python -m pip install -U tox==4.30.3
           sudo apt update
-          sudo apt install -y graphviz=2.42.2-6 pandoc=2.9.2.1-3ubuntu2 qtbase5-dev=5.15.3+dfsg-2ubuntu0.2 qt5-qmake=5.15.3+dfsg-2ubuntu0.2
+          sudo apt install -y graphviz=2.42.2-9ubuntu0.1 pandoc=3.1.3+ds-2 qtbase5-dev=5.15.13+dfsg-1ubuntu1 qt5-qmake=5.15.13+dfsg-1ubuntu1
       - name: Build Docs
         run: tox -edocs
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: html_docs
           path: docs/_build/html

.github/workflows/release.yml

@@ -6,21 +6,21 @@ on:
 jobs:
   wheel-build:
     name: Build and Publish Release Artifacts
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
         name: Install Python
         with:
-          python-version: "3.10"
+          python-version: "3.12"
       - name: Install Deps
-        run: pip install -U twine==4.0.2 wheel==0.38.4
+        run: pip install -U twine==6.2.0 wheel==0.45.1
       - name: Build Artifacts
         run: |
           python setup.py sdist
           python setup.py bdist_wheel
         shell: bash
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           path: ./dist/qiskit*
       - name: Publish to PyPi

.gitignore

@@ -57,6 +57,7 @@ instance/
 # User Folders:
 .scrapy
 _sandbox_/
+_debug/
 qiskit_metal/qlibrary/user_components/*
 !qiskit_metal/qlibrary/user_components/__init__.py
 !qiskit_metal/qlibrary/user_components/my_qcomponent.py
@@ -92,6 +93,7 @@ celerybeat-schedule
 # virtualenv
 .venv
 venv/
+venvz/
 ENV/
 
 # Spyder project settings

.pylintrc

@@ -6,7 +6,7 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-whitelist=PySide2
+extension-pkg-whitelist=PySide6,gdstk
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
@@ -91,7 +91,7 @@ disable=apply-builtin,
         dict-values-not-iterating,
         dict-view-method,
         div-method,
-        eq-without-hash,
+;         eq-without-hash,
         exception-escape,
         exception-message-attribute,
         execfile-builtin,
@@ -108,21 +108,21 @@ disable=apply-builtin,
         intern-builtin,
         invalid-str-codec,
         locally-disabled,
-        logging-fstring-interpolation  # fstrings inside logging
+        logging-fstring-interpolation, # fstrings inside logging
         long-builtin,
-        long-suffix,
+;         long-suffix,
         map-builtin-not-iterating,
         metaclass-assignment,
         missing-module-docstring,
         next-method-called,
         next-method-defined,
         no-absolute-import,
-        non-ascii-bytes-literal,
+;         non-ascii-bytes-literal,
         nonzero-method,
         oct-method,
         old-division,
-        old-ne-operator,
-        old-octal-literal,
+;         old-ne-operator,
+;         old-octal-literal,
         old-raise-syntax,
         parameter-unpacking,
         print-statement,
@@ -339,8 +339,8 @@ max-module-lines=1000
 # separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
 # `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
+; no-space-check=trailing-comma,
+;                dict-separator
 
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.

CONTRIBUTING.md

@@ -43,22 +43,38 @@ https://google.github.io/styleguide/pyguide.html) for auto formatting. The custo
 
 #### VSCode Setup
 
+Steps:
+1. Install the following extensions: `python` and `yapf` if you have not yet.
+2. Add the following workspace setting in the workspace `settings.json`.
+
 If you are using VSCode for your code editor, you can add these settings
 to your `settings.json` to enforce your code to our style. Make sure to add PySide2 to the linter:
-```
+```json
 {
     "python.linting.pylintEnabled": true,
     "python.linting.enabled": true,
-    "python.linting.pylintArgs": [
-        "--extension-pkg-whitelist=PySide2"
-    ],
     "python.formatting.provider": "yapf",
     "editor.formatOnSave": true,
     "files.trimTrailingWhitespace": true,
     "files.trimFinalNewlines": true
 }
 ```
 
+
+In newer versions of VS Code:
+```json
+{
+    "editor.formatOnSave": true,
+    "files.trimTrailingWhitespace": true,
+    "files.trimFinalNewlines": true,
+    "editor.defaultFormatter": "eeyore.yapf",
+    "notebook.defaultFormatter": "eeyore.yapf",
+    "[python]": {
+        "editor.defaultFormatter": "eeyore.yapf"
+    }
+}
+```
+
 ### Code Review
 Code review is done in the open and open to anyone. While only maintainers have access to merge commits, providing feedback on pull requests is very valuable and helpful. It is also a good mechanism to learn about the code base. You can view a list of all open pull requests to review any open pull requests and provide feedback on it.