Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
caleblareau committed Jun 7, 2017
1 parent 5ab79f7 commit af13f31
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/content/Installation.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# Install stable version through PyPi
There are a few [dependencies](#dependencies) needed to get **proatac** to run. All are
There are a few dependencies](http://proatac.readthedocs.io/en/latest/content/Dependencies.html)
needed to get **proatac** to run. All are
very common bioinformatics tools / languages and should be readily available in
most systems. However, **note that the current implementation of proatac is not supported
on Windows platforms**.

Depending on your python environment, we generally recommend using a virtual environment
to keep python dependencies tidy. An example of installing **proatac** inside a new
python virtual environment called `venv3`
python virtual environment called `venv3` using the following sequence of commands--

```
python3 -m venv venv3
source venv3/bin/active
pip3 install proatac
```

Though **not recommended**, a bleeding-edge (development) version can be installed
directly from Git. Again using a virtual environment--

```
python3 -m venv venv3
source venv3/bin/active
pip3 install git+ssh://[email protected]/buenrostrolab/search/tree/master/proatac
```

While installing **proatac** is obviously a great first step, make sure that all of the
[ependencies](#dependencies) are met
[dependencies](http://proatac.readthedocs.io/en/latest/content/Dependencies.html) are met.
Check out the next page for more detail.

0 comments on commit af13f31

Please sign in to comment.