Follow PEP 8 standard

.github/workflows/lint.yml

@@ -29,8 +29,26 @@ jobs:
           python-version: '3.9.16'
           token: ${{ secrets.QUARK_GH_GITHUB_COM_TOKEN }}
 
-      - name: Install pylint
-        run: pip install pylint
+      - name: Install pylint and autopep8
+        run: pip install pylint autopep8
+
+      - name: Disable Git LFS locking
+        run: git config lfs.https://github.com/QUARK-framework/QUARK.git/info/lfs.locksverify false
+
+      - name: Run autopep8 (fix PEP8 issues automatically)
+        run: autopep8 --in-place --recursive --aggressive --max-line-length 120 -v .
+
+      - name: Commit changes if any
+        run: |
+          git config --global user.name "GitHub Action"
+          git config --global user.email "[email protected]"
+          git add .
+          if git diff-index --quiet HEAD; then
+            echo "No changes to commit"
+          else
+            git commit -m "Apply autopep8 formatting"
+            git push origin HEAD:${{ github.ref }}
+          fi
 
       - name: Run pylint
         uses: wearerequired/lint-action@v2

.settings/module_db.json

@@ -1,7 +1,7 @@
 {
-  "build_number": 13,
-  "build_date": "25-09-2024 22:08:09",
-  "git_revision_number": "150c71668c47ab9c98665d485437f6e9c7bb5e5f",
+  "build_number": 14,
+  "build_date": "14-10-2024 14:33:46",
+  "git_revision_number": "81265cfafef1726474dcfc1ed8c6ae04513236dc",
   "modules": [
     {
       "name": "PVC",
@@ -1841,6 +1841,10 @@
                 {
                   "name": "numpy",
                   "version": "1.26.4"
+                },
+                {
+                  "name": "qiskit-algorithms",
+                  "version": "0.3.0"
                 }
               ],
               "submodules": [
@@ -2169,13 +2173,13 @@
     {
       "name": "GenerativeModeling",
       "class": "GenerativeModeling",
-      "module": "modules.applications.QML.generative_modeling.GenerativeModeling",
+      "module": "modules.applications.qml.generative_modeling.GenerativeModeling",
       "submodules": [
         {
           "name": "Continuous Data",
           "class": "ContinuousData",
           "args": {},
-          "module": "modules.applications.QML.generative_modeling.data.data_handler.ContinuousData",
+          "module": "modules.applications.qml.generative_modeling.data.data_handler.ContinuousData",
           "requirements": [
             {
               "name": "numpy",
@@ -2187,7 +2191,7 @@
               "name": "PIT",
               "class": "PIT",
               "args": {},
-              "module": "modules.applications.QML.generative_modeling.transformations.PIT",
+              "module": "modules.applications.qml.generative_modeling.transformations.PIT",
               "requirements": [
                 {
                   "name": "numpy",
@@ -2215,7 +2219,7 @@
                       "name": "LibraryQiskit",
                       "class": "LibraryQiskit",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryQiskit",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryQiskit",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2304,7 +2308,7 @@
                       "name": "LibraryPennylane",
                       "class": "LibraryPennylane",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryPennylane",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryPennylane",
                       "requirements": [
                         {
                           "name": "pennylane",
@@ -2405,7 +2409,7 @@
                       "name": "CustomQiskitNoisyBackend",
                       "class": "CustomQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.CustomQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.CustomQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2469,7 +2473,7 @@
                       "name": "PresetQiskitNoisyBackend",
                       "class": "PresetQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.PresetQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.PresetQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2541,7 +2545,7 @@
               "name": "MinMax",
               "class": "MinMax",
               "args": {},
-              "module": "modules.applications.QML.generative_modeling.transformations.MinMax",
+              "module": "modules.applications.qml.generative_modeling.transformations.MinMax",
               "requirements": [
                 {
                   "name": "numpy",
@@ -2560,7 +2564,7 @@
                       "name": "LibraryQiskit",
                       "class": "LibraryQiskit",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryQiskit",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryQiskit",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2649,7 +2653,7 @@
                       "name": "LibraryPennylane",
                       "class": "LibraryPennylane",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryPennylane",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryPennylane",
                       "requirements": [
                         {
                           "name": "pennylane",
@@ -2750,7 +2754,7 @@
                       "name": "CustomQiskitNoisyBackend",
                       "class": "CustomQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.CustomQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.CustomQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2814,7 +2818,7 @@
                       "name": "PresetQiskitNoisyBackend",
                       "class": "PresetQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.PresetQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.PresetQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2891,7 +2895,7 @@
                       "name": "LibraryQiskit",
                       "class": "LibraryQiskit",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryQiskit",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryQiskit",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -2980,7 +2984,7 @@
                       "name": "LibraryPennylane",
                       "class": "LibraryPennylane",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.LibraryPennylane",
+                      "module": "modules.applications.qml.generative_modeling.mappings.LibraryPennylane",
                       "requirements": [
                         {
                           "name": "pennylane",
@@ -3081,7 +3085,7 @@
                       "name": "CustomQiskitNoisyBackend",
                       "class": "CustomQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.CustomQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.CustomQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -3145,7 +3149,7 @@
                       "name": "PresetQiskitNoisyBackend",
                       "class": "PresetQiskitNoisyBackend",
                       "args": {},
-                      "module": "modules.applications.QML.generative_modeling.mappings.PresetQiskitNoisyBackend",
+                      "module": "modules.applications.qml.generative_modeling.mappings.PresetQiskitNoisyBackend",
                       "requirements": [
                         {
                           "name": "qiskit",
@@ -3219,7 +3223,7 @@
           "name": "Discrete Data",
           "class": "DiscreteData",
           "args": {},
-          "module": "modules.applications.QML.generative_modeling.data.data_handler.DiscreteData",
+          "module": "modules.applications.qml.generative_modeling.data.data_handler.DiscreteData",
           "requirements": [
             {
               "name": "numpy",
@@ -3238,7 +3242,7 @@
                   "name": "LibraryQiskit",
                   "class": "LibraryQiskit",
                   "args": {},
-                  "module": "modules.applications.QML.generative_modeling.mappings.LibraryQiskit",
+                  "module": "modules.applications.qml.generative_modeling.mappings.LibraryQiskit",
                   "requirements": [
                     {
                       "name": "qiskit",
@@ -3327,7 +3331,7 @@
                   "name": "LibraryPennylane",
                   "class": "LibraryPennylane",
                   "args": {},
-                  "module": "modules.applications.QML.generative_modeling.mappings.LibraryPennylane",
+                  "module": "modules.applications.qml.generative_modeling.mappings.LibraryPennylane",
                   "requirements": [
                     {
                       "name": "pennylane",
@@ -3428,7 +3432,7 @@
                   "name": "CustomQiskitNoisyBackend",
                   "class": "CustomQiskitNoisyBackend",
                   "args": {},
-                  "module": "modules.applications.QML.generative_modeling.mappings.CustomQiskitNoisyBackend",
+                  "module": "modules.applications.qml.generative_modeling.mappings.CustomQiskitNoisyBackend",
                   "requirements": [
                     {
                       "name": "qiskit",
@@ -3492,7 +3496,7 @@
                   "name": "PresetQiskitNoisyBackend",
                   "class": "PresetQiskitNoisyBackend",
                   "args": {},
-                  "module": "modules.applications.QML.generative_modeling.mappings.PresetQiskitNoisyBackend",
+                  "module": "modules.applications.qml.generative_modeling.mappings.PresetQiskitNoisyBackend",
                   "requirements": [
                     {
                       "name": "qiskit",

AUTHORS

@@ -5,6 +5,8 @@
 Philipp Ross (BMW Group)
 Marvin Erdmann (BMW Group)
 Andre Luckow (BMW Group)
+Greshma Shaji (BMW Group)
 Florian Kiwit (BMW Group)
 Jürgen Schwitalla (Eviden)
 Chris van den Oetelaar (Capgemini)
+Niklas Steinmann (Fraunhofer FOKUS)

README.md

@@ -1,7 +1,8 @@
 # QUARK: A Framework for Quantum Computing Application Benchmarking
 
 Quantum Computing Application Benchmark (QUARK) is a framework for orchestrating benchmarks of different industry applications on quantum computers. 
-QUARK supports various applications, like the traveling salesperson problem (TSP), the maximum satisfiability (MaxSAT) problem, or the robot path optimization in the PVC sealing use case.
+QUARK supports various applications such as the traveling salesperson problem (TSP), the maximum satisfiability (MaxSAT) problem, robot path optimization in the PVC sealing use case 
+as well as new additions like the Maximum Independent Set (MIS), Set Cover Problem (SCP) and Auto Carrier Loading (ACL).
 It also features different solvers (e.g., simulated /quantum annealing and the quantum approximate optimization algorithm (QAOA)), quantum devices (e.g., IonQ and Rigetti), and simulators.
 It is designed to be easily extendable in all of its components: applications, mappings, solvers, devices, and any other custom modules.
 
@@ -62,6 +63,17 @@ Content of the environment:
 In case you want to use custom modules files (for example, to use external modules from other repositories), you can still use the ```--modules``` option.
 You can find the documentation in the respective Read the Docs section.
 
+## Git Large File Storage (LFS)
+QUARK stores data and config files using **Git LFS**. If you are contributing to this project or cloning this repository, ensure that you have **Git LFS** installed and configured to manage large files effectively.
+
+### Installing Git LFS
+Install Git LFS by following the instructions on [Git LFS](https://git-lfs.com/):
+  - On Linux/macOS
+    ```bash
+    git lfs install
+    ```
+  - On Windows. Download and install Git LFS from the [Official page](https://git-lfs.com/)
+
 ## Running a Benchmark
 
 ```bash
@@ -84,8 +96,12 @@ Example run (You need to check at least one option with an ``X`` for the checkbo
    PVC
    SAT
  > TSP
+   ACL
+   MIS
+   SCP
+   GenerativeModeling
 
-2023-03-21 09:18:36,440 [INFO] Import module modules.applications.optimization.TSP.TSP
+2024-10-09 15:05:52,610 [INFO] Import module modules.applications.optimization.TSP.TSP
 [?] (Option for TSP) How many nodes does you graph need?:
  > [X] 3
    [ ] 4
@@ -94,6 +110,7 @@ Example run (You need to check at least one option with an ``X`` for the checkbo
    [ ] 10
    [ ] 14
    [ ] 16
+   [ ] Custom Range
 
 [?] What submodule do you want?:
    [ ] Ising
@@ -102,25 +119,38 @@ Example run (You need to check at least one option with an ``X`` for the checkbo
    [ ] ReverseGreedyClassicalTSP
    [ ] RandomTSP
 
-2023-03-21 09:18:49,563 [INFO] Skipping asking for submodule, since only 1 option (Local) is available.
-2023-03-21 09:18:49,566 [INFO] Submodule configuration finished
-[?] How many repetitions do you want?: 1
-2023-03-21 09:18:50,577 [INFO] Import module modules.applications.optimization.TSP.TSP
-2023-03-21 09:18:50,948 [INFO] Created Benchmark run directory /Users/user1/QUARK/benchmark_runs/tsp-2023-03-21-09-18-50
-2023-03-21 09:18:51,025 [INFO] Codebase is based on revision 075201825fa71c24b5567e1290966081be7dbdc0 and has some uncommitted changes
-2023-03-21 09:18:51,026 [INFO] Running backlog item 1/1, Iteration 1/1:
-2023-03-21 09:18:51,388 [INFO] Route found:
+2024-10-09 15:06:20,897 [INFO] Import module modules.solvers.GreedyClassicalTSP
+2024-10-09 15:06:20,933 [INFO] Skipping asking for submodule, since only 1 option (Local) is available.
+2024-10-09 15:06:20,933 [INFO] Import module modules.devices.Local
+2024-10-09 15:06:20,946 [INFO] Submodule configuration finished
+[?] How many repetitions do you want?: 1P
+2024-10-09 15:07:11,573 [INFO] Import module modules.applications.optimization.TSP.TSP
+2024-10-09 15:07:11,573 [INFO] Import module modules.solvers.GreedyClassicalTSP
+2024-10-09 15:07:11,574 [INFO] Import module modules.devices.Local
+2024-10-09 15:07:12,194 [INFO] [INFO] Created Benchmark run directory /Users/user1/quark/benchmark_runs/tsp-2024-10-09-15-07-11
+2024-10-09 15:07:12,194 [INFO] Codebase is based on revision 1d9d17aad7ddff623ff51f62ca3ec2756621c345 and has no uncommitted changes
+2024-10-09 15:07:12,195 [INFO] Running backlog item 1/1, Iteration 1/1:
+2024-10-09 15:07:12,386 [INFO] Route found:
  Node 0 ->
  Node 2 ->
  Node 1
-2023-03-21 09:18:51,388 [INFO] All 3 nodes got visited
-2023-03-21 09:18:51,388 [INFO] Total distance (without return): 727223.0
-2023-03-21 09:18:51,388 [INFO] Total distance (including return): 1436368.0
-2023-03-21 09:18:51,389 [INFO]
-2023-03-21 09:18:51,389 [INFO]  ============================================================
-2023-03-21 09:18:51,389 [INFO]
-2023-03-21 09:18:51,389 [INFO] Saving 1 benchmark records to /Users/user1/QUARK/benchmark_runs/tsp-2023-03-21-09-18-50/results.json
-2023-03-21 09:18:51,746 [INFO] Finished creating plots.
+2024-10-09 15:07:12,386 [INFO] All 3 nodes got visited
+2024-10-09 15:07:12,386 [INFO] Total distance (without return): 727223.0
+2024-10-09 15:07:12,386 [INFO] Total distance (including return): 1436368.0
+2024-10-09 15:07:12,386 [INFO]
+2024-10-09 15:07:12,386 [INFO] ==== Run backlog item 1/1 with 1 iterations - FINISHED:1 ====
+2024-10-09 15:07:12,387 [INFO]
+2024-10-09 15:07:12,387 [INFO] =============== Run finished ===============
+2024-10-09 15:07:12,387 [INFO]
+2024-10-09 15:07:12,387 [INFO] ================================================================================
+2024-10-09 15:07:12,387 [INFO] ====== Run 1 backlog items with 1 iterations - FINISHED:1
+2024-10-09 15:07:12,387 [INFO] ================================================================================
+2024-10-09 15:07:12,395 [INFO]
+2024-10-09 15:07:12,400 [INFO] Saving 1 benchmark records to /Users/user1/QUARK/benchmark_runs/tsp-2024-10-09-15-07-11/results.json
+2024-10-09 15:07:12,942 [INFO] Finished creating plots.
+2024-10-09 15:07:12,943 [INFO] ============================================================ 
+2024-10-09 15:07:12,944 [INFO] ====================  QUARK finished!   ====================
+2024-10-09 15:07:12,944 [INFO] ============================================================
 
 ```
 

docs/analysis.rst

@@ -11,7 +11,7 @@ Python Example
         import json
 
         # Load the results
-        filename = "benchmark_runs/tsp-2023-03-13-15-31-17/results.json"
+        filename = "benchmark_runs/tsp-2024-10-09-15-07-11/results.json"
         with open(filename) as f:
 
             results = json.load(f)