Skip to content

Commit a268d64

Browse files
Jon PalmerJon Palmer
Jon Palmer
authored and
Jon Palmer
committed
update to install docs
1 parent bec4ea6 commit a268d64

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

docs/mac_install.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -70,25 +70,37 @@ mv gm_et_macosx/gmes_petap/ /usr/local
7070
cp $HOME/Downloads/gm_key ~/.gm_key
7171
```
7272

73-
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
73+
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`.
74+
Download [here](https://www.dropbox.com/s/1v3u3ii0j51faq5/augustus-3.2.1-osx.tar.gz) or follow command line below:
75+
```
76+
#install gcc and bamtools via homebrew
77+
brew install gcc5 bamtools
78+
79+
#download augustus
80+
wget https://www.dropbox.com/s/1v3u3ii0j51faq5/augustus-3.2.1-osx.tar.gz
81+
82+
#unpack and build
83+
tar xzvf augustus-3.2.1-osx.tar.gz
84+
cd augustus-3.2.1
85+
make
86+
sudo make install
87+
```
88+
89+
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
7490
```
7591
#add folders to PATH
7692
export PATH="/usr/local/gmes_petap:$PATH"
7793
7894
#add environmental variables
79-
export AUGUSTUS_CONFIG_PATH=/usr/local/opt/augustus/libexec/config
95+
export AUGUSTUS_CONFIG_PATH=/opt/augustus-3.2.1/config
8096
export EVM_HOME=/usr/local/opt/evidencemodeler
8197
export GENEMARK_PATH=/usr/local/gmes_petap
8298
export BAMTOOLS_PATH=/usr/local/opt/bamtools/bin
8399
```
84100

85-
9) Re-launch a terminal window (or type `source ~/.bash_profile`). Finally run funannotate setup script to download databases and identify any problems.
101+
10) Re-launch a terminal window (or type `source ~/.bash_profile`). Finally run funannotate setup script to download databases and identify any problems.
86102
```
87-
#navigate into funannotate install directory
88-
cd /usr/local/opt/funannotate/libexec
89-
90-
#run setup script, might need sudo here
91-
./setup.sh
103+
funannotate setup --all
92104
```
93105

94106
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.

docs/ubuntu_install.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ brew update
4949
4) Install funannotate and dependencies using LinuxBrew
5050
```
5151
brew install freetype
52+
brew install augustus
5253
brew install funannotate
5354
```
5455

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

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

99101
9) Re-launch a terminal window (or type `source ~/.bash_aliases`). Finally run funannotate setup script to download databases and identify any problems.
100102
```
101-
#navigate into funannotate install directory
102-
cd $HOME/.linuxbrew/opt/funannotate/libexec
103-
104-
#run setup script
105-
./setup.sh
103+
funannotate setup --all
106104
```
107105
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.
108106

@@ -113,6 +111,7 @@ The script will download and format necessary databases and then check all of th
113111
* psutil
114112
* natsort
115113
* goatools
114+
* fisher
116115
* numpy
117116
* pandas
118117
* matplotlib

funannotate.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def fmtcols(mylist, cols):
3131
for i in range(0,num_lines))
3232
return "\n".join(lines)
3333

34-
version = '0.3.10'
34+
version = '0.3.11'
3535

3636
default_help = """
3737
Usage: funannotate <command> <arguments>

0 commit comments

Comments
 (0)