- Docstrings and future imports.

Author: andrewtliew

src/compas/hpc/core/euler/euler.py

@@ -75,7 +75,7 @@ def load_euler_module(client, module):
     -------
         None
     """
-    ssh.server_command(client=client, command='module load {0}; module list'.format(module))
+    ssh.server_command(client=client, command='module load {0}: module list'.format(module))
 
 
 # def loaded_euler_modules(client):
@@ -98,8 +98,8 @@ def recieve_file_from_euler(username, remote_file, local_file):
     Parameters
     ----------
         username (str): Username.
-        remote_file (str); Path of remote file to recieve.
-        local_file (str); Path to save local file as.
+        remote_file (str): Path of remote file to recieve.
+        local_file (str): Path to save local file as.
 
     Returns
     -------
@@ -114,7 +114,7 @@ def send_file_to_euler(username, local_file):
     Parameters
     ----------
         username (str): Username.
-        local_file (str); Path of local file to send.
+        local_file (str): Path of local file to send.
 
     Returns
     -------
@@ -129,7 +129,7 @@ def send_folder_to_euler(username, local_folder):
     Parameters
     ----------
         username (str): Username.
-        local_folder (str); Path of local folder to send.
+        local_folder (str): Path of local folder to send.
 
     Returns
     -------
@@ -236,7 +236,7 @@ def submit_job(client, command, time='60', output='output.txt', cpus=1):
         None
     """
     n = min([24, int(cpus)])
-    cmd = 'export OMP_NUM_THREADS={0}; bsub -n {0} -W {1} -oo {2} {3}; bbjobs'.format(n, int(time), output, command)
+    cmd = 'export OMP_NUM_THREADS={0}: bsub -n {0} -W {1} -oo {2} {3}: bbjobs'.format(n, int(time), output, command)
     ssh.server_command(client=client, command=cmd)
 
 
@@ -250,8 +250,8 @@ def sync_folder_to_euler(username, local_folder, remote_folder):
     Parameters
     ----------
         username (str): Username.
-        local_folder (str); Path of local folder to sync.
-        remote_folder (str); Path of remote folder to sync.
+        local_folder (str): Path of local folder to sync.
+        remote_folder (str): Path of remote folder to sync.
 
     Returns
     -------

src/compas/numerical/algorithms/dr.py

@@ -1,16 +1,17 @@
-from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
 from copy import deepcopy
 
 from compas.geometry import norm_vectors
 from compas.topology import adjacency_from_edges
 
 
