added docstring and a bit to readme

leobrowning92 · Jan 23, 2019 · a163c17 · a163c17
1 parent e9f585b
commit a163c17
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8,4 +8,8 @@ If you see something you want to chat about, im happy to help :)
 for ease of use, can add fetplot and afmdensityplot to your path
 for ubuntu use
 
- ln -s ~/gitrepos/plotting/fetplot.py ~/.local/bin/fetplot
+ ln -s ~/gitrepos/plotting/fetplot.py ~/.local/bin/fetplot
+
+or add the whole folder to your python virtualenv using the virtualenvwrapper command:
+
+ add2virtualenv ~/gitrepos/plotting/
diff --git a/mea_analysis.py b/mea_analysis.py
@@ -1,4 +1,11 @@
 #!/usr/bin/env python3
+"""
+ File name: mea_analysis.py
+ Author: Leo Browning
+ email: [email protected]
+ Description:
+ Bunch of functions for the analysis and plotting of multichanel voltage data collected from a PXI4303.
+"""
 import os, re, glob
 import pandas as pd
 import numpy as np