Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

documentation links

  • Loading branch information...
commit 99e9e88c80f1a4bf20cc3eb3fa1516bf5b85c4e2 1 parent a588c3a
James Casbon authored
Showing with 21 additions and 0 deletions.
  1. +3 −0  README.rst
  2. +18 −0 doc/index.rst
View
3  README.rst
@@ -2,6 +2,9 @@
An simple interval class for DNA sequences from FASTA files that provides
fast access to sequences and methods for interval logic on those sequences.
+An online version of the documentation should be available at
+http://fastinterval.readthedocs.org/
+
Usually you will create a `Genome` and then use that object to create
intervals. The intervals have a sequence property that will look up the
actual sequence::
View
18 doc/index.rst
@@ -11,6 +11,24 @@ Overview
--------
.. automodule:: fastinterval
+Installation
+------------
+
+fastinterval can be installed with pip::
+
+ pip install fastinterval
+
+You must also install numpy and bx-python at the moment::
+
+ pip install numpy bx-python
+
+
+Development
+-----------
+
+Bugs, patches, etc should be submitted to the github repository:
+https://github.com/jamescasbon/fastinterval
+
API Documentation
-----------------
Please sign in to comment.
Something went wrong with that request. Please try again.