cleanup and tests

Author: usmfi

pyGCodeDecode/state_generator.py

@@ -81,6 +81,7 @@
 default_virtual_machine = {
     "absolute_position": True,
     "absolute_extrusion": True,
+    "extrusion_volumetric": False,
     "units": "SI (mm)",
     "initial_position": None,
     # general properties
@@ -208,21 +209,21 @@ def dict_list_traveler(line_dict_list: List[dict], initial_machine_setup: dict)
 
     """
 
-    def apply_extrusion(line_dict: dict, virtual_machine: dict, command: str, initial_machine_setup: dict) -> dict:
+    def apply_extrusion(line_dict: dict, virtual_machine: dict, command: str) -> dict:
         import math
 
         e_value = line_dict[command]["E"]
 
         # volumetric to length conversion
         # (1) V = (d/2)^2 * pi * E
         # (2) E = V / ((d/2)^2 * pi)
-        if initial_machine_setup.get("extrusion_volumetric", False):
+        if virtual_machine.get("extrusion_volumetric", False):
             # volumetric extrusion
-            e_value = e_value / (math.pi * (initial_machine_setup["filament_diam"] / 2) ** 2)
+            e_value = e_value / (math.pi * (virtual_machine["filament_diam"] / 2) ** 2)
 
-        if virtual_machine["absolute_extrusion"] is True:
+        if virtual_machine["absolute_extrusion"]:
             virtual_machine["E"] = e_value
-        if virtual_machine["absolute_extrusion"] is False:  # redundant
+        else:
             virtual_machine["E"] = virtual_machine["E"] + e_value
 
         return virtual_machine
@@ -245,17 +246,15 @@ def apply_extrusion(line_dict: dict, virtual_machine: dict, command: str, initia
         layer_counter = 0
 
     # overwrite default values from initial machine setup
-    """TODO: depending on the setting the user should be informed that a default value is used.
-    I prepared a warning below.
-    Are all these settings necessary?"""
     for key in default_virtual_machine:
         if initial_machine_setup is not None and key in initial_machine_setup:
             virtual_machine[key] = initial_machine_setup[key]
         else:
-            """print(
+            custom_print(
                 f"The parameter '{key}' was not specified in your machine presets. "
-                f"Using the the default value of '{default_virtual_machine[key]}' to continue."
-            )"""
+                f"Using the the default value of '{default_virtual_machine[key]}' to continue.",
+                lvl=3,
+            )
             virtual_machine[key] = default_virtual_machine[key]
 
     # initial state creation
@@ -318,7 +317,7 @@ def apply_extrusion(line_dict: dict, virtual_machine: dict, command: str, initia
 
                 # look for extrusion commands and apply abs/rel
                 if "E" in line_dict[command]:
-                    virtual_machine = apply_extrusion(line_dict, virtual_machine, command, initial_machine_setup)
+                    virtual_machine = apply_extrusion(line_dict, virtual_machine, command)
 
                 # feed rates in unit/min to unit/sec
                 if "F" in line_dict[command]:

tests/test_end_to_end.py

@@ -2,6 +2,8 @@
 
 import pathlib
 
+import numpy as np
+
 
 def test_end_to_end_compact():
     """Testing the simulation functionality with automatic setup, similarly to the brace example."""
@@ -13,6 +15,38 @@ def test_end_to_end_compact():
     )
 
 
+def test_end_to_end_volumetr():
+    """Testing the simulation functionality with automatic setup, using volumetric or distance based extrusion."""
+    from pyGCodeDecode.gcode_interpreter import setup, simulation
+
+    preset = setup(pathlib.Path("./tests/data/test_printer_setups.yaml"), "test")
+    preset.set_property({"extrusion_volumetric": False})
+
+    sim = simulation(
+        gcode_path=pathlib.Path("./tests/data/test_state_generator.gcode"),
+        initial_machine_setup=preset,
+    )
+
+    end_extrusion = sim.blocklist[-1].segments[-1].pos_end.e
+    expected_extrusion = 14.0
+    assert end_extrusion == expected_extrusion, f"Expected {expected_extrusion}, but got {end_extrusion}"
+
+    preset = setup(pathlib.Path("./tests/data/test_printer_setups.yaml"), "test")
+    preset.set_property({"extrusion_volumetric": True})
+
+    sim = simulation(
+        gcode_path=pathlib.Path("./tests/data/test_state_generator.gcode"),
+        initial_machine_setup=preset,
+    )
+
+    end_extrusion = sim.blocklist[-1].segments[-1].pos_end.e
+    expected_extrusion = 14.0 / ((1.75 / 2) ** 2 * np.pi)
+
+    assert np.isclose(
+        end_extrusion, expected_extrusion, rtol=1e-9
+    ), f"Expected {expected_extrusion}, but got {end_extrusion}"
+
+
 def test_end_to_end_extensive():
     """Testing the simulation functionality as well as the various outputs, similarly to the benchy example."""
     from pyGCodeDecode.abaqus_file_generator import generate_abaqus_event_series