BlockResearchGroup · tomvanmele · Feb 26, 2024 · Feb 18, 2024 · Feb 18, 2024 · Feb 18, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,39 +9,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-* Added `requirements-dev` added shapely library
-* Added `compas_model.model.group_node.GroupNode` create a group node that has an attribute of _my_object that is stored in the node Attributes, check the serialization, there must be a property _my_object that refers to the attribute. Try this class from the compas2 Tree implementation.
-* Added `compas_model.model.group_node.ElementNode` same description as for the group_node, but this type the class works with elements only
-* Added `compas_model.model.model.Model` bring the code from the assembly
-* Added `compas_model.model.element_tree.ElementTree` bring the code from the assembly
-* Added tutorials and descriptions in the documentations.
-* Added `compas_model.model.algorithms.collider` class for closest object queries.
-* Added data-sets of robots and timber beams.
+* Added `compas_model.model.Model`.
+* Added `compas_model.model.ElementNode`.
+* Added `compas_model.model.GroupNode`.
+* Added `compas_model.model.ElementTree`.
+* Added `compas_model.model.InteractionGraph`.
+* Added `compas_model.elements.Element`.
+* Added `compas_model.elements.Feature`.
+* Added `compas_model.elements.BlockElement`.
+* Added `compas_model.elements.BlockFeature`.
+* Added `compas_model.elements.InterfaceElement`.
+* Added `compas_model.elements.InterfaceFeature`.
+* Added `compas_model.elements.PlateElement`.
+* Added `compas_model.elements.PlateFeature`.
+* Added `compas_model.interactions.Interaction`.
+* Added `compas_model.algorithms.collider`.
+* Added `compas_model.scene.ElementObject`.
+* Added `compas_model.rhino.scene.RhinoBlockObject`.
+* Added `compas_model.notebook.scene.ThreeBlockObject`.
 
 ### Changed
 
-* Elements classes are refactored to have as minimal representation as possible.
-* Preparation of the repository for pull requests by removing all element classes.
-* Contents of `compas_model.elements.Element` is removed.
-* Changed all properties are documented following compas format.
-* Changed `compas_model.model.element_node.ElementNode` serialization simplified, without using children property
-* Changed `compas_model.model.group_node.GroupNode` added `name` public and private properties and removed private properties as much as possible for internal methods
-* Changed `compas_model.model.element_tree.ElementTree.` serialization is divided into two parts: a) branch `GroupNode` and b) leaf `ElementNode`, this is information is given `children` property.
-* Changed `__eq__` to `GroupNode` by `name` instead of by `guid` for the future `Merge` method, when names of the branches are matched.
-* Changed `parent` property from `None` to parent object in the `compas_mode.model.ElemenTree`
-* Changed `all` general docstring formatting issues
-* Changed `compas_model.model.element_node.ElementNode` property `my_object` is changed to `Element`
-* Changed `compas_model.model.group_node.GroupNode` property `my_object` is changed to `geometry`
-* Changed `compas_model.model.element_tree.ElementTree.` serialization method `from_data` check if node has not children and creates as a result different node type, instead of `my_object`
-* Changed `test_model` function `create_model` by adding more nodes at leaves to really check if the serialization works.
-* Changed `test_model` face_polygons are computed from box corners.
-* Changed `compas_model.model.algorithms.collider` is defined as methods instead of a static class.
-* Changed the folder structure of elements is flatenned.
-* Contents of `compas_model.elements.Element` child classes transformation methods changed to handle the scaling of oriented bounding box.
-* Changed clean up of the documentation.
-* Changed complete refactoring of the model data-structure by introducing the InteractionGraph and Interaction classes.
-
 ### Removed
-
-* Removed `__eq__` operator in the `ElementNode`, equality must be checked only for `GroupNode`
-* Removed `fabrication` and `structure` properties from the `compas_model.elements.Element`
diff --git a/src/compas_model/elements/beam_element.py → __temp/beam.py b/src/compas_model/elements/beam_element.py → __temp/beam.py
@@ -2,22 +2,23 @@
 from __future__ import absolute_import
 from __future__ import division
 
