Revised 25.2 ACP API text & added figure

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.direction_arrows.md

@@ -7,6 +7,6 @@
 Direction arrows of the ply.
 
 * **Parameters:**
-  - arrow_length: Length of the arrow.
-  - arrow_type: ‘standard_arrow’ (default), ‘no_arrow’, ‘half_arrow’.
-  - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’.
+  - arrow_length: Length of the arrow
+  - arrow_type: `standard_arrow` (default), `no_arrow`, `half_arrow`
+  - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset`

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.enabled.md

@@ -4,4 +4,4 @@
 
 #### *property* AnalysisPly.enabled
 
-Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post.
+Whether this object is currently enabled or not. Mainly defined through the current application mode.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.find_parent.md

@@ -4,5 +4,5 @@
 
 #### AnalysisPly.find_parent(type)
 
-Function steps up the tree and returns the first parent with given type.
+Steps up the tree and returns the first parent with given type.
 If object has no parent of this type, the function returns None.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_dict_item.md

@@ -4,4 +4,4 @@
 
 #### *property* AnalysisPly.is_dict_item
 
-Specifies wether the object is an item of a dict
+Specifies whether the object is an item of a dict

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_list_item.md

@@ -4,4 +4,4 @@
 
 #### *property* AnalysisPly.is_list_item
 
-Specifies wether the object is an item of a list
+Specifies whether the object is an item of a list

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.is_reinforcing.md

@@ -6,5 +6,5 @@
 
 True if the AnalysisPly is a reinforcing ply.
 
-For instance, if linked to a Layup Mapping object of type “reinforcing” or
-to an Imported Solid Model via a Mapping Object of type “reinforcing”.
+For instance, if linked to a Layup Mapping object of type `reinforcing` or
+to an Imported Solid Model via a Mapping Object of type `reinforcing`.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.md

@@ -4,45 +4,45 @@
 
 ### *class* compolyx.AnalysisPly(graph, obj, parent=None)
 
-ComPoLyX Class to represent analysis ply.
+ComPoLyX class to represent analysis ply.
 
 ### Attributes
 
 | Name | Description |
 |---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
-| [`AnalysisPly.active`](compolyx.AnalysisPly.active.md#compolyx.AnalysisPly.active)                                        | Sequence Entity is active                                                          |
-| [`AnalysisPly.active_in_post_mode`](compolyx.AnalysisPly.active_in_post_mode.md#compolyx.AnalysisPly.active_in_post_mode) | True if failure criteria will be processed for this ply.                           |
-| [`AnalysisPly.angle`](compolyx.AnalysisPly.angle.md#compolyx.AnalysisPly.angle)                                           | Ply Angle of the Analysis Ply                                                      |
-| [`AnalysisPly.draping_obj`](compolyx.AnalysisPly.draping_obj.md#compolyx.AnalysisPly.draping_obj)                         | Get the Fiber Directions of the Analysis Ply                                       |
-| [`AnalysisPly.enabled`](compolyx.AnalysisPly.enabled.md#compolyx.AnalysisPly.enabled)                                     | Whether this object is currently enabled or not.                                   |
+| [`AnalysisPly.active`](compolyx.AnalysisPly.active.md#compolyx.AnalysisPly.active)                                        | Sequence entity is active                                                          |
+| [`AnalysisPly.active_in_post_mode`](compolyx.AnalysisPly.active_in_post_mode.md#compolyx.AnalysisPly.active_in_post_mode) | True if failure criteria will be processed for this ply                           |
+| [`AnalysisPly.angle`](compolyx.AnalysisPly.angle.md#compolyx.AnalysisPly.angle)                                           | Ply Angle of the analysis ply                                                      |
+| [`AnalysisPly.draping_obj`](compolyx.AnalysisPly.draping_obj.md#compolyx.AnalysisPly.draping_obj)                         | Get the fiber directions of the analysis ply                                       |
+| [`AnalysisPly.enabled`](compolyx.AnalysisPly.enabled.md#compolyx.AnalysisPly.enabled)                                     | Whether this object is currently enabled or not                                   |
 | [`AnalysisPly.id`](compolyx.AnalysisPly.id.md#compolyx.AnalysisPly.id)                                                    | ID of object                                                                       |
-| [`AnalysisPly.is_dict_item`](compolyx.AnalysisPly.is_dict_item.md#compolyx.AnalysisPly.is_dict_item)                      | Specifies wether the object is an item of a dict                                   |
-| [`AnalysisPly.is_list_item`](compolyx.AnalysisPly.is_list_item.md#compolyx.AnalysisPly.is_list_item)                      | Specifies wether the object is an item of a list                                   |
+| [`AnalysisPly.is_dict_item`](compolyx.AnalysisPly.is_dict_item.md#compolyx.AnalysisPly.is_dict_item)                      | Specifies whether the object is an item of a dict                                   |
+| [`AnalysisPly.is_list_item`](compolyx.AnalysisPly.is_list_item.md#compolyx.AnalysisPly.is_list_item)                      | Specifies whether the object is an item of a list                                   |
 | [`AnalysisPly.link_path`](compolyx.AnalysisPly.link_path.md#compolyx.AnalysisPly.link_path)                               | Root path of the current node in the tree for links to this object                 |
-| [`AnalysisPly.material`](compolyx.AnalysisPly.material.md#compolyx.AnalysisPly.material)                                  | Ply Material of the Analysis Ply                                                   |
-| [`AnalysisPly.mesh`](compolyx.AnalysisPly.mesh.md#compolyx.AnalysisPly.mesh)                                              | Mesh.                                                                              |
+| [`AnalysisPly.material`](compolyx.AnalysisPly.material.md#compolyx.AnalysisPly.material)                                  | Ply material of the analysis ply                                                   |
+| [`AnalysisPly.mesh`](compolyx.AnalysisPly.mesh.md#compolyx.AnalysisPly.mesh)                                              | Mesh                                                                              |
 | [`AnalysisPly.name`](compolyx.AnalysisPly.name.md#compolyx.AnalysisPly.name)                                              | Name of object                                                                     |
 | [`AnalysisPly.parent`](compolyx.AnalysisPly.parent.md#compolyx.AnalysisPly.parent)                                        | Parent object in tree                                                              |
-| [`AnalysisPly.ply_material`](compolyx.AnalysisPly.ply_material.md#compolyx.AnalysisPly.ply_material)                      | Ply Material of the Analysis Ply                                                   |
+| [`AnalysisPly.ply_material`](compolyx.AnalysisPly.ply_material.md#compolyx.AnalysisPly.ply_material)                      | Ply material of the analysis ply                                                   |
 | [`AnalysisPly.root_path`](compolyx.AnalysisPly.root_path.md#compolyx.AnalysisPly.root_path)                               | Root path of the current node in the tree                                          |
 | [`AnalysisPly.status`](compolyx.AnalysisPly.status.md#compolyx.AnalysisPly.status)                                        | Status of the object                                                               |
-| [`AnalysisPly.status_changed`](compolyx.AnalysisPly.status_changed.md#compolyx.AnalysisPly.status_changed)                | Boolean flag which is set to true in C++ when up-to-date status of object changes. |
-| [`AnalysisPly.thickness`](compolyx.AnalysisPly.thickness.md#compolyx.AnalysisPly.thickness)                               | Thickness of the Analysis Ply                                                      |
+| [`AnalysisPly.status_changed`](compolyx.AnalysisPly.status_changed.md#compolyx.AnalysisPly.status_changed)                | Boolean flag which is set to true in C++ when up-to-date status of object changes |
+| [`AnalysisPly.thickness`](compolyx.AnalysisPly.thickness.md#compolyx.AnalysisPly.thickness)                               | Thickness of the analysis ply                                                      |
 | [`AnalysisPly.uid`](compolyx.AnalysisPly.uid.md#compolyx.AnalysisPly.uid)                                                 | UID of object                                                                      |
-| [`AnalysisPly.vertex`](compolyx.AnalysisPly.vertex.md#compolyx.AnalysisPly.vertex)                                        | This will throw an error if the object has been removed from the graph.            |
+| [`AnalysisPly.vertex`](compolyx.AnalysisPly.vertex.md#compolyx.AnalysisPly.vertex)                                        | Throws an error if the object has been removed from the graph            |
 
 ### Methods
 
 | Name | Description |
 |---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
 | [`AnalysisPly.boundaries`](compolyx.AnalysisPly.boundaries.md#compolyx.AnalysisPly.boundaries)([offset_type])                         |                                                                                                                              |
-| [`AnalysisPly.direction_arrows`](compolyx.AnalysisPly.direction_arrows.md#compolyx.AnalysisPly.direction_arrows)([arrow_length, ...]) | Direction arrows of the ply.                                                                                                 |
-| [`AnalysisPly.find_parent`](compolyx.AnalysisPly.find_parent.md#compolyx.AnalysisPly.find_parent)(type)                               | Function steps up the tree and returns the first parent with given type.                                                     |
+| [`AnalysisPly.direction_arrows`](compolyx.AnalysisPly.direction_arrows.md#compolyx.AnalysisPly.direction_arrows)([arrow_length, ...]) | Direction arrows of the ply                                                                                                 |
+| [`AnalysisPly.find_parent`](compolyx.AnalysisPly.find_parent.md#compolyx.AnalysisPly.find_parent)(type)                               | Steps up the tree and returns the first parent with given type                                                     |
 | [`AnalysisPly.get_short_description`](compolyx.AnalysisPly.get_short_description.md#compolyx.AnalysisPly.get_short_description)()     |                                                                                                                              |
-| [`AnalysisPly.is_reinforcing`](compolyx.AnalysisPly.is_reinforcing.md#compolyx.AnalysisPly.is_reinforcing)()                          | True if the AnalysisPly is a reinforcing ply.                                                                                |
-| [`AnalysisPly.obj_exists`](compolyx.AnalysisPly.obj_exists.md#compolyx.AnalysisPly.obj_exists)()                                      | Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND exists in the graph. |
+| [`AnalysisPly.is_reinforcing`](compolyx.AnalysisPly.is_reinforcing.md#compolyx.AnalysisPly.is_reinforcing)()                          | True if the AnalysisPly is a reinforcing ply                                                                                |
+| [`AnalysisPly.obj_exists`](compolyx.AnalysisPly.obj_exists.md#compolyx.AnalysisPly.obj_exists)()                                      | Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and exists in the graph |
 | [`AnalysisPly.serialize`](compolyx.AnalysisPly.serialize.md#compolyx.AnalysisPly.serialize)()                                         |                                                                                                                              |
-| [`AnalysisPly.serialize_name_and_id`](compolyx.AnalysisPly.serialize_name_and_id.md#compolyx.AnalysisPly.serialize_name_and_id)()     | Helper function to serialize name and ID.                                                                                    |
-| [`AnalysisPly.update`](compolyx.AnalysisPly.update.md#compolyx.AnalysisPly.update)()                                                  | Update the analysis ply.                                                                                                     |
-| [`AnalysisPly.visit`](compolyx.AnalysisPly.visit.md#compolyx.AnalysisPly.visit)(visitor)                                              | Walk through the tree and let the visitor perform action on every descendant node.                                           |
-| [`AnalysisPly.write_boundaries`](compolyx.AnalysisPly.write_boundaries.md#compolyx.AnalysisPly.write_boundaries)(filename[, ...])     | Write boundaries in .iges/.step format.                                                                                      |
+| [`AnalysisPly.serialize_name_and_id`](compolyx.AnalysisPly.serialize_name_and_id.md#compolyx.AnalysisPly.serialize_name_and_id)()     | Helper function to serialize name and ID                                                                                    |
+| [`AnalysisPly.update`](compolyx.AnalysisPly.update.md#compolyx.AnalysisPly.update)()                                                  | Update the analysis ply                                                                                                     |
+| [`AnalysisPly.visit`](compolyx.AnalysisPly.visit.md#compolyx.AnalysisPly.visit)(visitor)                                              | Walk through the tree and let the visitor perform an action on every descendant node                                          |
+| [`AnalysisPly.write_boundaries`](compolyx.AnalysisPly.write_boundaries.md#compolyx.AnalysisPly.write_boundaries)(filename[, ...])     | Write boundaries in .iges/.step format                                                                                      |

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.mesh.md

@@ -4,4 +4,4 @@
 
 #### *property* AnalysisPly.mesh
 
-Mesh. Only available if analysis plyis reinforcement
+Mesh. Only available if analysis ply is reinforced.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.obj_exists.md

@@ -4,5 +4,5 @@
 
 #### AnalysisPly.obj_exists()
 
-Checks if \_\_obj still references the c++ object (i.e. has not been reset to None by self._delete) AND
+Checks if \_\_obj still references the C++ object (i.e. has not been reset to None by self._delete) and
 exists in the graph.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.visit.md

@@ -9,7 +9,7 @@ descendant node.
 
 * **Parameters:**
 
-- visitor: A callable which accepts a TreeNode instance as parameter
-
-Returns True if the visitor returned True for at least one descendant/linked node.
+    - visitor: A callable which accepts a TreeNode instance as parameter
+* **Returns:**
+    - True if the visitor returned True for at least one descendant/linked node.
 If this is the case, the tree traversal is pruned.

2025R2/ACP_25R2_md/_autosummary/compolyx.AnalysisPly.write_boundaries.md

@@ -7,9 +7,9 @@
 Write boundaries in .iges/.step format.
 
 * **Parameters:**
-  - filename: Output file.
-  - format: ‘iges’, ‘step’, None (automatic format recognition).
-  - offset_type: ‘no_offset’ (default), ‘bottom_offset’, ‘middle_offset’, ‘top_offset’.
-  - with_direction_arrows: The element directions should be written to.
-  - arrow_length: Length of the direction arrows (default is average element edge size).
-  - arrow_type: Type to be used as arrows (‘standard_arrow’ (default), ‘no_arrow’, ‘half_arrow’).
+  - filename: Output file
+  - format: `iges`, `step`, `None` (automatic format recognition)
+  - offset_type: `no_offset` (default), `bottom_offset`, `middle_offset`, `top_offset`
+  - with_direction_arrows: The element directions should be written to
+  - arrow_length: Length of the direction arrows (default is average element edge size)
+  - arrow_type: Type to be used as arrows (`standard_arrow` (default), `no_arrow`, `half_arrow`)

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.active.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.active
 
-active status of object
+Active status of object

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.add_rule.md

@@ -10,7 +10,7 @@ Add selection rule to boolean selection rule.
   - rule: The rule to be added.
   - template_rule: Whether this is a template rule.
   - rule_values: Parameters of the template rule (for instance, the upper and lower limits of a ParallelSelectionRule).
-  - operation_type: Boolean operation type (intersect, add, remove).
+  - operation_type: Boolean operation type (`intersect`, `add`, `remove`).
 
 Example:
 >>> boolean_rule.add_rule(rule=model.selection_rules[‘ParallelRule.1’],template_rule=True, rule_values=(-20.0, 50.0), operation_type=’intersect’)

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.enabled.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.enabled
 
-Whether this object is currently enabled or not. Mainly defined through the current application mode pre or post.
+Whether this object is currently enabled or not. Mainly defined through the current application mode.

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.extent.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.extent
 
-extent of the rule
+Extent of the rule

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.include_rule_type.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.include_rule_type
 
-include type
+Include type

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_dict_item.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.is_dict_item
 
-Specifies wether the object is an item of a dict
+Specifies whether the object is an item of a dict

2025R2/ACP_25R2_md/_autosummary/compolyx.BooleanSelectionRule.is_list_item.md

@@ -4,4 +4,4 @@
 
 #### *property* BooleanSelectionRule.is_list_item
 
-Specifies wether the object is an item of a list
+Specifies whether the object is an item of a list