- More/tidying numerical docstrings.

- devo_numba tidied.
- parallel=False on many Numba functions, as is an experimental argument.
- hpc.core created, opencl and cuda to be sorted still.

Author: andrewtliew

src/compas/hpc/__init__.py

@@ -28,6 +28,7 @@
 .. autosummary::
     :toctree: generated/
 
+    sum_vectors_numba
     norm_vector_numba
     norm_vectors_numba
     length_vector_numba
@@ -58,18 +59,26 @@
     cross_vectors_xy_numba
     dot_vectors_numba
     dot_vectors_xy_numba
+    vector_component_numba
+    vector_component_xy_numba
     multiply_matrices_numba
     multiply_matrix_vector_numba
+    transpose_matrix_numba
+    orthonormalise_vectors_numba
+    plane_from_points_numba
+    circle_from_points_numba
 
 
-cuda
+solvers
 ====
 
 .. autosummary::
     :toctree: generated/
 
+    devo_numba
 
-euler
+
+core
 =====
 
 .. autosummary::
@@ -89,22 +98,16 @@
     kill_job
     sync_folder_to_euler
 
-
-opencl
-======
-
-.. autosummary::
-    :toctree: generated/
-
-
 """
 
 from .geometry import *
-from .euler import *
+from .core import *
 from .algorithms import *
+from .solvers import *
 
 from .geometry import __all__ as a
-from .euler import __all__ as b
+from .core import __all__ as b
 from .algorithms import __all__ as c
+from .solvers import __all__ as d
 
-__all__ = a + b + c
+__all__ = a + b + c + d

src/compas/hpc/algorithms/__init__.py

@@ -1,4 +1,4 @@
-from .drx_numba import drx_numba
+from .drx_numba import *
 
 from .drx_numba import __all__ as a
 

src/compas/hpc/algorithms/drx_numba.py

@@ -1,5 +1,6 @@
-from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
 from numpy import arccos
 from numpy import array
@@ -24,10 +25,10 @@
 from time import time
 
 
-__author__     = ['Andrew Liew <[email protected]>']
-__copyright__  = 'Copyright 2017, BLOCK Research Group - ETH Zurich'
-__license__    = 'MIT License'
-__email__      = '[email protected]'
+__author__    = ['Andrew Liew <[email protected]>']
+__copyright__ = 'Copyright 2017, BLOCK Research Group - ETH Zurich'
+__license__   = 'MIT License'
+__email__     = '[email protected]'
 
 
 __all__ = [
@@ -38,15 +39,17 @@
 def drx_numba(network, factor=1.0, tol=0.1, steps=10000, summary=0, update=False):
     """ Run Numba accelerated dynamic relaxation analysis.
 
-    Parameters:
+    Parameters
+    ----------
         network (obj): Network to analyse.
         factor (float): Convergence factor.
         tol (float): Tolerance value.
         steps (int): Maximum number of steps.
         summary (int): Print summary at end.
         update (bool): Update the co-ordinates of the Network.
 
-    Returns:
+    Returns
+    -------
         array: Vertex co-ordinates.
         array: Edge forces.
         array: Edge lengths.
@@ -118,12 +121,13 @@ def drx_numba(network, factor=1.0, tol=0.1, steps=10000, summary=0, update=False
     return X, f, l
 
 
-@jit(nogil=True, nopython=True)
+@jit(nogil=True, nopython=True, parallel=False)
 def drx_solver(tol, steps, factor, u, v, X, ks, l0, f0, ind_c, ind_t, rows, cols, vals, P, S, B, M, summary,
                inds, indi, indf, EIx, EIy, beams):
     """ Numba accelerated dynamic relaxation solver.
 
-    Parameters:
+    Parameters
+    ----------
         tol (float): Tolerance limit.
         steps (int): Maximum number of steps.
         factor (float): Convergence factor.
@@ -150,7 +154,8 @@ def drx_solver(tol, steps, factor, u, v, X, ks, l0, f0, ind_c, ind_t, rows, cols
         EIy (array): Nodal EIy flexural stiffnesses.
         beams (int): Beam analysis on: 1 or off: 0.
 
-    Returns:
+    Returns
+    -------
         array: Updated nodal co-ordinates.
     """
     m   = len(u)
@@ -269,7 +274,7 @@ def drx_solver(tol, steps, factor, u, v, X, ks, l0, f0, ind_c, ind_t, rows, cols
 
 
 # ==============================================================================
-# Testing
+# Main
 # ==============================================================================
 
 if __name__ == "__main__":

src/compas/hpc/core/__init__.py

@@ -0,0 +1,5 @@
+from .euler_ import *
+
+from .euler_ import __all__ as a
+
+__all__ = a

src/compas/hpc/core/cuda_/__init__.py

@@ -1,4 +1,5 @@
 from .euler import *
+
 from .euler import __all__ as a
 
 __all__ = a