molssi_math module

This is where the math-gic happens

molssi_math.py A sample repo for the workshop what we did in january 2019 at VT

Handles the primary functions

molssi_devops_2019.molssi_math.canvas(with_attribution=True)

Placeholder function to show example docstring (NumPy format)

Replace this function and doc string for your own project

Parameters:with_attribution (bool, Optional, default: True) – Set whether or not to display who the quote is from Returns:quote – Compiled string including quote and optional attribution Return type:str

molssi_devops_2019.molssi_math.mean(num_list)

Computes the mean of a list of numbers.

Parameters:num_list (iterable of numerical values) – List of numerical values Returns:mean_val – Average value (geometric mean) Return type:float