feat: add pyoxidizer and docker containerization

Author: Kevin Barre

Dockerfile

@@ -0,0 +1,6 @@
+FROM scratch
+
+COPY ./dist/simui_static /simui_static
+
+ENTRYPOINT ["/simui_static"]
+CMD [ ""]

pyoxidizer.bzl

@@ -0,0 +1,34 @@
+def make_exe():
+    # 1. Get the default Python distribution (standard Python library)
+    policy = dist.make_python_packaging_policy()
+    policy.resources_location_fallback = "filesystem-relative:lib"
+    dist = default_python_distribution()
+
+    # 2. Configure the interpreter startup
+    # This tells the app to import 'main.py' and run the 'run()' function inside it
+    python_config = dist.make_python_interpreter_config()
+    python_config.run_command = "import simui; simui.run()"
+
+    # 3. Define the executable wrapper
+    exe = dist.to_python_executable(
+        name="simui",
+        config=python_config,
+        packaging_policy=policy,
+    )
+
+    # 4. Add your Python source code
+    # Scans the current directory (".") for the "main" module (main.py)
+    exe.add_python_resources(exe.read_package_root(
+        path=".",
+        packages=["simui"]
+    ))
+
+    # exe.add_python_resources(exe.pip_install(["."]))
+    
+    return exe
+
+# 5. Register the build target so PyOxidizer knows what to build
+register_target("exe", make_exe)
+
+# 6. Finalize targets (Standard boilerplate)
+resolve_targets()

pyproject.toml

@@ -8,6 +8,7 @@ dependencies = [
     "imgui-bundle[full]>=1.92.5",
     "numpy>=2.4.0",
     "pyinstaller>=6.17.0",
+    "pyoxidizer>=0.24.0",
     "staticx>=0.14.1",
 ]
 

readme.md

@@ -59,8 +59,12 @@ source .venv/bin/activate
 export PATH=$PATH:$PWD/.venv/bin/
 
 imgui_bundle_asset_path=`python -c "import imgui_bundle, os; print(os.path.join(os.path.dirname(imgui_bundle.__file__), 'assets'))"`
+PYTHONOPTIMIZE=3
 
-pyinstaller --onefile --noconsole \
+pyinstaller \
+  --onefile \
+  --noconsole \
+  --windowed \
   --add-data "${imgui_bundle_asset_path}:imgui_bundle/assets" \
   --name "simui" \
   simui.py
@@ -112,6 +116,40 @@ ldd ./dist/simui_static
 ./simui_static
 ```
 
+### Docker
+
+```bash
+xhost +local:docker
+
+docker build . -t simui:latest
+```
+
+X11 forwarding
+
+```bash
+docker run -it --rm \
+    --net=host \
+    -e DISPLAY=$DISPLAY \
+    -v /tmp/.X11-unix:/tmp/.X11-unix \
+    -v $HOME/.Xauthority:/root/.Xauthority \
+    simui:latest
+```
+
+Wayland forwarding
+
+```bash
+docker run -it --rm \
+    -e XDG_RUNTIME_DIR=/tmp \
+    -e WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
+    -e DISPLAY=$DISPLAY \
+    -v $XDG_RUNTIME_DIR/$WAYLAND_DISPLAY:/tmp/$WAYLAND_DISPLAY \
+    -e QT_QPA_PLATFORM=wayland \
+    -e GDK_BACKEND=wayland \
+    simui:latest
+```
+
+Adapt with `--device /dev/...`
+
 ## Pyiodide for web
 
 source: https://pyodide.com/
@@ -144,10 +182,16 @@ Use [Fiatlight](pthom.github.io/fiatlight_doc/flgt/intro.html) for faster UI dev
 
 ### Packages
 
-[PyInstaller](https://pyinstaller.org/en/stable/) and/or [Nuitka](https://nuitka.net/) or [PyOxidizer](https://github.com/indygreg/PyOxidizer) can be used to compile the python code into a single executable file.
+[PyInstaller](https://pyinstaller.org/en/stable/) or [PyOxidizer](https://github.com/indygreg/PyOxidizer) can be used to compile the python code into a single executable file.
 
 Shaders (GLSL) can be used to use gpu acceleration, also interoperability with vulkan, metal, dx12, OpenCV, and CUDA is Possible.
 
+## Possible Performance Improvements
+
+[cythonizer](https://github.com/TechLearnersInc/cythonizer) and [pyoxidizer](https://github.com/indygreg/PyOxidizer) can be used to compile the python code into a single executable file.
+
+Write the code in cython and compile it to c code.
+
 ### ImGui
 
 - [imgui_bundle_playground](https://traineq.org/imgui_bundle_online/projects/imgui_bundle_playground/)

simui.py

@@ -123,7 +123,7 @@ def gui_right_panel() -> None:
         implot.end_plot()
 
 
-def main() -> None:
+def simui() -> None:
     runner_params = hello_imgui.RunnerParams()
 
     # runner_params.app_window_params.borderless = True
@@ -169,4 +169,4 @@ def main() -> None:
 
 
 if __name__ == "__main__":
-    main()
+    simui()