• Stars
    star
    128
  • Rank 281,044 (Top 6 %)
  • Language
    Groovy
  • License
    Other
  • Created about 11 years ago
  • Updated 12 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Genome annotation editor with a Java Server backend and a Javascript client that runs in a web browser as a JBrowse plugin.

Apollo

DOI Lint Java CI with Gradle Documentation Chat at Gitter License Contributor Covenant

Β Download the latest release

A collaborative, real-time, genome annotation editor. The stack is a Java web application / database backend and a Javascript client that runs in a web browser as a JBrowse plugin.

Cite Apollo using Dunn NA, Unni DR, Diesh C, Munoz-Torres M, Harris NL, Yao E, et al. (2019) Apollo: Democratizing genome annotation. PLoS Comput Biol 15(2): e1006790. https://doi.org/10.1371/journal.pcbi.1006790

Questions / Comments / Community contact can be sent to our Apollo user mailing list or posted directory to our google group. Old questions are archived on Nabble.

Complete Apollo installation and configuration instructions are available from the Apollo documentation pages

The Apollo client is implemented as a plugin for JBrowse. Additional JBrowse plugins may be found in the JBrowse registry and configured in apollo-config.groovy.

We provide a Demonstration Apollo site and an integrated service is provided by UseGalaxy Europe.

The User's Guide provides guidance on how to use it. Please feel free to update this documentation.

Setup guide

We provide a Setup guide for deploying a configuring a production instance.

Launchable public Amazon Web Services (AWS) EC2 images may be launched from Community AMIs in the N. Virginia region under 'Apollo'.
Specific information for setting up AWS instances is provided for 2.4.1 instances.

Apollo may be launched from Docker as well.

The guide for developers shows how to get started with Apollo.

Web Services

Python library over web services and other web services examples.

Migrating data from older versions

You can follow steps in our migration guide to move annotations and data from older versions.

Note about data directories

Apollo 2.X allows you to add multiple data directories to your webapp, and it expects the data directories to be stored outside of the tomcat webapps directory. Use the developer's guide to learn how to add new data directories for your organisms.

Important Note: All data from a webapps directory will disappear when doing tomcat "undeploy" operations, even if it is a symlink..

Launch Apollo in a temporary server

To launch Apollo with temporary settings, use the apollo run-local command, which will initialize your server automatically with an H2 (zero-configuration) database.

apollo run-local 8080

It will also use your custom settings if an apollo-config.groovy file has been setup.

Generate a war file

Users can generate a war file (for example target/apollo-1.0.2.war) that will be copied into their tomcat webapps directory for production deployments:

apollo deploy

Note: make sure to create an apollo-config.groovy file following the sample data (e.g. sample-postgres-apollo-config.groovy) to make sure you use your preferred database settings.

Run locally for GWT development

apollo devmode 

or in two terminals:

apollo run-local 
gradlew devmode 

Thanks to

YourKit

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

More Repositories

1

jbrowse

JBrowse 1, a full-featured genome browser built with JavaScript and HTML5. For JBrowse 2, see https://github.com/GMOD/jbrowse-components.
JavaScript
463
star
2

jbrowse-components

Source code for JBrowse 2, a modern React-based genome browser
TypeScript
201
star
3

GBrowse

the Generic Genome Browser
Perl
49
star
4

Chado

the GMOD database schema
PLpgSQL
38
star
5

JBrowseR

R interface to the JBrowse 2 Linear Genome View.
R
35
star
6

vcf-js

High performance Variant Call Format (VCF) parser in pure JavaScript
TypeScript
22
star
7

jbrowse-jupyter

A python package for showing JBrowse views
Python
20
star
8

cram-js

Read CRAM v3 and v2 in node or in the browser
TypeScript
17
star
9

bam-js

Parse BAM and BAM index files in javascript for node and the browser
TypeScript
15
star
10

jbrowse-registry

JBrowse 1.x Plugin Registry
HTML
14
star
11

