From 1d2becc9af591d37badfe0e77751bbb80932472f Mon Sep 17 00:00:00 2001 From: Calvin Date: Tue, 14 May 2013 21:12:46 -0400 Subject: updated docs --- doc/python.markdown | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 doc/python.markdown (limited to 'doc/python.markdown') diff --git a/doc/python.markdown b/doc/python.markdown new file mode 100644 index 0000000..df086d8 --- /dev/null +++ b/doc/python.markdown @@ -0,0 +1,22 @@ +# Python Documentation # +The python version comes with scripts that can be used like the regular quikr +program, and also a module called quikr so integration with python scripts +is easier. + +If you are switching to use the python scripts instead of the regular, you +will need to regenerate your trained databases with the python version of +quikr\_train. + +## Function documentation ## +If you want to use our quikr module, run help on the module: + + >>> import quikr + >>> help(quikr) +## Python Cannot Find XYZ ## + +Ensure that you have Python 2.7, Scipy, Numpy, and BIOpython installed +and that python is setup correctly. You should be able to do this from a python +prompt without any errors: + >>> import numpy + >>> import scipy + >>> from Bio import SeqIO -- cgit v1.2.3