JBrowse2

From GMOD
Revision as of 20:47, 30 March 2021 by Scott (Talk | contribs)

Jump to: navigation, search

This page is under active development


JBrowse 2 logo
Status
  • Mature release
  • Development: active
  • Support: active
Licence
{{{PAGENAME}}} is open source

Apache 2

Resources


About JBrowse 2

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

Features

  • Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
  • Scales easily to multi-gigabase genomes and deep-coverage sequencing.
  • Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, VCF (with tabix), REST, and more. BAM, BigWig, and VCF data are displayed directly from the compressed binary file with no conversion needed.
  • Very light server resource requirements. In fact, JBrowse has no back-end server code, just tools for formatting data files to be read directly over HTTP. Serve huge datasets from a single low-cost cloud instance.


Visit the JBrowse2 website.


Downloads

Using JBrowse 2

System Requirements

JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler. On Ubuntu, you can install these prerequisites using the command:

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

For tips on installing these baseline libraries, see JBrowse Troubleshooting.

Installation

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


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. For help troubleshooting failures of setup.sh, see JBrowse Troubleshooting.

4. Visit JBrowse on your machine, substituting the http://(your_machine/path_to_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!

Configuration

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.

If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.

Documentation



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+)
gmod-ajax@lists.sourceforge.net


JBrowse 2 Development

Current status

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.

More on JBrowse 2







"desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.,
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.


  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "embedded" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
  • "desktop" is not in the list of possible values (web, linux, os x, unix, windows, vm, cloud) for this property.
Facts about "JBrowse2"RDF feed
Available on platformweb +
Has URLhttps://jbrowse.org/jb2/docs/quickstart_web +, http://jbrowse.org +, http://twitter.com/usejbrowse +, https://github.com/GMOD/jbrowse-components/ + and http://jbrowse.org/demos +
Has descriptionJBrowse is a genome browser with a fully dJBrowse is a genome browser with a fully dynamic AJAX interface, continuing development as the successor to GBrowse and JBrowse. It is very fast and scales well to large datasets. JBrowse is javascript-based and does almost all of its work directly in the user's web browser, with minimal requirements for the server.

Features[edit]

  • Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
  • Scales easily to multi-gigabase genomes and deep-coverage sequencing.
  • Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, VCF (with tabix), REST, and more. BAM, BigWig, and VCF data are displayed directly from the compressed binary file with no conversion needed.
  • Very light server resource requirements. In fact, JBrowse has no back-end server code, just tools for formatting data files to be read directly over HTTP. Serve huge datasets from a single low-cost cloud instance.ets from a single low-cost cloud instance. +
Has development statusactive +
Has input formatGFF3 +, BED +, FASTA +, WIG +, BedGraph +, Bio::DB::* +, UCSC +, Wiggle +, BigWig + and BAM +
Has licenceApache 2 +
Has logoJbrowse2_logo.png +
Has software maturity statusmature +
Has support statusactive +
Has titleJBrowse demos +
Has topicJBrowse2 +
Is open sourceYes +
Link typedownload +, website +, social media +, source code + and demo server +
Release date2021 +
Tool functionality or classificationGenome visualization +
Written in languageJavascript (ReactJS) +
Has subobjectThis property is a special property in this wiki.JBrowse2#https://jbrowse.org/jb2/docs/quickstart_web +, JBrowse2#http://jbrowse.org +, JBrowse2#http://twitter.com/usejbrowse +, JBrowse2#https://github.com/GMOD/jbrowse-components/ + and JBrowse2#http://jbrowse.org/demos +