dash_jbrowse

A suite of Dash components for JBrowse's embeddable components
Python
13
star
12

tabix-js

Read Tabix-indexed files, either with .tbi or .csi indexes, in node or the browser
TypeScript
12
star
13

indexedfasta-js

Read FASTA files indexed with .fai indexes. Also supports BGZIP+.gzi
TypeScript
11
star
14

gff-js

parse and format streams of GFF3, for node or webpack
TypeScript
10
star
15

GBrowse-Adaptors

Perl
8
star
16

Bio-Graphics

Generate GD images of biological sequences and annotations
Perl
7
star
17

react-msaview

A multiple sequence alignment viewer
TypeScript
7
star
18

bgzf-filehandle

Nodejs filehandle for reading bgzip+.gzi compressed files
TypeScript
7
star
19

abortable-promise-cache

add AbortController support to a cache of async requests
TypeScript
6
star
20

bbi-js

Parser for bigwig and bigbed files
TypeScript
6
star
21

jbrowse-plugin-gdc

JBrowse 2 plugin for integrating with GDC resources
TypeScript
6
star
22

cmap

A browser-based tool for the visual comparison of various maps (sequence, genetic, etc.) from any number of species.
Perl
5
star
23

bed-js

A parser for the BED format including autoSql support
TypeScript
5
star
24

ucsc-hub-js

read and write UCSC track and assembly hub files in node or the browser
TypeScript
5
star
25

generic-filehandle

use a subset of the NodeJS promise-based file handle API to access both local and remote files
TypeScript
4
star
26

twobit-js

Read .2bit files with pure JS. Works in node or webpack.
TypeScript
4
star
27

jblast-jbconnect-hook

JBrowse/Galaxy-Blast Plugin
CSS
4
star
28

mimosa

Miniature Model Organism Sequence Aligner
CSS
4
star
29

jbrowse-plugin-template

Template to quickly start a new JBrowse 2 plugin
TypeScript
4
star
30

jbrowse-docker

JBrowse docker project
Shell
3
star
31

ixixx-js

TypeScript
3
star
32

jbrowse-plugin-msaview

multiple sequence alignment browser plugin for JBrowse 2
JavaScript
3
star
33

Apollo3

JBrowse 2 plugin for editing annotations on an Apollo server
TypeScript
3
star
34

jbrowse-plugin-list

List of plugins for the JBrowse 2 plugin store.
2
star
35

jbrowse-plugin-ideogram

JBrowse 2 plugin for rendering ideograms
TypeScript
2
star
36

faidx-js

Index a FASTA file similar to `samtools faidx` using pure js
TypeScript
2
star
37

Bio-GMOD-Blast-Graph

display a graphical summary of a BLAST report
Perl
2
star
38

tribble-index-js

Read htsjdk tribble indexes in pure JS
JavaScript
1
star
39

jbrowse_analytics

nodejs-based server for handling usage reports coming in from JBrowse instances
JavaScript
1
star
40

gtf-js

GTF parsing library in JavaScript
TypeScript
1
star
41

sars-cov-2-jbrowse

Repo for storing dockerfile and config for a coronavirus genome browser
Dockerfile
1
star
42

genome-projection

Genome projection library
Groovy
1
star
43

jbrowse-plugin-quantseq

External JB2 plugin implementing a QuantitativeSequence track for displaying base-resolution models.
TypeScript
1
star
44

jbrowse-plugin-reactome

JBrowse 2 plugin integrating with Reactome
TypeScript
1
star
45

jb2export

A CLI program to generate static image exports for jb2
JavaScript
1
star
46

jbconnect

JBConnect, an optional server-side component of JBrowse
JavaScript
1
star
47

WebGBrowse

a web interface for setting up GBrowse instances
Perl
1
star
48

jb2profile

JavaScript
1
star
49

jbrowse-react-app-nextjs-demo

TypeScript
1
star