example : An awesome project.¶

This is an awesome project.

Tutorials¶

See the following IPython Notebooks for some examples of using example: There should be demo.html file in docs/notebooks/demo.html. The demo html is created from demo.ipynb file.

Basic Demo

API Documentation¶

example provides a MyClass class object, that builds on the scipy.stats to to various things.

The MyClass Class¶

class src.MyClass(pi)[source]¶

plot(x, y, figname)[source]¶

Plots x versus y.

Parameters:	x (list or numpy array) – list or ndarray to use as x axis y (list, optional) – yaxis values. figname (str) – name of figure to save.

Notes

x is required but y is optional.

Utilities¶

utils.remove_nans(df)[source]¶

Removes nans from given dataframe.

Parameters:	df (pandas dataframe) – This must be an pandas dataframe.
Returns:	out_df – dataframe without any nans.
Return type:	pandas dataframe