docstring updates

Author: tomvanmele

src/compas/numerical/algorithms/dr.py

@@ -388,7 +388,7 @@ def a(t, V):
     # and define a callback function
     # for plotting the intermediate configurations
 
-    plotter = NetworkPlotter(network, figsize=(10, 6))
+    plotter = NetworkPlotter(network, figsize=(10, 7), fontsize=6)
 
     def callback(k, xyz, crits, args):
         print(k)

src/compas/numerical/algorithms/dr_numpy.py

@@ -400,7 +400,7 @@ def a(t, v):
             'width': 0.5
         })
 
-    plotter = NetworkPlotter(network, figsize=(10, 6))
+    plotter = NetworkPlotter(network, figsize=(10, 7), fontsize=6)
 
     plotter.draw_lines(lines)
     plotter.draw_vertices(facecolor={key: '#000000' for key in network.vertices_where({'is_fixed': True})})

src/compas/numerical/algorithms/drx_hpc.py

@@ -1,5 +1,6 @@
 from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
 
 import sys
 
@@ -43,145 +44,91 @@
 def drx_numpy(network, factor=1.0, tol=0.1, steps=10000, refresh=0, update=False, callback=None, **kwargs):
     """Run dynamic relaxation analysis.
 
-    Parameters:
-        network (obj): Network to analyse.
-        factor (float): Convergence factor.
-        tol (float): Tolerance value.
-        steps (int): Maximum number of steps.
-        refresh (int): Update progress every n steps.
-        update (bool): Update the co-ordinates of the Network.
-        callback (obj): Callback function.
-
-    Returns:
-        array: Vertex co-ordinates.
-        array: Edge forces.
-        array: Edge lengths.
-
-    Example:
-
-        .. plot::
-
-            import compas
-            from compas.datastructures import Network
-            from compas.plotters import NetworkPlotter
-            from compas.numerical import drx_numpy
-            from compas.utilities import i_to_rgb
-
-            from numpy import linspace
-
-            L0 = 1
-            L = 1.5
-            n = 40
-            EI = 0.2
-            pins = [0, 5, 20, n - 5]
-
-            # 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))}}
+    Parameters
+    ----------
+    network : Network
+        Network to analyse.
+    factor : float
+        Convergence factor.
+    tol : float
+        Tolerance value.
+    steps : int
+        Maximum number of steps.
+    refresh : int
+        Update progress every n steps.
+    update : bool
+        Update the co-ordinates of the Network.
+    callback : callable
+        Callback function.
 
-            # Plotter
+    Returns
+    -------
+    tuple
 
-            plotter = NetworkPlotter(network)
+        * array: Vertex co-ordinates.
+        * array: Edge forces.
+        * array: Edge lengths.
 
-            lines = []
-            for u, v in network.edges():
-                lines.append({
-                    'start': network.vertex_coordinates(u, 'xy'),
-                    'end'  : network.vertex_coordinates(v, 'xy'),
-                    'color': '#cccccc',
-                    'width': 1.0})
+    Example
+    -------
+    .. plot::
+        :include-source:
 
-            plotter.draw_lines(lines)
+        import compas
+        from compas.datastructures import Network
+        from compas.plotters import NetworkPlotter
+        from compas.numerical import drx_numpy
+        from compas.utilities import i_to_rgb
 
-            # Solver
+        from numpy import linspace
 
-            drx_numpy(network=network, tol=0.01, refresh=10, factor=30, update=True)
+        L0 = 1
+        L = 1.5
+        n = 40
+        EI = 0.2
+        pins = [0, 5, 20, n - 5]
 
-            # Result
+        # Network
 
-            plotter.draw_vertices(radius=0.005, facecolor={key: '#ff0000' for key in pins})
-            plotter.draw_edges()
+        vertices = [[i, i, 0] for i in list(linspace(0, L0, n))]
+        edges = [[i, i + 1] for i in range(n - 1)]
 
-            plotter.show()
+        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
 
-        .. code-block:: python
+        plotter = NetworkPlotter(network)
 
-            # This code block produces a dynamic visualization
-            # of the figure above using a callback function.
+        lines = []
+        for u, v in network.edges():
+            lines.append({
+                'start': network.vertex_coordinates(u, 'xy'),
+                'end'  : network.vertex_coordinates(v, 'xy'),
+                'color': '#cccccc',
+                'width': 1.0})
 
-            import compas
-            from compas.datastructures import Network
-            from compas.plotters import NetworkPlotter
-            from compas.numerical import drx_numpy
-            from compas.utilities import i_to_rgb
+        plotter.draw_lines(lines)
 
-            from numpy import linspace
+        # Solver
 
-            # Callback
+        drx_numpy(network=network, tol=0.01, refresh=10, factor=30, update=True)
 
-            def plot_iterations(X, radius=0.005):
+        # Result
 
-                for i in network.vertices():
-                    x, y, z = X[i, :]
-                    network.set_vertex_attributes(i, {'x': x, 'y': y, 'z': z})
+        plotter.draw_vertices(radius=0.005, facecolor={key: '#ff0000' for key in pins})
+        plotter.draw_edges()
 
-                plotter.update_vertices(radius)
-                plotter.update_edges()
-                plotter.update(pause=0.01)
+        plotter.show()
 
-            # Setup
-
-            L0 = 1
-            L = 1.5
-            n = 40
-            EI = 0.2
-            pins = [0, 5, 20, n - 5]
-
-            # 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))
-
-            # Initial configuration
-
-            lines = []
-            for u, v in network.edges():
-                lines.append({
-                    'start': network.vertex_coordinates(u, 'xy'),
-                    'end'  : network.vertex_coordinates(v, 'xy'),
-                    'color': '#cccccc',
-                    'width': 1.0})
-
-            plotter.draw_lines(lines)
-            plotter.draw_vertices(radius=0.005, facecolor={key: '#ff0000' for key in pins})
-            plotter.draw_edges()
-
-            # Solver with dynamic visualization
-
-            drx_numpy(network=network, tol=0.01, refresh=10, factor=30, update=True, callback=plot_iterations)
-
-            plotter.show()
+    See Also
+    --------
+    *
 
     """
