diff README.rst @ 18:cff63cf0dea8

Update tool_dependencies to install package from pip
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Mon, 31 Aug 2015 14:13:03 +0100
parents b78a5ba760b1
children 60bbd8ebe314
line wrap: on
line diff
--- a/README.rst	Mon Aug 31 11:41:48 2015 +0100
+++ b/README.rst	Mon Aug 31 14:13:03 2015 +0100
@@ -1,6 +1,6 @@
-===============================
+========
 RiboPlot
-===============================
+========
 
 .. image:: https://img.shields.io/travis/vimalkumarvelayudhan/riboplot.svg
         :target: https://travis-ci.org/vimalkumarvelayudhan/riboplot
@@ -14,13 +14,39 @@
 There are two programs in the package:
 
 **riboplot**
+
     Plot and output read counts (csv) for a single transcript.
 
 **ribocount**
+
     Output read counts for all transcripts in an alignment.
 
+Free software: GPL license
 
-Free software: GPL license.
+Documentation: https://riboplot.readthedocs.org
+
+Repository: https://github.com/vimalkumarvelayudhan/riboplot
+
+Requirements
+------------
+Python packages
+...............
+* matplotlib ``1.3.1``
+* pysam ``0.8.3``
 
-Documentation: https://riboplot.readthedocs.org.
+If you have a virtualenv setup, these packages and their dependencies can be installed 
+using::
+    
+    pip install matplotlib==1.3.1
+    pip install pysam==0.8.3
 
+Bedtools
+........
+RNA coverage plot requires `bedtools <https://github.com/arq5x/bedtools2>`_ to be installed. 
+    
+This release of riboplot has been tested with bedtools version ``2.17.0``.
+
+On Ubuntu and derivatives, bedtools can be installed from the repositories using::
+
+    sudo apt-get install bedtools
+