+from compas.tolerance import TOL
+
 from compas.geometry import Point
-from compas.geometry import add_vectors
 from compas.geometry import Box
 from compas.geometry import Polygon
 from compas.geometry import Vector
 from compas.geometry import Frame
 from compas.geometry import Line
+from compas.geometry import add_vectors
 from compas.geometry import cross_vectors
-from compas.datastructures import Mesh
 from compas.geometry import angle_vectors
-from compas.tolerance import Tolerance
+from compas.datastructures import Mesh
 from compas_model.elements.element import Element
 
 
 class BeamElement(Element):
-    """A beam representation of a Line and a Box.
+    """Class representing a beam element.
 
     Parameters
     ----------
@@ -67,11 +68,11 @@ class BeamElement(Element):
 
     @property
     def __data__(self) -> dict:
-        base_data = super().__data__  # not to repeat the same code for base properties
-        base_data["length"] = self.geometry.depth
-        base_data["width"] = self.geometry.width
-        base_data["height"] = self.geometry.height
-        return base_data
+        data = super(BeamElement, self).__data__
+        data["length"] = self.geometry.depth
+        data["width"] = self.geometry.width
+        data["height"] = self.geometry.height
+        return data
 
     @classmethod
     def __from_data__(cls, data):

diff --git a/src/compas_model/scene/blockobject.py → __temp/blockobject.py b/src/compas_model/scene/blockobject.py → __temp/blockobject.py
diff --git a/src/compas_model/elements/plate_element.py → __temp/plate.py b/src/compas_model/elements/plate_element.py → __temp/plate.py
diff --git a/docs/api.rst b/docs/api.rst
@@ -6,5 +6,10 @@ API Reference
     :maxdepth: 1
     :titlesonly:
 
-    api/compas_model.model
+    api/compas_model.algorithms
     api/compas_model.elements
+    api/compas_model.interactions
+    api/compas_model.model
+    api/compas_model.notebook
+    api/compas_model.rhino
+    api/compas_model.scene
diff --git a/docs/acknowledgements.rst → docs/api/compas_model.algorithms.rst b/docs/acknowledgements.rst → docs/api/compas_model.algorithms.rst
@@ -1,6 +1,12 @@
 ********************************************************************************
-Acknowledgements
+compas_model.algorithms
 ********************************************************************************
 
-Authors of this package: Petras Vestartas, Tom van Mele.
-Block research group, ETH Zurich, Switzerland.
+.. currentmodule:: compas_model.algorithms
+
+Functions
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
diff --git a/docs/api/compas_model.elements.rst b/docs/api/compas_model.elements.rst
@@ -11,8 +11,7 @@ Classes
     :toctree: generated/
     :nosignatures:
 
-    Element
     BlockElement
-    BeamElement
-    InterfaceElement
-    PlateElement
+    BlockFeature
+    Element
+    Feature
diff --git a/docs/api/compas_model.interactions.rst b/docs/api/compas_model.interactions.rst
@@ -0,0 +1,15 @@
+********************************************************************************
+compas_model.interactions
+********************************************************************************
+
+.. currentmodule:: compas_model.interactions
+
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Interaction
diff --git a/docs/api/compas_model.model.rst b/docs/api/compas_model.model.rst
@@ -11,8 +11,8 @@ Classes
     :toctree: generated/
     :nosignatures:
 
-    Model
     ElementNode
     ElementTree
+    GroupNode
     InteractionGraph
