JBrowse

From GMOD
Revision as of 22:39, 2 November 2012 by RobertBuels (Talk | contribs)

Jump to: navigation, search


JBrowse logo
Status
  • mature release
  • active development
  • active support
Resources

About JBrowse

JBrowse is a genome browser with a fully dynamic AJAX interface, being developed as the eventual successor to GBrowse. It is very fast and scales well to large datasets. JBrowse does almost all of its work directly in the user's web browser, with minimal requirements for the server.

Visit the JBrowse website.

JBrowse alignment and coverage.png

Downloads

Download JBrowse from http://jbrowse.org/install/

Installing JBrowse

The Getting Started with JBrowse Tutorial provides a basic step-by-step recipe for quickly getting up and running with JBrowse.

0. Install libpng, Zlib, and GD development libraries, plus make and a C compiler. On Ubuntu, you could do this with:

 sudo apt-get install libpng-dev libgd2-noxpm-dev build-essential

1. Download JBrowse onto your web server.

2. Unpack JBrowse into a directory that is served by your web browser. On many systems, this defaults to /var/www.

   cd /var/www
   unzip JBrowse-*.zip

Make sure you have permissions to write to the contents of the jbrowse/ directory you have just created.

3. Run the automated-setup script, ./setup.sh, which will attempt to install all of JBrowse's (modest) prerequisites for you in the jbrowse/ directory itself. Note that setup.sh does not need to be run as root or with sudo.

4. Visit http://your.machine.address/jbrowse/index.html?data=sample_data/json/volvox. If you can see the included Volvox example data, you are ready to configure JBrowse to show your own data!

Configuring JBrowse

See the JBrowse Configuration Guide for information on:

Additional topics:

Upgrading JBrowse

To upgrade an existing JBrowse (1.3.0 or later) to the latest version, simply move its data directory (and jbrowse_conf.json if you are using it) into the directory of a newer JBrowse, and the new JBrowse will display that data.

To upgrade a 1.2.x JBrowse, copy its data directory into the new JBrowse directory, and point your browser at compat_121.html in the new JBrowse directory, instead of index.html.

More Documentation

For data format specifications, developer information, and so forth, see JBrowse Advanced Topics.

Publications, Tutorials, and Presentations

Tutorials

Presentations

Contacts and Mailing Lists

Please direct questions and inquiries regarding JBrowse to the mailing lists below.

Requests for help should be directed to gmod-ajax@lists.sourceforge.net.

Mailing List Link Description Archive(s)
JBrowse gmod-ajax JBrowse help and general questions. Nabble (2010/05+), Sourceforge
jbrowse-dev JBrowse development discussions. Nabble (2011/08+)

JBrowse Development

JBrowse is an open-source project, started and managed by the laboratory of Ian Holmes at the University of California, Berkeley.

The JBrowse source code repository is kept on GitHub. Please feel very free to fork the code on GitHub and make modifications and improvements, submitting pull requests. GitHub has a very nice tutorial on how to get started with this style of development.

As of January 2012, the lead developer of JBrowse is Robert Buels. Most of JBrowse was originally written by Mitch Skinner.

There is a mailing list for developers, and there is usually a teleconference on the 3rd Monday of the month at 2pm Pacific US time. We welcome participation from anyone and everyone. Please contact Robert Buels if you would like to listen in or participate.

More on JBrowse

See Category:JBrowse