Bump actions/checkout from 4.1.1 to 4.1.6 (#12)

Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.1 to 4.1.6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4.1.1...v4.1.6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/main.yml

@@ -11,8 +11,8 @@ jobs:
       FUNCTION_SCHEMA_FILE_NAME: functionSchema.json
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.4.0
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4.1.6
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       - name: Install and configure Poetry
@@ -29,12 +29,12 @@ jobs:
         run: |
           python main.py generate_schema ${HOME}/${{ env.FUNCTION_SCHEMA_FILE_NAME }}
       - name: Speckle Automate Function - Build and Publish
-        uses: specklesystems/speckle-automate-github-composite-action@0.7.4
+        uses: specklesystems/speckle-automate-github-composite-action@0.8.1
         with:
           speckle_automate_url: ${{ env.SPECKLE_AUTOMATE_URL || 'https://automate.speckle.dev' }} 
           speckle_token: ${{ secrets.SPECKLE_FUNCTION_TOKEN }}
           speckle_function_id: ${{ secrets.SPECKLE_FUNCTION_ID }}
           speckle_function_input_schema_file_path: ${{ env.FUNCTION_SCHEMA_FILE_NAME }}
           speckle_function_command: 'python -u main.py run'
-          speckle_function_recommended_cpu_m: 4000
-          speckle_function_recommended_memory_mi: 4000
+          speckle_function_recommended_cpu_m: 8000
+          speckle_function_recommended_memory_mi: 8000

Geometry/clash.py

@@ -1,3 +1,4 @@
+from collections import defaultdict
 from concurrent.futures import ProcessPoolExecutor, as_completed
 from typing import List, Tuple, Any, Optional
 
@@ -63,7 +64,7 @@ def detect_clashes_old(
 
 def check_for_clash(
         ref_element: Element, latest_element: Element
-) -> Optional[tuple[Any, Any, Any]]:
+) -> Optional[tuple[Any, Any]]:
     """
     Check for a clash between two elements and calculate the severity of the clash.
 
@@ -86,16 +87,14 @@ def check_for_clash(
             intersection = pymesh.boolean(latest_pymesh, ref_pymesh, operation="intersection")
 
             if intersection and intersection.volume > 0:
-                severity = intersection.volume / min(
-                    ref_pymesh.volume, latest_pymesh.volume
-                )
-                return ref_element.id, latest_element.id, severity
+
+                return ref_element.id, latest_element.id
     return None
 
 
 def detect_clashes(
         reference_elements: List[Element], latest_elements: List[Element], _tolerance: float
-) -> List[Tuple[str, str, float]]:
+) -> List[Tuple[str, str]]:
     """
     Detect clashes between two sets of mesh elements using parallel processing.
 
@@ -127,30 +126,25 @@ def detect_and_report_clashes(
         latest_elements: list[Element],
         tolerance: float,
         automate_context: AutomationContext,
-) -> list[tuple[str, str, float]]:
-    print(f"{len(reference_elements[0].meshes)} reference meshes")
-    print(f"{len(latest_elements[0].meshes)} latest meshes")
+) -> list[tuple[str, str]]:
 
     clashes = detect_clashes(reference_elements, latest_elements, tolerance)
 
-    total_clashes = len(clashes)
-    padding_length = len(str(total_clashes))
+    grouped_clashes = defaultdict(list)
 
-    for i, (ref_id, latest_id, severity) in enumerate(clashes, start=1):
-        clash_number = str(i).zfill(padding_length)
-        combined_message = f"Clash {clash_number}: between {ref_id} and {latest_id} with severity {severity:.2f}"
-        object_ids = [ref_id, latest_id]
+    for ref, latest in clashes:
+        if not latest:
+            continue
+        grouped_clashes[ref].append(latest)
 
-        # Assuming severity levels: Low (<0.25), Medium (0.25-0.75), High (>0.75) TODO: Determine severity levels
-        if severity > 0.75:
-            category = "High"
-        elif severity > 0.25:
-            category = "Medium"
-        else:
-            category = "Low"
+    for group_number, clashing_objects in enumerate(grouped_clashes.items(), start=1):
+
+        ref_id, latest_elements = clashing_objects
+
+        all_clashing_objects = [ref_id] + [element_id for element_id in  latest_elements]
 
         automate_context.attach_error_to_objects(
-            category=category, object_ids=object_ids, message=combined_message
+            category="Clash", object_ids=all_clashing_objects, message=str(group_number)
         )
 
     return clashes

Geometry/mesh.py

