perf: 90% speedup via CGAL integration

.bumpversion.cfg

@@ -1,25 +1,25 @@
 [bumpversion]
-current_version = 0.7.0
+current_version = 0.8.0
 message = Bump version to {new_version}
 commit = True
 tag = True
 
-[bumpversion:file:setup.py]
-search = version="{current_version}"
-replace = version="{new_version}"
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
 
 [bumpversion:file:docs/conf.py]
-search = version = release = '{current_version}'
-replace = version = release = '{new_version}'
+search = version = release = "{current_version}"
+replace = version = release = "{new_version}"
 
 [bumpversion:file:docs/doc_versions.txt]
 search = {current_version}
 replace = {new_version}
 	{current_version}
 
 [bumpversion:file:src/compas_slicer/__init__.py]
-search = __version__ = '{current_version}'
-replace = __version__ = '{new_version}'
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
 
 [bumpversion:file:CHANGELOG.rst]
 search = Unreleased

.github/workflows/build.yml

@@ -1,7 +1,6 @@
 name: build
 
 on:
-#  [push]
   push:
     branches:
       - master
@@ -10,33 +9,40 @@ on:
       - master
 
 jobs:
-  build-packages:
+  build:
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        os: [windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Setup miniconda with python ${{ matrix.python-version }}
-        uses: conda-incubator/setup-miniconda@v2
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
         with:
-          activate-environment: compas_slicer
-          environment-file: environment.yml
-          python-version: 3.8
-          auto-activate-base: false
-          auto-update-conda: true
-      - name: Conda info
-        run: conda info
-      - name: Install project
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
         run: |
-          python -m pip install --no-cache-dir -r requirements-dev.txt
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
       - name: Test import
         run: |
-          python -c "import compas_slicer; print('COMPAS Slicer version: ' + compas_slicer.__version__)" 
-      - name: Lint with flake8
+          python -c "import compas_slicer; print('COMPAS Slicer version: ' + compas_slicer.__version__)"
+
+      - name: Lint with ruff
         run: |
-          invoke lint
+          ruff check src/
+
+      - name: Type check with mypy
+        run: |
+          mypy src/compas_slicer --ignore-missing-imports
+        continue-on-error: true
+
       - name: Test with pytest
         run: |
-          invoke test
+          pytest tests/ -v

docs/conf.py

@@ -1,35 +1,33 @@
 # -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 import os
-import sphinx_compas_theme
 
+import sphinx_compas_theme
 from sphinx.ext.napoleon.docstring import NumpyDocstring
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.coverage',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.extlinks',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
 ]
-if os.getenv('SPELLCHECK'):
-    extensions += 'sphinxcontrib.spelling',
+if os.getenv("SPELLCHECK"):
+    extensions += ("sphinxcontrib.spelling",)
     spelling_show_suggestions = True
-    spelling_lang = 'en_US'
-
-source_suffix = '.rst'
-master_doc = 'index'
-project = 'COMPAS SLICER'
-year = '2020'
-author = 'Digital Building Technologies, Gramazio Kohler Research'
-copyright = '{0}, {1}'.format(year, author)
-version = release = '0.7.0'
+    spelling_lang = "en_US"
+
+source_suffix = ".rst"
+master_doc = "index"
+project = "COMPAS SLICER"
+year = "2020-2025"
+author = "Digital Building Technologies, Gramazio Kohler Research"
+copyright = f"{year}, {author}"
+version = release = "0.8.0"
 
 pygments_style = 'sphinx'
 show_authors = True

environment.yml

@@ -2,11 +2,29 @@ name: compas_slicer
 channels:
   - conda-forge
 dependencies:
-  - python
+  - python>=3.9
   - pip
-  - compas=1.16.0
-  - networkx
-  - numpy
-  - progressbar2=3.53
-  - pyclipper=1.2.0
-  - rdp=0.8
+  # core
+  - attrs>=21.0
+  - compas>=2.0
+  - compas_libigl>=0.8
+  - networkx>=3.0
+  - numpy>=1.24
+  - progressbar2>=4.0
+  - pyclipper>=1.3
+  - rdp>=0.8
+  # dev
+  - invoke>=2.0
+  - pytest>=7.0
+  - pytest-cov
+  - ruff
+  - mypy
+  - sphinx>=6.0
+  - sphinx_compas_theme>=0.24
+  - nbsphinx
+  - ipykernel
+  - ipython>=8.0
+  - twine
+  - pip:
+    - bump2version>=1.0
+    - -e .