-    Interaction
+    Model
diff --git a/docs/api/compas_model.notebook.rst b/docs/api/compas_model.notebook.rst
@@ -0,0 +1,23 @@
+********************************************************************************
+compas_model.notebook
+********************************************************************************
+
+.. currentmodule:: compas_model.notebook
+
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    ThreeBlockObject
+
+
+Functions
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
diff --git a/docs/api/compas_model.rhino.rst b/docs/api/compas_model.rhino.rst
@@ -0,0 +1,23 @@
+********************************************************************************
+compas_model.rhino
+********************************************************************************
+
+.. currentmodule:: compas_model.rhino
+
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    RhinoBlockObject
+
+
+Functions
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
diff --git a/docs/api/compas_model.scene.rst b/docs/api/compas_model.scene.rst
@@ -0,0 +1,15 @@
+********************************************************************************
+compas_model.scene
+********************************************************************************
+
+.. currentmodule:: compas_model.scene
+
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    ElementObject
diff --git a/docs/examples/element.ipynd → docs/examples/PLACEHOLDER b/docs/examples/element.ipynd → docs/examples/PLACEHOLDER
diff --git a/src/compas_model/blender/__init__.py → docs/examples/__temp/element.ipynd b/src/compas_model/blender/__init__.py → docs/examples/__temp/element.ipynd
diff --git a/docs/examples/element.py → docs/examples/__temp/element.py b/docs/examples/element.py → docs/examples/__temp/element.py
diff --git a/docs/examples/elements_beam.py → docs/examples/__temp/elements_beam.py b/docs/examples/elements_beam.py → docs/examples/__temp/elements_beam.py
diff --git a/docs/examples/elements_beam.rst → docs/examples/__temp/elements_beam.rst b/docs/examples/elements_beam.rst → docs/examples/__temp/elements_beam.rst
diff --git a/docs/examples/elements_block.py → docs/examples/__temp/elements_block.py b/docs/examples/elements_block.py → docs/examples/__temp/elements_block.py
diff --git a/docs/examples/elements_block.rst → docs/examples/__temp/elements_block.rst b/docs/examples/elements_block.rst → docs/examples/__temp/elements_block.rst
diff --git a/docs/examples/elements_interface.py → docs/examples/__temp/elements_interface.py b/docs/examples/elements_interface.py → docs/examples/__temp/elements_interface.py
diff --git a/docs/examples/elements_interface.rst → docs/examples/__temp/elements_interface.rst b/docs/examples/elements_interface.rst → docs/examples/__temp/elements_interface.rst
diff --git a/docs/examples/elements_plate.py → docs/examples/__temp/elements_plate.py b/docs/examples/elements_plate.py → docs/examples/__temp/elements_plate.py
diff --git a/docs/examples/elements_plate.rst → docs/examples/__temp/elements_plate.rst b/docs/examples/elements_plate.rst → docs/examples/__temp/elements_plate.rst
diff --git a/...les/elements_plate_application_folding.py → ...emp/elements_plate_application_folding.py b/...les/elements_plate_application_folding.py → ...emp/elements_plate_application_folding.py
diff --git a/docs/examples/model.py → docs/examples/__temp/model.py b/docs/examples/model.py → docs/examples/__temp/model.py
diff --git a/docs/examples/model_beams.py → docs/examples/__temp/model_beams.py b/docs/examples/model_beams.py → docs/examples/__temp/model_beams.py
diff --git a/docs/examples/model_beams.rst → docs/examples/__temp/model_beams.rst b/docs/examples/model_beams.rst → docs/examples/__temp/model_beams.rst
diff --git a/docs/examples/model_copy_model.py → docs/examples/__temp/model_copy_model.py b/docs/examples/model_copy_model.py → docs/examples/__temp/model_copy_model.py
diff --git a/docs/examples/model_form_finding.rst → docs/examples/__temp/model_form_finding.rst b/docs/examples/model_form_finding.rst → docs/examples/__temp/model_form_finding.rst
diff --git a/docs/examples/model_masonry.py → docs/examples/__temp/model_masonry.py b/docs/examples/model_masonry.py → docs/examples/__temp/model_masonry.py
diff --git a/docs/examples/model_masonry.rst → docs/examples/__temp/model_masonry.rst b/docs/examples/model_masonry.rst → docs/examples/__temp/model_masonry.rst
diff --git a/docs/examples/model_masonry_scene.py → docs/examples/__temp/model_masonry_scene.py b/docs/examples/model_masonry_scene.py → docs/examples/__temp/model_masonry_scene.py
diff --git a/docs/examples/model_plates.py → docs/examples/__temp/model_plates.py b/docs/examples/model_plates.py → docs/examples/__temp/model_plates.py
diff --git a/docs/examples/model_plates.rst → docs/examples/__temp/model_plates.rst b/docs/examples/model_plates.rst → docs/examples/__temp/model_plates.rst
diff --git a/docs/examples/model_robots.py → docs/examples/__temp/model_robots.py b/docs/examples/model_robots.py → docs/examples/__temp/model_robots.py
diff --git a/docs/examples/model_robots.rst → docs/examples/__temp/model_robots.rst b/docs/examples/model_robots.rst → docs/examples/__temp/model_robots.rst
diff --git a/docs/examples/model_serialize_model.py → .../examples/__temp/model_serialize_model.py b/docs/examples/model_serialize_model.py → .../examples/__temp/model_serialize_model.py
diff --git a/docs/examples/model_with_hierarchy.py → docs/examples/__temp/model_with_hierarchy.py b/docs/examples/model_with_hierarchy.py → docs/examples/__temp/model_with_hierarchy.py
diff --git a/docs/examples/model_with_interactions.py → ...xamples/__temp/model_with_interactions.py b/docs/examples/model_with_interactions.py → ...xamples/__temp/model_with_interactions.py
diff --git a/docs/examples/scene_rhino.py → docs/examples/__temp/scene_rhino.py b/docs/examples/scene_rhino.py → docs/examples/__temp/scene_rhino.py
diff --git a/docs/examples/scene_rhino.rst → docs/examples/__temp/scene_rhino.rst b/docs/examples/scene_rhino.rst → docs/examples/__temp/scene_rhino.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,10 +8,8 @@ COMPAS Model
 
 .. rst-class:: lead
 
