Merge remote-tracking branch 'refs/remotes/origin/master' into Multi-CGRA

Author: yuqisun

README.md

@@ -68,28 +68,8 @@ Execution
 ```
 
 
-Mac user common issues
+Mac user [debugging and troubleshooting steps doc](/debug/DEBUGGING.md)
 --------------------------------------------------------
-> xauth command not found (XQuartz is missing on mac)
-```sh
-# install XQuartz
-brew install --cask xquartz
-# open XQuartz
-open -a XQuartz
-```
-> _tkinter.TclError: couldn't connect to display "10.0.0.204:xx (Display not setup correctly)
-```sh
-# try enable all access
-xhost+
-# check display is valid or not
-echo $DISPLAY
-# if above command shows nothing, it means display is not set properly by XQuartz. Try manually assign a display number, for example 0
-export DISPLAY=:0
-xhost +
-# modify run_mac_docker.sh line 8 
-DISP_NUM=0
-
-```
 
 Installation
 --------------------------------------------------------

debug/DEBUGGING.md

@@ -0,0 +1,88 @@
+# Mac remote debugging instructions
+
+
+Developer shall be able to debug this repository's source code via VsCode installed in host machine. Below are some troubleshoot tips.
+
+
+## debugging steps
+
+
+1. Install [Docker extension](https://code.visualstudio.com/docs/devcontainers/containers) from microsoft in VsCode
+
+![](docker_extension.png)
+
+2. Start the docker container inside VsCode
+
+3. Open the python file and start debugging via clicking Run/Debug button
+
+
+## common issues
+
+
+#### 1. ```xauth command not found```
+
+MacOS is missing XQuartz dependency
+
+```
+# install XQuartz
+brew install --cask xquartz
+# open XQuartz
+open -a XQuartz
+```
+
+#### 2. ```_tkinter.TclError: couldn't connect to display 10.0.0.204:xxx (Display not setup correctly)```
+
+This can be happening for multiple reasons, including cross device display permission is not granted, display is not automatically being setup in MacOS. Try below steps:
+
+> Enable all access on host machine
+```
+xhost +
+```
+
+> Confirm display in host machine
+
+```
+echo $DISPLAY
+```
+
+> If display is empty or invalid, set a random display number in host machine
+
+```
+export DISPLAY=:0
+```
+
+> And modify the scripts to assign 0 as DISP_NUM (run_mac_docker.sh line 8)
+
+```
+DISP_NUM=0
+```
+
+
+#### 3. in VsCode terminal, an error of ```Display xx.xx.xx.xx is not found```
+
+This is because VsCode's ssh terminal does not share the same enviorment variable with the docker container, can be resolved via manually setting the display ip and port number (same as the one from docker container)
+
+run ```export DISPLAY=xxx.xxx.xxx.xxx``` in the VsCode terminal
+
+
+#### 4. When setting break points and debug, an error of ```ImportError: can not import name 'Literal' from 'typing'```
+
+
+This is because the container is running python 3.7 for the programme, however the VsCode ssh plugin is running its own python debug tool (debugpy) for python 3.8 enviorment. Can be resolved via force to install a lower version of debugpy.
+
+> install a lower version of debugpy
+
+```pip install debugpy==1.6.6```
+
+> force remove the vscode's debugpy
+
+```rm -rf /root/.vscode-server/extensions/ms-python.debugpy-2025.0.1-linux-x64/bundled/libs/debugpy```
+
+>system link the old debugpy to replace VsCode's 
+
+```ln -s /WORK_REPO/venv/lib/python3.7/site-packages/debugpy /root/.vscode-server/extensions/ms-python.debugpy-2025.0.1-linux-x64/bundled/libs/debugpy```
+
+
+## Happy debugging!
+
+![](debugging.png)

debug/debugging.png

@@ -8,7 +8,8 @@
 customtkinter.set_default_color_theme("dark-blue")
 
 master = customtkinter.CTk()
-image_path = './theme/'
+script_dir = os.path.dirname(os.path.abspath(__file__))
+image_path = os.path.join(script_dir, "theme")
 theme_selector_dark_image = customtkinter.CTkImage(Image.open(os.path.join(image_path, "dark_theme.png")), size=(500, 410))
 theme_selector_light_image = customtkinter.CTkImage(Image.open(os.path.join(image_path, "light_theme.png")), size=(500, 410))
 theme_selector_classic_image = customtkinter.CTkImage(Image.open(os.path.join(image_path, "classic_theme.png")), size=(500, 410))

debug/docker_extension.png

@@ -1517,7 +1517,7 @@ def clickTerminateMapping():
 def clickMapDFG():
     global mappingProc
     mappingProc = None
-    heuristic = mappingAlgoCheckVar.get() == 1
+    heuristic = mappingAlgoCheckVar.get() == 0
 
     os.system("mkdir kernel")
     os.chdir("kernel")
@@ -2583,12 +2583,12 @@ def create_kernel_pannel(master):
                                             font=customtkinter.CTkFont(size=FRAME_LABEL_FONT_SIZE,
                                                                        weight="bold"))
     mappingOptionLabel.grid(row=0, column=0, columnspan=2)
-    heuristicRatiobutton = customtkinter.CTkRadioButton(mappingAlgoPannel, text="Heuristic", variable=mappingAlgoCheckVar, value=0)
-    widgets["heuristicRatiobutton"] = heuristicRatiobutton
-    heuristicRatiobutton.grid(row=1, column=0, pady=(0, 5), sticky="nsew")
-    exhaustiveRatiobutton = customtkinter.CTkRadioButton(mappingAlgoPannel, text="Exhaustive", variable=mappingAlgoCheckVar, value=1)
-    widgets["exhaustiveRatiobutton"] = exhaustiveRatiobutton
-    exhaustiveRatiobutton.grid(row=1, column=1, pady=(0, 5), sticky="nsew")
+    heuristicRadioButton = customtkinter.CTkRadioButton(mappingAlgoPannel, text="Heuristic", variable=mappingAlgoCheckVar, value=0)
+    widgets["heuristicRadioButton"] = heuristicRadioButton
+    heuristicRadioButton.grid(row=1, column=0, pady=(0, 5), sticky="nsew")
+    exhaustiveRadioButton = customtkinter.CTkRadioButton(mappingAlgoPannel, text="Exhaustive", variable=mappingAlgoCheckVar, value=1)
+    widgets["exhaustiveRadioButton"] = exhaustiveRadioButton
+    exhaustiveRadioButton.grid(row=1, column=1, pady=(0, 5), sticky="nsew")
 
     tarCgraIdLabel = customtkinter.CTkLabel(kernelPannel, text=" Target CGRA id: ")
     tarCgraIdLabel.grid(row=8, column=2)