This short guide should hopefully be enough to get you started using JBrowse. If you run into trouble, please visit the GMOD wiki for extended documentation and troubleshooting information, or join the gmod-ajax mailing list and ask a question about it.
Volvox is a game richly filled with triangles, eyes, and curls, which appear constantly in various forms in characters, controls, and backgrounds, for a strongly organic aesthetic. The game's visual style comes from watercolor painting, and this art style consciously alludes to cellular diffusion phenomena.
Skip this step if you are reading this page on your own server, since you have already downloaded and uncompressed JBrowse.
Get JBrowse from jbrowse.org.
Change into a directory that's served by your web server (e.g. /var/www/), and extract JBrowse there. For example:
setup.sh
To get started with a working JBrowse running on example Volvox data, on machines running Linux or Mac OS X one can simply run:
which tries to automatically install the Perl prerequisites, format the Volvox example data, and install JBrowse WIG and BAM support (which require additional dependencies and compilation that can be a bit tricky).If it says the Volvox example data was successfully formatted (even if the WIG or BAM support setup failed) you can navigate to the example Volvox JBrowse. If you see a genome browser with Volvox data in it, congratulations! You have a working JBrowse installation. Read on to Reference Sequences for how to format your own data for use with JBrowse.
If the WIG support failed to install,
Skip this step if setup.sh
was successful at installing the Perl prerequisites, it has already done this for you.
The server-side scripts for formatting data have some Perl module prerequisites from the CPAN. setup.sh tries to install these Perl dependencies for you, but in case you need to run the installation independently, they can be installed by the command:
Tell JBrowse about your reference sequences with bin/prepare-refseqs.pl
Bio::DB::*
databaseThere are two options for loading your feature data into JBrowse.
If you have data in BAM format, you can import it into a JBrowse instance using bam-to-json.pl. For example:
To let users find features by typing feature names or IDs in the search box, do two things:
Note: You need to rerun bin/generate-names.pl to re-index feature names time you add new annotations to JBrowse.
And that's all, for basic usage. Visit the main page to view the results.
If you want to create quantitative ('wiggle') tracks for JBrowse, you need to compiled a C program called wig2png
, included with JBrowse. If setup.sh
reported being successful at installing wiggle format support, this has already been done for you. Otherwise, if setup.sh
had trouble, read on to see how to manually build wig2png
.
wig2png
Skip this step if setup.sh
reported being successful at installing Wiggle support; this has already been done for you!
libpng
must be installed, along with corresponding development header files (see 'System-specific tips for building' below). Compile the wiggle-processing program by running configure and then make in the wig2png/ subdirectory of the JBrowse root directory.
Once wig2png
has been built, use the wig-to-json.pl script to load wiggle files:
You need libpng and a C++ compiler; you can get these from MacPorts or Fink.
Once you have those installed, you need to compile the JBrowse wiggle-processing program. JBrowse includes a makefile to do this, but you may need to add the paths for libpng and png.h to your compiler's library and include paths. For example, if libpng is in /usr/X11, you can run configure like this:
Depending on which OS X you have (and whether you're using MacPorts/fink/etc.), libpng might be somewhere other than /usr/X11, like /opt/local for example. To find where libpng is, try locate libpng
Be sure to install the libpng## and libpng##-dev packages, where ## is a number such as 12 or 15, depending on the version of Ubuntu.
Be sure to install the libpng and libpng-devel packages.
Sometimes things just don't go well. It seems like nothing's ever as easy as it should be. Here are several resources you can use if it turns out that this guide is not enough to get JBrowse working for you.