-
 The COMPAS model encompasses data structures and algorithms for: a) modeling individual elements of Discrete Element Assemblies, b) tracking interactions between them, commonly used for cases such as joinery or abstractly tracking adjacency in the form of a graph, and c) storing the elements in a hierarchical manner, namely a tree data structure. The package itself serves as a fundamental data structure for various modeling or structural applications and is primarily utilized as a container to store and visualize data. The data structure is compatible with COMPAS 2.0 and above.
 
-COMPAS Model is a next generation of `compas_assembly <https://blockresearchgroup.github.io/compas_assembly/0.6.2/>`_ which is based on compas <= 1.17.9.
 
 Table of Contents
 =================
@@ -27,7 +25,6 @@ Table of Contents
    examples
    api
    license
-   acknowledgements
 
 
 Indices and tables

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -16,6 +16,7 @@ Here, we create a simple element using the :class:`Element`. These represent str
     element = BlockElement(Mesh.from_polyhedron(4))
     print(element)
 
+
 Other Types of Elements
 =======================
 
@@ -49,26 +50,6 @@ Create Model
     model.add_element(my_block)
     model.print()
 
-.. We can retrieve the nodes of elements, along with the elements themselves. For example, using the node name(s):
-
-.. .. code-block:: python
-
-..     node = model.get_by_name("my_block")
-..     nodes = model.get_by_names("my_block")
-..     node = model["my_block"]
-
-.. The individual elements are stored in the element attribute:
-
-.. .. code-block:: python
-
-..     node_element = model["my_block"].element
-
-.. Or by the element GUID:
-
-.. .. code-block:: python
-
-..     element = model.elements[my_block.guid]
-
 
 Add Connectivity
 ================
@@ -108,6 +89,7 @@ Add interaction between elements (edge in a Graph).
 
 Print to the data-structure in the console.
 
+
 Add Hierarchy
 =============
 
@@ -150,6 +132,7 @@ Add elements to groups.
 
 Print to the data-structure in the console.
 
+
 Traverse Hierarchy
 ==================