@@ -88,8 +88,13 @@ def speckle_mesh_to_trimesh(input_mesh: SpeckleMesh) -> trimesh.Trimesh:
 
     t_mesh = trimesh.Trimesh(vertices=vertices, faces=np.array(faces))
 
-    obbox = t_mesh.bounding_box_oriented
+    return t_mesh
 
-    obbox_mesh = obbox.to_mesh()
+    # code below speeds up the process but is not used in the current implementation.
+    # Bounding boxes could be used for a 2-pass approach to speed up the process.
 
-    return obbox_mesh
+    # obbox = t_mesh.bounding_box_oriented
+
+    # obbox_mesh = obbox.to_mesh()
+
+    # return obbox_mesh

LICENSE

@@ -0,0 +1,208 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 AEC Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
+   NOTICE: Unless otherwise described, the code in this repository is 
+   licensed under the license above. Some modules, extensions or code herein 
+   might be otherwise licensed. This is indicated either in the root of the 
+   containing folder under a different license file, or in the respective 
+   file's header. If you have any questions, don't hesitate to get in touch 
+   with us via [email](mailto:hello@speckle.systems).

README.md

@@ -3,7 +3,13 @@
 # Speckle Automate Function: Basic Clash Analysis Demo
 
 ## Overview
-This repository hosts the Basic Clash Analysis Demo for Speckle Automate, tailored for the AEC industry. It demonstrates automated clash detection using complex third-party libraries to analyze elements from both a static reference model and a dynamic model.
+This repository hosts the Basic Clash Analysis Demo for Speckle Automate, which is tailored for the AEC industry. It demonstrates automated clash detection using complex third-party libraries to analyze elements from static and dynamic reference models.
+
+<img src="https://github.com/specklesystems/speckle_automate-basic_clash_demo/assets/760691/b4df8124-e859-4fca-bdda-7bdcecd9f81b" height="159px" title="Clash Detected!">
+<img src="https://github.com/specklesystems/speckle_automate-basic_clash_demo/assets/760691/3672947a-3e22-490d-b0a2-070384ca88d7" height="150px" title="Location in Context">
+<img height="150" alt="Screenshot 2023-11-13 222423" src="https://github.com/specklesystems/speckle_automate-basic_clash_demo/assets/760691/9b0c8006-3ea9-4b96-8c23-01fb136131c5">
+<img height="150" alt="Screenshot 2023-11-13 222407" src="https://github.com/specklesystems/speckle_automate-basic_clash_demo/assets/760691/a40150b1-97bb-4b49-964e-89d4f2f55b6a">
+<img src="https://github.com/specklesystems/speckle_automate-basic_clash_demo/assets/760691/c5472806-651e-461e-b902-fb93536ab8ab" height="150px" title="Runs on every Publisj Event">
 
 ## ⚠️ Disclaimer: Conceptual Demonstration Only
 **IMPORTANT: This function is a conceptual model and is not intended for actual use in production environments. It serves as a demonstration to illustrate automated clash detection principles in Speckle Automate and the use of third-party libraries for advanced analysis.**

main.py

@@ -2,6 +2,8 @@
 
 use the automation_context module to wrap your function in an Automate context helper
 """
+
+from collections import defaultdict
 from typing import Optional
 
 from pydantic import Field
@@ -43,19 +45,22 @@ class FunctionInputs(AutomateBase):
         Negative values relaxes the test, positive values make it more strict.",
         json_schema_extra={
             "readOnly": True,
-        }
+        },
     )
     tolerance_unit: str = Field(  # Using the SpecklePy Units enum here
         default=Units.mm,
-        json_schema_extra={"examples": ["mm", "cm", "m"], "readOnly": True},
         title="Tolerance Unit",
         description="Unit of the tolerance value.",
+        json_schema_extra={
+          "examples": ["mm", "cm", "m"], 
+          "readOnly": True
+        },
     )
 
 
 def automate_function(
-        automate_context: AutomationContext,
-        function_inputs: FunctionInputs,
+    automate_context: AutomationContext,
+    function_inputs: FunctionInputs,
 ) -> None:
     """This is an example Speckle Automate function.
 
