Release QUARK 2.1.3 (#157)

Streamlined installation and environment management (01144a4):
- QUARK installation process and switching between custom QUARK self-managed environments is now faciliated by using uv.

Graph visualization (#153):

- Added the function visualize_solution in Optimization.py that can be overridden by any sub-class where a visualization of the solution should be created. The function is called with the preprocessed solution after it has been validated. Also provided function implementations for the MIS, PVC, and TSP modules.

Minor adjustments on the Docker setup (#154)
- Removed pyqubo dependency and added arm to docker platform and minor changes in wording.

.github/workflows/container_build_publish.yml

@@ -18,11 +18,13 @@ jobs:
   build-and-push-image:
     if: github.repository == 'QUARK-framework/QUARK'
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        platform: [linux/amd64, linux/arm64]
     # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
     permissions:
       contents: read
       packages: write
-      #
     steps:
       - name: Free Disk Space (Ubuntu)
         uses: jlumbroso/free-disk-space@main
@@ -71,7 +73,6 @@ jobs:
         with:
           context: .
           push: true
-          #  Start with a limited number of platforms
-          platforms: linux/amd64,linux/arm64
+          platforms: ${{ matrix.platform }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/test.yml

@@ -34,11 +34,13 @@ jobs:
         run: pip install -r .settings/requirements_full.txt
 
       - name: Run Unit Tests
+        env:
+          PYTHONWARNINGS: "ignore::DeprecationWarning"
         run: python -m unittest discover . > unittest_results.log
 
       - name: Upload Test Logs
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: unittest-logs
           path: unittest_results.log

.readthedocs.yaml

@@ -1,6 +1,7 @@
 # .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# The part about Git LFS was taken from here: https://docs.readthedocs.io/en/stable/build-customization.html#support-git-lfs-large-file-storage
 
 # Required
 version: 2
@@ -10,6 +11,22 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
+  jobs:
+    post_checkout:
+      # Download and uncompress the binary
+      # https://git-lfs.github.com/
+      - wget https://github.com/git-lfs/git-lfs/releases/download/v3.1.4/git-lfs-linux-amd64-v3.1.4.tar.gz
+      - tar xvfz git-lfs-linux-amd64-v3.1.4.tar.gz
+      # Modify LFS config paths to point where git-lfs binary was downloaded
+      - git config filter.lfs.process "`pwd`/git-lfs filter-process"
+      - git config filter.lfs.smudge  "`pwd`/git-lfs smudge -- %f"
+      - git config filter.lfs.clean "`pwd`/git-lfs clean -- %f"
+      # Make LFS available in current repository
+      - ./git-lfs install
+      # Download content from remote
+      - ./git-lfs fetch
+      # Make local files to have the real content on them
+      - ./git-lfs checkout
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx: