Merge branch 'main' into feat/loft_with_guides

jacobrkerstetter · web-flow · commit f9806dfd73f9 · 2025-09-24T10:29:51.000-04:00
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -39,7 +39,7 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: ansys/actions/doc-deploy-changelog@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+      - uses: ansys/actions/doc-deploy-changelog@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
@@ -49,7 +49,7 @@ jobs:
     name: Vulnerabilities
     runs-on: ubuntu-latest
     steps:
-      - uses: ansys/actions/check-vulnerabilities@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+      - uses: ansys/actions/check-vulnerabilities@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           python-package-name: ${{ env.PACKAGE_NAME }}
@@ -62,7 +62,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check commit name
-        uses: ansys/actions/check-pr-title@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/check-pr-title@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -71,7 +71,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-style@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
          token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -90,7 +90,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/build-wheelhouse@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ matrix.os }}
@@ -102,7 +102,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/docker-style@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/docker-style@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           directory: docker
           recursive: true
@@ -346,7 +346,7 @@ jobs:
           docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_DOCS_TAG }} ${{ secrets.TRANSPORT_MODE_SELECTION }}
 
       - name: Run Ansys documentation building action
-        uses: ansys/actions/doc-build@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-build@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           add-pdf-html-docs-as-assets: true
@@ -432,7 +432,7 @@ jobs:
 
       - name: Run pytest
         if: env.SKIP_UNSTABLE == 'false'
-        uses: ansys/actions/tests-pytest@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/tests-pytest@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         env:
           ALLOW_PLOTTING: true
         with:
@@ -640,7 +640,7 @@ jobs:
       id-token: write
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/build-library@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -871,7 +871,7 @@ jobs:
           restore-keys: pyvista-image-cache-${{ runner.os }}-v-${{ env.RESET_IMAGE_CACHE }}
 
       - name: Run pytest
-        uses: ansys/actions/tests-pytest@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/tests-pytest@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         env:
           ALLOW_PLOTTING: true
         with:
@@ -912,7 +912,7 @@ jobs:
       contents: write
     steps:
       - name: Release to GitHub
-        uses: ansys/actions/release-github@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/release-github@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           library-name: ${{ env.PACKAGE_NAME }}
@@ -952,7 +952,7 @@ jobs:
     needs: [package]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-deploy-dev@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
@@ -966,7 +966,7 @@ jobs:
     needs: [release, release-pypi]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-deploy-stable@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
@@ -983,7 +983,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Automerge PRs
-        uses: ansys/actions/hk-automerge-prs@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/hk-automerge-prs@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         with:
           approver: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           approver-token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
diff --git a/.github/workflows/docker_cleanup.yml b/.github/workflows/docker_cleanup.yml
@@ -22,7 +22,7 @@ jobs:
     steps:
 
     - name: "Perform versions cleanup - except certain tags"
-      uses: ansys/actions/hk-package-clean-except@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+      uses: ansys/actions/hk-package-clean-except@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
       with:
         package-name: 'geometry'
         token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -106,7 +106,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: ansys/actions/doc-changelog@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+    - uses: ansys/actions/doc-changelog@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
       with:
         token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
         use-conventional-commits: true
diff --git a/.github/workflows/nightly_docker_test.yml b/.github/workflows/nightly_docker_test.yml
@@ -221,7 +221,7 @@ jobs:
         uses: pyvista/setup-headless-display-action@7d84ae825e6d9297a8e99bdbbae20d1b919a0b19 # v4.2
 
       - name: Run pytest
-        uses: ansys/actions/tests-pytest@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/tests-pytest@9de5aa715cf3c98a237b08e1a308c08599223c42 # v10.1.2
         env:
           ALLOW_PLOTTING: true
         with:
diff --git a/doc/changelog.d/2232.added.md b/doc/changelog.d/2232.added.md
@@ -0,0 +1 @@
+Helix detection
diff --git a/doc/changelog.d/2250.maintenance.md b/doc/changelog.d/2250.maintenance.md
@@ -0,0 +1 @@
+Bump ansys/actions from 10.1.1 to 10.1.2 in the actions group
diff --git a/src/ansys/geometry/core/_grpc/_services/base/prepare_tools.py b/src/ansys/geometry/core/_grpc/_services/base/prepare_tools.py
@@ -78,3 +78,8 @@ def find_and_remove_logos(self, **kwargs) -> dict:
     def remove_logo(self, **kwargs) -> dict:
         """Remove logos in geometry."""
         pass
