Merge branch 'public_pre_main' into 'main'

hard push of private updates

See merge request kit/fast/lb/collaboration/additive-manufacturing/pygcodedecode!46

Author: jeknirsch

.gitignore

@@ -2,6 +2,7 @@
 *.png
 *.inp
 *.csv
+*.prof
 
 # build artifacts
 __pycache__
@@ -15,7 +16,7 @@ dist/
 # output folders from examples and tests
 /output_benchy_example/*
 /tests/output/*
-
+/docs/
 
 # coverage reports
 .coverage

.gitlab-ci.yml

@@ -36,9 +36,38 @@ test-package:
                 path: ./tests/coverage.xml
         when: always
 
+doc-build:
+    stage: doc
+    image: "python:3.13"
+    needs: []
+    only:
+        refs:
+            - ^main$
+    before_script:
+        - apt-get update && apt-get install git-lfs
+        - git lfs install
+        - pip install --upgrade pip
+    script:
+        - git config --global user.name "${GITLAB_USER_NAME}"
+        - git config --global user.email "${GITLAB_USER_EMAIL}"
+        - git remote set-url origin https://gitlab-ci-token:${pyGCD_access_token}@gitlab.kit.edu/kit/fast/lb/collaboration/additive-manufacturing/pygcodedecode.git
+        - pip install -e .[DOCS]
+        - pydoc-markdown
+        - cd docs
+        - mkdocs gh-deploy --force
+    artifacts:
+        untracked: false
+        paths:
+            - ./docs/site/
+            - ./docs/content/*.md
+        when: always
+        expire_in: "30 days"
+
 doc-compile_paper:
     stage: doc
     needs: []
+    rules:
+        - when: manual
     tags:
         - shell
     script:

.vscode/launch.json

@@ -0,0 +1,10 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {"name":"Python Debugger: Current File","type":"debugpy","request":"launch","program":"${file}","console":"integratedTerminal"},
+        {"name":"Python Debugger: Benchy","type":"debugpy","request":"launch","program":"${workspaceFolder}/pyGCodeDecode/examples/benchy.py","console":"integratedTerminal"}
+    ]
+}

.vscode/settings.json

@@ -7,7 +7,8 @@
         }
     ],
     "python.testing.pytestArgs": [
-        "tests"
+        "tests",
+        "-s"
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,

README.md

@@ -66,7 +66,7 @@ pygcd plot --gcode <PATH>
 
 ## Creating a script using pyGCD
 
-Example simulations are provided in [./examples/](https://github.com/FAST-LB/pyGCodeDecode/blob/main/examples/) and can be modified to suit your needs. If you want to start from scratch, the following instructions will help you setup and run a simulation.
+Example simulations are provided in [./examples/](https://github.com/FAST-LB/pyGCodeDecode/blob/main/pyGCodeDecode/examples/) and can be modified to suit your needs. If you want to start from scratch, the following instructions will help you setup and run a simulation.
 
 ### Define your printer defaults in a `.yaml` file
 
@@ -86,7 +86,7 @@ prusa_mini:
         vY: 180
         vZ: 12
         vE: 80
-        firmware: marlin_jerk
+        firmware: prusa
 ```
 
 The default settings usually are machine specific and often can be read from the printer using a serial connection by sending a GCode command. You can use `M503` for Marlin, Prusa and some other firmwares.
@@ -104,13 +104,7 @@ from pyGCodeDecode import gcode_interpreter
 1. Load your setup `.yaml` file through:
 
 ```python
-setup = gcode_interpreter.setup(filename=r"e./pygcodedecode/data/default_printer_presets.yaml")
-```
-
-1. Select your printer from the setup by name:
-
-```python
-setup.select_printer("prusa_mini")
+setup = gcode_interpreter.setup(filename=r"./pyGCodeDecode/data/default_printer_presets.yaml", printer="prusa_mini")
 ```
 
 1. You can optionally set or modify custom properties after loading the setup:
@@ -138,19 +132,22 @@ simulation.get_values(t=2.6)
 You can visualize the GCode by plotting it in 3D:
 
 ```python
-simulation.plot_3d()
+from pyGCodeDecode.plotter import plot_3d
+plot_3d(simulation)
 ```
 
 pyGCD can also be used to create files defining an event series for ABAQUS simulations.
 
 ```python
+from pyGCodeDecode.abaqus_file_generator import generate_abaqus_event_series
+
 generate_abaqus_event_series(
         simulation=simulation,
-        filpath="path/to/event_series.csv"
+        filepath="path/to/event_series.csv"
 )
 ```
 
-For more in depth information have a look into the [documentation](https://github.com/FAST-LB/pyGCodeDecode/blob/main/doc.md).
+For more in depth information have a look into the [documentation](https://fast-lb.github.io/pyGCodeDecode/).
 
 ## Supported GCode commands