examples/1_planar_slicing_simple/example_1_planar_slicing_simple.py

@@ -7,7 +7,7 @@
 from compas_slicer.slicers import PlanarSlicer
 from compas_slicer.post_processing import generate_brim
 from compas_slicer.post_processing import generate_raft
-from compas_slicer.post_processing import simplify_paths_rdp_igl
+from compas_slicer.post_processing import simplify_paths_rdp
 from compas_slicer.post_processing import seams_smooth
 from compas_slicer.post_processing import seams_align
 from compas_slicer.print_organization import PlanarPrintOrganizer
@@ -74,7 +74,7 @@ def main():
     # Simplify the paths by removing points with a certain threshold
     # change the threshold value to remove more or less points
     # ==========================================================================
-    simplify_paths_rdp_igl(slicer, threshold=0.6)
+    simplify_paths_rdp(slicer, threshold=0.6)
 
     # ==========================================================================
     # Smooth the seams between layers

examples/3_planar_slicing_vertical_sorting/example_3_planar_vertical_sorting.py

@@ -5,7 +5,7 @@
 from compas_slicer.pre_processing import move_mesh_to_point
 from compas_slicer.slicers import PlanarSlicer
 from compas_slicer.post_processing import generate_brim
-from compas_slicer.post_processing import simplify_paths_rdp_igl
+from compas_slicer.post_processing import simplify_paths_rdp
 from compas_slicer.post_processing import sort_into_vertical_layers
 from compas_slicer.post_processing import reorder_vertical_layers
 from compas_slicer.post_processing import seams_smooth
@@ -46,7 +46,7 @@ def main():
 
     # Post-processing
     generate_brim(slicer, layer_width=3.0, number_of_brim_offsets=5)
-    simplify_paths_rdp_igl(slicer, threshold=0.7)
+    simplify_paths_rdp(slicer, threshold=0.7)
     seams_smooth(slicer, smooth_distance=10)
     slicer.printout_info()
     save_to_json(slicer.to_data(), OUTPUT_DIR, 'slicer_data.json')

examples/4_gcode_generation/example_4_gcode.py

@@ -4,7 +4,7 @@
 from compas_slicer.pre_processing import move_mesh_to_point
 from compas_slicer.slicers import PlanarSlicer
 from compas_slicer.post_processing import generate_brim
-from compas_slicer.post_processing import simplify_paths_rdp_igl
+from compas_slicer.post_processing import simplify_paths_rdp
 from compas_slicer.post_processing import seams_smooth
 from compas_slicer.print_organization import PlanarPrintOrganizer
 from compas_slicer.print_organization import set_extruder_toggle
@@ -37,7 +37,7 @@ def main():
     slicer = PlanarSlicer(compas_mesh, slicer_type="cgal", layer_height=4.5)
     slicer.slice_model()
     generate_brim(slicer, layer_width=3.0, number_of_brim_offsets=4)
-    simplify_paths_rdp_igl(slicer, threshold=0.6)
+    simplify_paths_rdp(slicer, threshold=0.6)
     seams_smooth(slicer, smooth_distance=10)
     slicer.printout_info()
     save_to_json(slicer.to_data(), OUTPUT_DIR, 'slicer_data.json')

examples/5_non_planar_slicing_on_custom_base/scalar_field_slicing.py

@@ -1,26 +1,28 @@
 import logging
-from compas.geometry import distance_point_point
+from pathlib import Path
+
 from compas.datastructures import Mesh
-import os
+from compas.geometry import distance_point_point
+
 import compas_slicer.utilities as slicer_utils
-from compas_slicer.post_processing import simplify_paths_rdp_igl
-from compas_slicer.slicers import ScalarFieldSlicer
 import compas_slicer.utilities as utils
+from compas_slicer.post_processing import simplify_paths_rdp
 from compas_slicer.print_organization import ScalarFieldPrintOrganizer
+from compas_slicer.slicers import ScalarFieldSlicer
 
 logger = logging.getLogger('logger')
 logging.basicConfig(format='%(levelname)s-%(message)s', level=logging.INFO)
 
-DATA_PATH = os.path.join(os.path.dirname(__file__), 'data')
+DATA_PATH = Path(__file__).parent / 'data'
 OUTPUT_PATH = slicer_utils.get_output_directory(DATA_PATH)
 MODEL = 'geom_to_slice.obj'
 BASE = 'custom_base.obj'
 
-if __name__ == '__main__':
 
+def main():
     # --- load meshes
