Skip to content

Commit

Permalink
update to install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Palmer authored and Jon Palmer committed Nov 10, 2016
1 parent bec4ea6 commit a268d64
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
28 changes: 20 additions & 8 deletions docs/mac_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,25 +70,37 @@ mv gm_et_macosx/gmes_petap/ /usr/local
cp $HOME/Downloads/gm_key ~/.gm_key
```

8) Add several components and ENV variables to `~/.bash_profile` which will get sourced by your BASHRC - you can use any text editor for this
8) Download and install AUGUSTUS 3.2.1. The most recent version of AUGUSTUS 3.2.2 cannot be compiled correctly on Mac OSX (at least anyway that I've tried). You can download a modified version of v3.2.1 from my dropbox account that is configured to be compiled with `gcc-5`.
Download [here](https://www.dropbox.com/s/1v3u3ii0j51faq5/augustus-3.2.1-osx.tar.gz) or follow command line below:
```
#install gcc and bamtools via homebrew
brew install gcc5 bamtools
#download augustus
wget https://www.dropbox.com/s/1v3u3ii0j51faq5/augustus-3.2.1-osx.tar.gz
#unpack and build
tar xzvf augustus-3.2.1-osx.tar.gz
cd augustus-3.2.1
make
sudo make install
```

9) Add several components and ENV variables to `~/.bash_profile` which will get sourced by your BASHRC - you can use any text editor for this
```
#add folders to PATH
export PATH="/usr/local/gmes_petap:$PATH"
#add environmental variables
export AUGUSTUS_CONFIG_PATH=/usr/local/opt/augustus/libexec/config
export AUGUSTUS_CONFIG_PATH=/opt/augustus-3.2.1/config
export EVM_HOME=/usr/local/opt/evidencemodeler
export GENEMARK_PATH=/usr/local/gmes_petap
export BAMTOOLS_PATH=/usr/local/opt/bamtools/bin
```

9) Re-launch a terminal window (or type `source ~/.bash_profile`). Finally run funannotate setup script to download databases and identify any problems.
10) Re-launch a terminal window (or type `source ~/.bash_profile`). Finally run funannotate setup script to download databases and identify any problems.
```
#navigate into funannotate install directory
cd /usr/local/opt/funannotate/libexec
#run setup script, might need sudo here
./setup.sh
funannotate setup --all
```

10) Troubleshooting. There are a number of installation problems with a lot of these software packages that really bother me. One common problem is that many of the programs written in perl ship with a shebang line of `#!/usr/bin/perl` - this can cause lots of problems if you are not using the system perl (which many people do to avoid messing with system perl as it is needed for lots of system maintenance). I like to install perl using homebrew and install modules to this version of Perl, i.e. BioPerl, etc. The better shebang line for portability is `#!/usr/bin/env perl` - which says to use whatever perl is currently in the environment, i.e. your homebrewed perl. The same thing happens in python, i.e. the most portable is `#!/usr/bin/env python` - but that is not always the case. There are several programs here that are by default installed to use system perl - if this is not what you have, you will have to do a little bit of extra work, here is the list of software I currently know has this problem.
Expand Down
13 changes: 6 additions & 7 deletions docs/ubuntu_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ brew update
4) Install funannotate and dependencies using LinuxBrew
```
brew install freetype
brew install augustus
brew install funannotate
```

Expand All @@ -59,8 +60,9 @@ pip install -U biopython numpy pandas scipy matplotlib seaborn natsort goatools

6) Download RepeatMasker libraries from [RepBase](http://www.girinst.org/repbase/) you will need to register
```
wget --user name --password pass http://www.girinst.org/server/RepBase/protected/repeatmaskerlibraries/repeatmaskerlibraries-20150807.tar.gz
tar zxvf repeatmaskerlibraries-20150807.tar.gz -C $HOME/.linuxbrew/opt/repeatmasker/libexec
#download RepeatMasker libraries and install
wget --user name --password pass http://www.girinst.org/server/RepBase/protected/repeatmaskerlibraries/repeatmaskerlibraries-20160829.tar.gz
tar zxvf repeatmaskerlibraries-20160829.tar.gz -C $HOME/.linuxbrew/opt/repeatmasker/libexec
#now setup RepeatMasker
cd $HOME/.linuxbrew/opt/repeatmasker/libexec
Expand Down Expand Up @@ -98,11 +100,7 @@ export BAMTOOLS_PATH=$HOME/.linuxbrew/opt/bamtools/bin

9) Re-launch a terminal window (or type `source ~/.bash_aliases`). Finally run funannotate setup script to download databases and identify any problems.
```
#navigate into funannotate install directory
cd $HOME/.linuxbrew/opt/funannotate/libexec
#run setup script
./setup.sh
funannotate setup --all
```
The script will download and format necessary databases and then check all of the dependencies of funannotate - any tool not properly installed will be flagged by the script.

Expand All @@ -113,6 +111,7 @@ The script will download and format necessary databases and then check all of th
* psutil
* natsort
* goatools
* fisher
* numpy
* pandas
* matplotlib
Expand Down
2 changes: 1 addition & 1 deletion funannotate.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def fmtcols(mylist, cols):
for i in range(0,num_lines))
return "\n".join(lines)

version = '0.3.10'
version = '0.3.11'

default_help = """
Usage: funannotate <command> <arguments>
Expand Down

0 comments on commit a268d64

Please sign in to comment.