Python coding convention improvements

[magsol]

There are many small syntactical fixes that need to be made for the code to be production-ready and open sourced. They include (but are not limited to):

• Putting a space between each binary operator and its operands (e.g. x = 5, rather than x=5)
• A space after every comma (e.g. var1, var2 instead of var1,var2)
• Line continuations should be indented from their starting line, e.g.

import numpy as np
x = np.array([1, 2, 3,
    4, 5, 6, 7, 8, 9, 10],
    dtype = np.float) # Any continuation of one line should be indented

• Indentation level should be 4 spaces (no tabs)
• Each function should have an accompanying docstring, e.g.

def square(x):
    """
    Returns the square (x^2) of the input argument.

    Parameters
    ---------------
    x : float
        The base value to be squared.

    Returns
    ----------
    x * x : float
        The square of the input argument.
    """
    return x * x

[magsol]

In function docstrings, the primitives types (integer, float, string, etc) are all being specified correctly. However, with the vector / matrix structures, we need to go a step further.

Rather than simply specify vct_input : vector, we need to provide the user with the type array (since that can imply vector or matrix), as well as the shape of the array. For example, a vector with length T would look like this:

vct_input : array, shape (T)

Similarly, a matrix with P rows and T columns would be documented like this:

mat_input : array, shape (P, T)

All parameters and return values that are arrays should have this form.

[MOJTABAFA]

Thanks for such a good point, I'll apply it right now.