-__author__     = ['Tom Van Mele <[email protected]>']
-__copyright__  = 'Copyright 2017, Block Research Group - ETH Zurich'
-__license__    = 'MIT License'
-__email__      = '[email protected]'
+__author__    = ['Tom Van Mele <[email protected]>']
+__copyright__ = 'Copyright 2017, Block Research Group - ETH Zurich'
+__license__   = 'MIT License'
+__email__     = '[email protected]'
 
 
 __all__ = [

src/compas/numerical/algorithms/dr_numpy.py

@@ -1,5 +1,6 @@
-from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
 import sys
 
@@ -20,10 +21,10 @@
 from compas.numerical import normrow
 
 
-__author__     = ['Tom Van Mele <[email protected]>']
-__copyright__  = 'Copyright 2017, Block Research Group - ETH Zurich'
-__license__    = 'MIT License'
-__email__      = '[email protected]'
+__author__    = ['Tom Van Mele <[email protected]>']
+__copyright__ = 'Copyright 2017, Block Research Group - ETH Zurich'
+__license__   = 'MIT License'
+__email__     = '[email protected]'
 
 
 __all__ = [

src/compas/numerical/algorithms/drx_numpy.py

@@ -1,6 +1,6 @@
-from __future__ import print_function
 from __future__ import absolute_import
 from __future__ import division
+from __future__ import print_function
 
 import sys
 
@@ -30,10 +30,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__ = [

src/compas/numerical/algorithms/fd.py

@@ -1,11 +1,12 @@
-from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
 
-__author__     = ['Tom Van Mele', ]
-__copyright__  = 'Copyright 2017, Block Research Group - ETH Zurich'
-__license__    = 'MIT'
-__email__      = '[email protected]'
+__author__    = ['Tom Van Mele', ]
+__copyright__ = 'Copyright 2017, Block Research Group - ETH Zurich'
+__license__   = 'MIT'
+__email__     = '[email protected]'
 
 
 __all__ = [
@@ -40,7 +41,6 @@ def fd(vertices, edges, fixed, q, loads):
 
         ``xyz, q, f, l, r`` as arrays.
 
-
     Example
     -------
     .. plot::

src/compas/numerical/algorithms/fd_cpp.py

@@ -1,6 +1,6 @@
-from __future__ import print_function
 from __future__ import absolute_import
 from __future__ import division
+from __future__ import print_function
 
 import os
 import ctypes
@@ -16,7 +16,7 @@
 
 
 __author__    = ['Tom Van Mele', ]
-__copyright__ = 'Copyright 2016 - Block Research Group, ETH Zurich'
+__copyright__ = 'Copyright 2017 - Block Research Group, ETH Zurich'
 __license__   = 'MIT License'
 __email__     = '[email protected]'
 

src/compas/numerical/algorithms/fd_numpy.py

@@ -1,5 +1,6 @@
-from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
 import sys
 
@@ -16,10 +17,10 @@
 from compas.numerical import normrow
 
 
-__author__     = ['Tom Van Mele', ]
-__copyright__  = 'Copyright 2017, Block Research Group - ETH Zurich'
-__license__    = 'MIT'
-__email__      = '[email protected]'
+__author__    = ['Tom Van Mele', ]
+__copyright__ = 'Copyright 2017, Block Research Group - ETH Zurich'
+__license__   = 'MIT'
+__email__     = '[email protected]'
 
 
 __all__ = [

src/compas/numerical/algorithms/pca_numpy.py

@@ -1,5 +1,6 @@
 from __future__ import print_function
 from __future__ import absolute_import
+from __future__ import division
 
 import sys
 
@@ -12,10 +13,10 @@
         raise
 
 
-__author__     = ['Tom Van Mele <[email protected]>']
-__copyright__  = 'Copyright 2016, BLOCK Research Group - ETH Zurich'
-__license__    = 'MIT License'
-__email__      = '[email protected]'
+__author__    = ['Tom Van Mele <[email protected]>']
+__copyright__ = 'Copyright 2017, BLOCK Research Group - ETH Zurich'
+__license__   = 'MIT License'
+__email__     = '[email protected]'
 
 
 __all__ = [

src/compas/numerical/linalg.py

@@ -408,10 +408,6 @@ def wrapper(*args):
 def _chofactor(A):
     """Returns the Cholesky factorisation/decomposition matrix.
 
-    Note
-    ----
-        Random data inserted in the entries not used by Cholesky factorisation.
-
     Parameters
     ----------
         A (array): Matrix A represented as an (m x m) array.
@@ -428,6 +424,10 @@ def _chofactor(A):
 
         \mathbf{A} = \mathbf{L} \mathbf{L}^{\mathrm{T}}
 
+    Note
+    ----
+        Random data inserted in the entries not used by Cholesky factorisation.
+
     Examples
     --------
         >>> _chofactor(array([[25, 15, -5], [15, 18, 0], [-5, 0, 11]]))
@@ -534,10 +534,6 @@ def normrow(A):
 def normalizerow(A, do_nan_to_num=True):
     """Normalise the rows of matrix A.
 
-    Note
-    ----
-        Tiling is not necessary, because of NumPy's broadcasting behaviour.
-
     Parameters
     ----------
         A (array): Matrix A represented as an (m x n) array.
@@ -550,6 +546,10 @@ def normalizerow(A, do_nan_to_num=True):
     Normalises the row vectors of A by the normrows, i.e. creates an array of
     vectors where the row vectors have length of unity.
 
+    Note
+    ----
+        Tiling is not necessary, because of NumPy's broadcasting behaviour.
+
     Examples
     --------
         >>> normalizerow(array([[2, -1, 3,], [1, 0, 1], [0, 2, -1]]))
@@ -642,10 +642,6 @@ def solve_with_known(A, b, x, known):
 def spsolve_with_known(A, b, x, known):
     """Solve (sparse) a system of linear equations with part of solution known.
 
-    Note
-    ----
-        Same function as solve_with_known, but for sparse matrix A.
-
     Parameters
     ----------
         A (array): Coefficient matrix (sparse) represented as an (m x n) array.
@@ -663,6 +659,10 @@ def spsolve_with_known(A, b, x, known):
 
         \mathbf{A} \mathbf{x} = \mathbf{b}
 
+    Note
+    ----
+        Same function as solve_with_known, but for sparse matrix A.
+
     Examples
     --------
         >>> A = array([[2, 1, 3], [2, 6, 8], [6, 8, 18]])