augustus  3.3.3
About: AUGUSTUS is a program that predicts genes in eukaryotic genomic sequences.
  Fossies Dox: augustus-3.3.3.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

augustus Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. augustus-3.3.3.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

Build Status

Gene Prediction with AUGUSTUS

INTRODUCTION
INSTALLATION
RUNNING AUGUSTUS
WEB-SERVER
AUTHORS AND CONTACT
REFERENCES
LICENSES

INTRODUCTION

AUGUSTUS is a program to find genes and their structures in one or more genomes. More ...

INSTALLATION

Ubuntu 18.04 or later

This currently installs only a single-genome version without comparative gene prediction capability:

sudo apt install augustus augustus-data augustus-doc

Clone from GitHUB

To obtain the most recent complete version, first, clone the repository

git clone https://github.com/Gaius-Augustus/Augustus.git

or, alternatively, download and unpack the AUGUSTUS source package with

tar -xzf augustus.current.tar.gz

Docker

After retrieving Augustus change into the main directory containing the Dockerfile and issue

docker build -t augustus .

Install dependencies

The following dependencies may be required for AUGUSTUS:

  • Optional libraries for gzip compressed input (uncomment ZIPINPUT = TRUE in common.mk):
    • libboost-iostreams-dev
    • zlib1g-dev
  • Optional for comparative (multi-species, CGP) AUGUSTUS with SQLite (uncomment COMPGENEPRED = true and SQLITE = true in common.mk):
    • libgsl-dev
    • libboost-graph-dev
    • libboost-all-dev
    • libsuitesparse-dev
    • liblpsolve55-dev
    • libsqlite3-dev
  • Optional for comparative (mutli-species, CGP) AUGUSTUS with MySQL (uncomment COMPGENEPRED = true and MYSQL = true in common.mk):
    • libgsl-dev
    • libboost-graph-dev
    • libboost-all-dev
    • libsuitesparse-dev
    • liblpsolve55-dev
    • libmysql++-dev
  • For compiling bam2hints and filterBam:
    • libbamtools-dev
  • For compiling bam2wig:
  • For compiling utrrnaseq:
    • libboost-all-dev (version must be >Boost_1_49_0)

Compile from sources

Once all dependencies are available, you can compile AUGUSTUS using make.

make

After compilation has finished, the command bin/augustus should be executable and print a usage message.

Install locally

As a normal user, add the directory of the executables to the PATH environment variable, for example:

export PATH=$PATH:~/augustus/bin:~/augustus/scripts

Install globally

You can install AUGUSTUS globally, if you have root privileges, for example:

sudo make install

Alternatively, you can exectue similar commands to those in the "install" section of the top-level Makefile to customize the global installation.

Optional: set environment variable AUGUSTUS_CONFIG_PATH

If the environment variable AUGUSTUS_CONFIG_PATH is set, augustus and etraining will look there for the config directory that contains the configuration and parameter files, e.g. '~/augustus/config'. You may want to add this line to a startup script (like ~/.bashrc).

export AUGUSTUS_CONFIG_PATH=/my_path_to_AUGUSTUS/augustus/config/

If this environment variable is not set, then the programs will look in the path ../config relative to the directory in which the executable lies. As a third alternative, you can specify this directory on the command line when you run augustus: --AUGUSTUS_CONFIG_PATH=/my_path_to_AUGUSTUS/augustus/config/

WEB-SERVER

AUGUSTUS can also be run through a web-interface at http://bioinf.uni-greifswald.de/augustus/ and a web service at http://bioinf.uni-greifswald.de/webaugustus/index.gsp.

REFERENCES AND DOCUMENTATION

Mario Stanke, Mark Diekhans, Robert Baertsch, David Haussler (2008). Using native and syntenically mapped cDNA alignments to improve de novo gene finding. Bioinformatics, 24(5), pages 637–644, doi: 10.1093/bioinformatics/btn013

For further references see docs/REFERENCES.md

3 book chapters with command line walkthroughs

LICENSES

All source code, i.e.

  • the AUGUSTUS source code (src/.cc, include/.hh)
  • the scripts (scripts/*.pl)
  • the auxiliary programs (auxprogs/)
  • the tree-parser (src/scanner,src/parser)

is under the Artistic License.