molssi_math module

molssi_math.py A sample repo for the 2019 MolSSI Software Fellow Bootcamp

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

with_attribution : bool, Optional, default: True

Set whether or not to display who the quote is from

quote : str

Compiled string including quote and optional attribution

molssi_devops_2019.molssi_math.mean(num_list)

Computes the mean of a list of numbers.

num_list : list

List of numbers for which to compute the mean

mean_value : float

Computed mean