molecool_test.functions

functions.py A Python package for analyzing and visualizing xyz files. For MolSSI Workshop Python Package development workshop.

Handles the primary functions

Module Contents

Functions

canvas(with_attribution=True)	Placeholder function to show example docstring (NumPy format).
zen(with_attribution=True)

molecool_test.functions.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

molecool_test.functions.zen(with_attribution=True)