+
+    @abstractmethod
+    def detect_helixes(self, **kwargs) -> dict:
+        """Detect helixes in geometry."""
+        pass
diff --git a/src/ansys/geometry/core/_grpc/_services/v0/prepare_tools.py b/src/ansys/geometry/core/_grpc/_services/v0/prepare_tools.py
@@ -214,3 +214,64 @@ def remove_logo(self, **kwargs):  # noqa: D102
 
         # Return the response - formatted as a dictionary
         return {"success": response.success}
+
+    @protect_grpc
+    def detect_helixes(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
+        from ansys.api.geometry.v0.models_pb2 import DetectHelixesOptions
+        from ansys.api.geometry.v0.preparetools_pb2 import DetectHelixesRequest
+
+        from ansys.geometry.core.shapes.parameterization import Interval
+
+        from ..base.conversions import (
+            from_measurement_to_server_length,
+            to_distance,
+        )
+        from .conversions import (
+            from_grpc_curve_to_curve,
+            from_grpc_point_to_point3d,
+        )
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = DetectHelixesRequest(
+            body_ids=[EntityIdentifier(id=body.id) for body in kwargs["bodies"]],
+            options=DetectHelixesOptions(
+                min_radius=from_measurement_to_server_length(kwargs["min_radius"]),
+                max_radius=from_measurement_to_server_length(kwargs["max_radius"]),
+                fit_radius_error=from_measurement_to_server_length(kwargs["fit_radius_error"]),
+            ),
+        )
+
+        # Call the gRPC service
+        response = self.stub.DetectHelixes(request)
+
+        # If no helixes, return empty dictionary
+        if len(response.helixes) == 0:
+            return {"helixes": []}
+
+        # Return the response - formatted as a dictionary
+        return {
+            "helixes": [
+                {
+                    "trimmed_curve": {
+                        "geometry": from_grpc_curve_to_curve(helix.trimmed_curve.curve),
+                        "start": from_grpc_point_to_point3d(helix.trimmed_curve.start),
+                        "end": from_grpc_point_to_point3d(helix.trimmed_curve.end),
+                        "interval": Interval(
+                            helix.trimmed_curve.interval_start, helix.trimmed_curve.interval_end
+                        ),
+                        "length": to_distance(helix.trimmed_curve.length).value,
+                    },
+                    "edges": [
+                        {
+                            "id": edge.id,
+                            "parent_id": edge.parent.id,
+                            "curve_type": edge.curve_type,
+                            "is_reversed": edge.is_reversed,
+                        }
+                        for edge in helix.edges
+                    ],
+                }
+                for helix in response.helixes
+            ]
+        }
diff --git a/src/ansys/geometry/core/_grpc/_services/v1/prepare_tools.py b/src/ansys/geometry/core/_grpc/_services/v1/prepare_tools.py
@@ -78,3 +78,7 @@ def find_and_remove_logos(self, **kwargs) -> dict:  # noqa: D102
     @protect_grpc
     def remove_logo(self, **kwargs) -> dict:  # noqa: D102
         raise NotImplementedError
+
+    @protect_grpc
+    def detect_helixes(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError
diff --git a/src/ansys/geometry/core/tools/prepare_tools.py b/src/ansys/geometry/core/tools/prepare_tools.py
@@ -24,17 +24,21 @@
 from typing import TYPE_CHECKING
 
 from beartype import beartype as check_input_types
+from pint import Quantity
 
 from ansys.geometry.core.connection import GrpcClient
 from ansys.geometry.core.connection.backend import BackendType
 from ansys.geometry.core.errors import GeometryRuntimeError
 from ansys.geometry.core.logger import LOG
 from ansys.geometry.core.misc.auxiliary import (
     get_bodies_from_ids,
+    get_design_from_body,
     get_design_from_edge,
     get_design_from_face,
 )
 from ansys.geometry.core.misc.checks import check_type_all_elements_in_iterable, min_backend_version
+from ansys.geometry.core.misc.measurements import Distance
+from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
 from ansys.geometry.core.tools.problem_areas import LogoProblemArea
 from ansys.geometry.core.tools.repair_tool_message import RepairToolMessage
 from ansys.geometry.core.typing import Real
@@ -412,3 +416,86 @@ def find_and_remove_logos(
         )
 
         return response.get("success")
+
+    @min_backend_version(26, 1, 0)
+    def detect_helixes(
+        self,
+        bodies: list["Body"],
+        min_radius: Distance | Quantity | Real = 0.0,
+        max_radius: Distance | Quantity | Real = 100.0,
+        fit_radius_error: Distance | Quantity | Real = 0.01,
+    ) -> dict["TrimmedCurve", list["Edge"]]:
+        """Detect helixes in the given bodies.
+
+        Parameters
+        ----------
+        bodies : list[Body]
+            List of bodies to detect helixes in.
+        min_radius : Distance, Quantity, or Real, default: 0.0
+            Minimum radius of the helix to be detected.
+        max_radius : Distance, Quantity, or Real, default: 1e6
+            Maximum radius of the helix to be detected.
+        fit_radius_error : Distance, Quantity, or Real, default: 0.01
+            Maximum fit radius error of the helix to be detected.
+
+        Returns
+        -------
+        dict
+            Dictionary with key "helixes" containing a list of detected helixes.
+            Each helix is represented as a dictionary with keys "trimmed_curve" and "edges".
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 26R1.
+        """
+        from ansys.geometry.core.designer.body import Body
+        from ansys.geometry.core.designer.edge import CurveType, Edge
+
+        if not bodies:
+            self._grpc_client.log.info("No bodies provided...")
+            return {"helixes": []}
+
+        # Verify inputs
+        check_type_all_elements_in_iterable(bodies, Body)
+        min_radius = min_radius if isinstance(min_radius, Distance) else Distance(min_radius)
+        max_radius = max_radius if isinstance(max_radius, Distance) else Distance(max_radius)
+        fit_radius_error = (
+            fit_radius_error
+            if isinstance(fit_radius_error, Distance)
+            else Distance(fit_radius_error)
+        )
+
+        response = self._grpc_client._services.prepare_tools.detect_helixes(
+            bodies=bodies,
+            min_radius=min_radius,
+            max_radius=max_radius,
+            fit_radius_error=fit_radius_error,
+        )
+
+        parent_design = get_design_from_body(bodies[0])
+
+        return {
+            "helixes": [
+                {
+                    "trimmed_curve": TrimmedCurve(
+                        helix.get("trimmed_curve").get("geometry"),
+                        helix.get("trimmed_curve").get("start"),
+                        helix.get("trimmed_curve").get("end"),
+                        helix.get("trimmed_curve").get("interval"),
+                        helix.get("trimmed_curve").get("length"),
+                        grpc_client=self._grpc_client,
+                    ),
+                    "edges": [
+                        Edge(
+                            edge.get("id"),
+                            CurveType(edge.get("curve_type")),
+                            get_bodies_from_ids(parent_design, [edge.get("parent_id")])[0],
+                            self._grpc_client,
+                            edge.get("is_reversed"),
+                        )
+                        for edge in helix.get("edges")
+                    ],
+                }
+                for helix in response.get("helixes")
+            ]
+        }
diff --git a/tests/_incompatible_tests.yml b/tests/_incompatible_tests.yml
@@ -28,6 +28,7 @@ backends:
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_faces
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_edges
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_edges
+      - tests/integration/test_prepare_tools.py::test_helix_detection
       - tests/integration/test_repair_tools.py::test_fix_small_face
       - tests/integration/test_repair_tools.py::test_find_interference
       - tests/integration/test_repair_tools.py::test_fix_interference
@@ -137,6 +138,7 @@ backends:
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_faces
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_edges
       - tests/integration/test_prepare_tools.py::test_volume_extract_bad_edges
+      - tests/integration/test_prepare_tools.py::test_helix_detection
       - tests/integration/test_repair_tools.py::test_fix_small_face
       - tests/integration/test_repair_tools.py::test_find_interference
       - tests/integration/test_repair_tools.py::test_fix_interference
@@ -222,6 +224,7 @@ backends:
       # Model used is too new for this version
       - tests/integration/test_design.py::test_import_component_named_selections
       - tests/integration/test_design.py::test_component_make_independent
+      - tests/integration/test_prepare_tools.py::test_helix_detection
       - tests/integration/test_spaceclaim_tutorial_examples.py::test_combine_example
       - tests/integration/test_spaceclaim_tutorial_examples.py::test_pull_example
       - tests/integration/test_spaceclaim_tutorial_examples.py::test_intersect_example
diff --git a/tests/integration/files/bolt.scdocx b/tests/integration/files/bolt.scdocx
diff --git a/tests/integration/test_prepare_tools.py b/tests/integration/test_prepare_tools.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Bump ansys/actions from 10.1.1 to 10.1.2 in the actions group`