-    mesh = Mesh.from_obj(os.path.join(DATA_PATH, MODEL))
-    base = Mesh.from_obj(os.path.join(DATA_PATH, BASE))
+    mesh = Mesh.from_obj(DATA_PATH / MODEL)
+    base = Mesh.from_obj(DATA_PATH / BASE)
 
     # --- Create per-vertex scalar field (distance of every vertex from the custom base)
     pts = [mesh.vertex_coordinates(v_key, axes='xyz') for v_key in
@@ -42,10 +44,14 @@
     slicer_utils.save_to_json(slicer.to_data(), OUTPUT_PATH, 'isocontours.json')  # save results to json
 
     # --- Print organization calculations (i.e. generation of printpoints with fabrication-related information)
-    simplify_paths_rdp_igl(slicer, threshold=0.3)
+    simplify_paths_rdp(slicer, threshold=0.3)
     print_organizer = ScalarFieldPrintOrganizer(slicer, parameters={}, DATA_PATH=DATA_PATH)
     print_organizer.create_printpoints()
 
     print_organizer.printout_info()
     printpoints_data = print_organizer.output_printpoints_dict()
     utils.save_to_json(printpoints_data, OUTPUT_PATH, 'out_printpoints.json')  # save results to json
+
+
+if __name__ == '__main__':
+    main()

examples/6_attributes_transfer/example_6_attributes_transfer.py

@@ -1,25 +1,28 @@
 import logging
-import os
-from compas.geometry import Point, Vector, distance_point_plane, normalize_vector
+from pathlib import Path
+
+import numpy as np
 from compas.datastructures import Mesh
+from compas.geometry import Point, Vector, distance_point_plane, normalize_vector
+
 import compas_slicer.utilities as slicer_utils
-from compas_slicer.post_processing import simplify_paths_rdp_igl
-from compas_slicer.slicers import PlanarSlicer
 import compas_slicer.utilities.utils as utils
-from compas_slicer.utilities.attributes_transfer import transfer_mesh_attributes_to_printpoints
+from compas_slicer.post_processing import simplify_paths_rdp
 from compas_slicer.print_organization import PlanarPrintOrganizer
-import numpy as np
+from compas_slicer.slicers import PlanarSlicer
+from compas_slicer.utilities.attributes_transfer import transfer_mesh_attributes_to_printpoints
 
 logger = logging.getLogger('logger')
 logging.basicConfig(format='%(levelname)s-%(message)s', level=logging.INFO)
 
-DATA_PATH = os.path.join(os.path.dirname(__file__), 'data')
+DATA_PATH = Path(__file__).parent / 'data'
 OUTPUT_PATH = slicer_utils.get_output_directory(DATA_PATH)
 MODEL = 'distorted_v_closed_low_res.obj'
 
-if __name__ == '__main__':
+
+def main():
     # load mesh
-    mesh = Mesh.from_obj(os.path.join(DATA_PATH, MODEL))
+    mesh = Mesh.from_obj(DATA_PATH / MODEL)
 
     # --------------- Add attributes to mesh
     # Face attributes can be anything (ex. float, bool, array, text ...)
@@ -55,15 +58,15 @@
     # --------------- Slice mesh
     slicer = PlanarSlicer(mesh, slicer_type="default", layer_height=5.0)
     slicer.slice_model()
-    simplify_paths_rdp_igl(slicer, threshold=1.0)
+    simplify_paths_rdp(slicer, threshold=1.0)
     slicer_utils.save_to_json(slicer.to_data(), OUTPUT_PATH, 'slicer_data.json')
 
     # --------------- Create printpoints
     print_organizer = PlanarPrintOrganizer(slicer)
     print_organizer.create_printpoints()
 
     # --------------- Transfer mesh attributes to printpoints
-    transfer_mesh_attributes_to_printpoints(mesh, print_organizer.printpoints_dict)
+    transfer_mesh_attributes_to_printpoints(mesh, print_organizer.printpoints)
 
     # --------------- Save printpoints to json (only json-serializable attributes are saved)
     printpoints_data = print_organizer.output_printpoints_dict()
@@ -82,3 +85,7 @@
     utils.save_to_json(positive_y_axis_list, OUTPUT_PATH, 'positive_y_axis_list.json')
     utils.save_to_json(dist_from_plane_list, OUTPUT_PATH, 'dist_from_plane_list.json')
     utils.save_to_json(utils.point_list_to_dict(direction_to_pt_list), OUTPUT_PATH, 'direction_to_pt_list.json')
+
+
+if __name__ == '__main__':
+    main()