@@ -70,10 +75,12 @@ def automate_function(
     changed_model_version = automate_context.receive_version()
 
     try:
-        reference_model_version, reference_model_id, reference_model_version_id = get_reference_model(
-            automate_context, function_inputs.static_model_name
+        reference_model_version, reference_model_id, reference_model_version_id = (
+            get_reference_model(automate_context, function_inputs.static_model_name)
+        )
+        print(
+            f"Reference model id: {reference_model_id}, version id: {reference_model_version_id}"
         )
-        print(f"Reference model id: {reference_model_id}, version id: {reference_model_version_id}")
 
     except Exception as ex:
         automate_context.mark_run_failed(status_message=str(ex))
@@ -99,6 +106,8 @@ def automate_function(
         "Objects.BuiltElements.Duct",
         "Objects.BuiltElements.Duct:Objects.BuiltElements.Revit.RevitDuct",
         "Objects.BuiltElements.Duct:Objects.BuiltElements.Revit.RevitDuct:Objects.BuiltElements.Revit.RevitFlexDuct",
+        "Objects.Other.Revit.RevitInstance:Objects.BuiltElements.Revit.RevitMEPFamilyInstance",
+        "Objects.BuiltElements.Revit.RevitElementType:Objects.BuiltElements.Revit.RevitSymbolElementType"
     ]
 
     visible_beams_rule = element_rules.rule_combiner(
@@ -132,30 +141,31 @@ def automate_function(
 
     tolerance = function_inputs.tolerance
 
+    if len(reference_mesh_elements) == 0 or len(latest_mesh_elements) == 0:
+        automate_context.mark_run_failed(
+            status_message="Clash detection failed. No objects to compare."
+        )
+        return
+
     clashes = detect_and_report_clashes(
         reference_mesh_elements, latest_mesh_elements, tolerance, automate_context
     )
 
     percentage_reference_objects_clashing = (
-            len(set([ref_id for ref_id, latest_id, severity in clashes]))
-            / len(reference_mesh_elements)
-            * 100
+        len(set([ref_id for ref_id, latest_id in clashes]))
+        / len(reference_mesh_elements)
+        * 100
     )
     percentage_latest_objects_clashing = (
-            len(set([latest_id for ref_id, latest_id, severity in clashes]))
-            / len(latest_mesh_elements)
-            * 100
+        len(set([latest_id for ref_id, latest_id in clashes]))
+        / len(latest_mesh_elements)
+        * 100
     )
 
     # all clashes count
     all_objects_count = len(reference_mesh_elements) + len(latest_mesh_elements)
     all_clashes_count = len(clashes)
 
-    print(f"Clash detection report: {all_clashes_count} clashes found between {all_objects_count} objects.")
-
-    print(f"Reference objects: {len([x for x in reference_objects])}.")
-    print(f"Latest objects: {len([x for x in latest_objects])}.")
-
     clash_report_message = (
         f"Clash detection report: {all_clashes_count} clashes found "
         f"between {all_objects_count} objects. "
@@ -175,7 +185,7 @@ def automate_function(
 
 
 def get_reference_model(
-        automate_context: AutomationContext, static_model_name: str
+    automate_context: AutomationContext, static_model_name: str
 ) -> tuple[Base, Optional[str], Optional[str]]:
     # the static reference model will be retrieved from the project using model name stored in the inputs
     speckle_client = automate_context.speckle_client

pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-specklepy = "2.17.11"
+specklepy = "2.17.17"
 trimesh = "^4.0.4"
 pytest = "^7.4.2"
 python-dotenv = "^1.0.0"

tests/test_main.py

@@ -97,8 +97,8 @@ def test_object() -> Base:
 # fixture to mock the AutomationRunData that would be generated by a full Automation Run
 def fake_automation_run_data(request, test_client: SpeckleClient) -> AutomationRunData:
     server_url = request.config.SPECKLE_SERVER_URL
-    project_id = "4f064f09e6"
-    model_id = "5a16cf52af"
+    project_id = "7d8e96669a"
+    model_id = "efeb71387b"
 
     function_name = "Clash Test"
 
@@ -119,7 +119,7 @@ def fake_automation_run_data(request, test_client: SpeckleClient) -> AutomationR
         project_id=project_id,
         model_id=model_id,
         branch_name="main",
-        version_id="861bbab860",
+        version_id="2eb06c1034",
         speckle_server_url=server_url,
         # These ids would be available with a valid registered Automation definition.
         automation_id=automation_id,
@@ -142,7 +142,7 @@ def test_function_run(fake_automation_run_data: AutomationRunData, speckle_token
         context,
         automate_function,
         FunctionInputs(
-            tolerance=0.1, tolerance_unit="mm", static_model_name="structures from revit"
+            tolerance=0.1, tolerance_unit="mm", static_model_name="simple beams"
         ),
     )