docstrings

Author: tomvanmele

src/compas/geometry/__init__.py

@@ -53,10 +53,10 @@
 .. autosummary::
     :toctree: generated/
 
-    aabb
-    aabb_xy
-    obb_numpy
-    obb_xy_numpy
+    bounding_box
+    bounding_box_xy
+    oriented_bounding_box_numpy
+    oriented_bounding_box_xy_numpy
 
 **fitting**
 

src/compas/geometry/algorithms/bbox.py

@@ -10,14 +10,14 @@
 
 
 __all__ = [
-    'aabb',
-    'aabb_xy',
-    'obb_numpy',
-    'obb_xy_numpy',
+    'bounding_box',
+    'bounding_box_xy',
+    'oriented_bounding_box_numpy',
+    'oriented_bounding_box_xy_numpy',
 ]
 
 
-def aabb(points):
+def bounding_box(points):
     """Computes the axis-aligned minimum bounding box of a list of points.
 
     Parameters
@@ -54,7 +54,7 @@ def aabb(points):
             (min_x, max_y, max_z)]
 
 
-def aabb_xy(points):
+def bounding_box_xy(points):
     """Compute the axis-aligned minimum bounding box of a list of points in the XY-plane.
 
     Note
@@ -89,7 +89,7 @@ def aabb_xy(points):
             (min_x, max_y, 0.0)]
 
 
-def obb_numpy(points):
+def oriented_bounding_box_numpy(points):
     """Compute the oriented minimum bounding box of a set of points in 3D space.
 
     Note
@@ -122,7 +122,7 @@ def obb_numpy(points):
         from compas.plotters import create_axes_3d
         from compas.geometry import rotation_matrix
         from compas.geometry import transform
-        from compas.geometry import obb_numpy
+        from compas.geometry import oriented_bounding_box_numpy
 
         clouds = []
 
@@ -167,7 +167,7 @@ def obb_numpy(points):
         bounds.plot(axes)
 
         for cloud in clouds:
-            bbox = obb_numpy(cloud)
+            bbox = oriented_bounding_box_numpy(cloud)
 
             Cloud3D(cloud).plot(axes)
             Box(bbox[1]).plot(axes)
@@ -224,7 +224,7 @@ def obb_numpy(points):
     return hull, bbox, volume
 
 
-def obb_xy_numpy(points):
+def oriented_bounding_box_xy_numpy(points):
     """Compute the oriented minimum bounding box of set of points in the XY plane.
 
     Note

src/compas/numerical/algorithms/drx_numpy.py

@@ -60,14 +60,28 @@ def drx_numpy(network, factor=1.0, tol=0.1, steps=10000, refresh=0, update=False
         from compas.numerical import drx_numpy
         from compas.utilities import i_to_rgb
 
-        network = Network.from_obj(compas.get('lines.obj'))
-        network.update_default_vertex_attributes({'is_fixed': False, 'P': [1, 1, 0]})
-        network.update_default_edge_attributes({'E': 10, 'A': 1, 'ct': 't'})
-        network.set_vertices_attributes(network.leaves(), {'B': [0, 0, 0], 'is_fixed': True})
+        from numpy import linspace
 
-        drx_numpy(network=network, tol=0.001, refresh=5, update=True)
+        L0 = 1
+        L = 1.5
+        n = 40
+        EI = 0.2
+        pins = [0, 5, 20, n - 5]
 
-        plotter = NetworkPlotter(network)
+        # Network
+
+        vertices = [[i, i, 0] for i in list(linspace(0, L0, n))]
+        edges = [[i, i + 1] for i in range(n - 1)]
+
+        network = Network.from_vertices_and_edges(vertices=vertices, edges=edges)
+        network.update_default_vertex_attributes({'is_fixed': False, 'P': [1, -2, 0], 'EIx': EI, 'EIy': EI})
+        network.update_default_edge_attributes({'E': 50, 'A': 1, 'l0': L / n})
+        network.set_vertices_attributes(pins, {'B': [0, 0, 0], 'is_fixed': True})
+        network.beams = {'beam': {'nodes': list(range(n))}}
+
+        # Plotter
+
+        plotter = NetworkPlotter(network, figsize=(10, 7))
         lines = []
         for u, v in network.edges():
             lines.append({
@@ -76,13 +90,12 @@ def drx_numpy(network, factor=1.0, tol=0.1, steps=10000, refresh=0, update=False
                 'color': '#cccccc',
                 'width': 1.0})
         plotter.draw_lines(lines)
-        plotter.draw_vertices(facecolor={key: '#ff0000' for key in network.vertices_where({'is_fixed': True})})
+        plotter.draw_vertices(radius=0.005, facecolor={key: '#ff0000' for key in network.vertices_where({'is_fixed': True})})
+        plotter.draw_edges()
 
-        fmax = max(network.get_edges_attribute('f'))
+        # Solver
 
-        plotter.draw_edges(
-            color={(u, v): i_to_rgb(attr['f'] / fmax) for u, v, attr in network.edges(True)},
-            width={(u, v): 10 * attr['f'] / fmax for u, v, attr in network.edges(True)})
+        drx_numpy(network=network, tol=0.01, refresh=10, factor=30, update=True)
 
         plotter.show()
 

src/compas/topology/traversal.py

@@ -111,12 +111,14 @@ def depth_first_tree(adjacency, root):
 
     Example
     -------
-    .. code-block:: python
+    .. plot::
+        :include-source:
 
         import compas
         from compas.datastructures import Mesh
         from compas.plotters import MeshPlotter
         from compas.topology import depth_first_tree
+        from compas.utilities import pairwise
 
         mesh = Mesh.from_obj(compas.get('faces.obj'))
 
@@ -145,7 +147,7 @@ def depth_first_tree(adjacency, root):
 
         plotter = MeshPlotter(mesh, figsize=(10, 7))
 
-        plotter.draw_vertices(text='key', facecolor={key: '#ff0000' for key in (root, )}, radius=0.2)
+        plotter.draw_vertices(text='key', facecolor={root: '#ff0000'}, radius=0.2)
         plotter.draw_edges(color=edgecolor, width=edgewidth)
 
         plotter.show()

src/compas/topology/triangulation.py

@@ -6,7 +6,7 @@
 from compas.geometry import centroid_points
 from compas.geometry import distance_point_point
 from compas.geometry import add_vectors
-from compas.geometry import aabb
+from compas.geometry import bounding_box
 
 from compas.geometry import is_point_in_polygon_xy
 from compas.geometry import is_point_in_triangle_xy
@@ -82,7 +82,7 @@ def delaunay_from_points(points, boundary=None, holes=None, tiny=1e-12):
 
     def super_triangle(coords):
         centpt = centroid_points(coords)
-        bbpts  = aabb(coords)
+        bbpts  = bounding_box(coords)
         dis    = distance_point_point(bbpts[0], bbpts[2])
         dis    = dis * 300
         v1     = (0 * dis, 2 * dis, 0)
@@ -389,7 +389,7 @@ def trimesh_remesh(mesh,
 
     References
     ----------
-    * Botsch, M. & Kobbelt, L., 2004. A remeshing approach to multiresolution modeling.
+    * Botsch, M. & Koriented_bounding_boxelt, L., 2004. A remeshing approach to multiresolution modeling.
       Proceedings of the 2004 Eurographics/ACM SIGGRAPH symposium on Geometry processing - SGP '04, p.185.
       Available at: http://portal.acm.org/citation.cfm?doid=1057432.1057457