-
     # Setup
 
     tic1 = time()
@@ -286,7 +233,7 @@ def drx_solver(tol, steps, factor, C, Ct, X, ks, l0, f0, ind_c, ind_t, P, S, B,
             if (ts % refresh == 0) or (res < tol):
                 print('Step:{0} Residual:{1:.3g}'.format(ts, res))
                 if callback:
-                    callback(X, **kwargs)
+                    callback(ts, X, **kwargs)
         ts += 1
     return X, f, l
 
@@ -490,8 +437,8 @@ def _create_arrays(network):
 
     from numpy import linspace
 
-
-    def plot_iterations(X, radius=0.005):
+    def plot_iterations(k, X, radius=0.005):
+        print(k)
 
         for i in network.vertices():
             x, y, z = X[i, :]
@@ -501,7 +448,6 @@ def plot_iterations(X, radius=0.005):
         plotter.update_edges()
         plotter.update(pause=0.01)
 
-
     # ==========================================================================
     # Example 1
     # ==========================================================================

src/compas/numerical/algorithms/drx_numpy.py

@@ -13,7 +13,7 @@
 from compas.geometry import is_point_in_circle_xy
 from compas.geometry import circle_from_points_xy
 
-from compas.geometry import smooth_area
+from compas.geometry import mesh_smooth_area
 
 from compas.topology import mesh_dual
 
@@ -525,16 +525,7 @@ def trimesh_remesh(mesh,
             if allow_boundary_split:
                 boundary  = set(mesh.vertices_on_boundary())
 
-            vertices  = {key: mesh.vertex_coordinates(key) for key in mesh.vertices()}
-            faces     = {fkey: mesh.face_vertices(fkey) for fkey in mesh.faces()}
-            adjacency = {key: mesh.vertex_faces(key) for key in mesh.vertices()}
-
-            smooth_area(vertices, faces, adjacency, fixed=fixed.union(boundary), kmax=1)
-
-            for key, attr in mesh.vertices(True):
-                attr['x'] = vertices[key][0]
-                attr['y'] = vertices[key][1]
-                attr['z'] = vertices[key][2]
+            mesh_smooth_area(mesh, fixed=fixed.union(boundary), kmax=1)
 
         # callback
         if callback: