Difference between revisions of "JBrowse/tool data"

From GMOD
Jump to: navigation, search
m (Adding new information to JBrowse page)
(Tutorial: Exploration of structural variation in the tomato clade using JBrowse)
 
(24 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
| name = JBrowse
 
| name = JBrowse
 
| full_name =  
 
| full_name =  
 +
| contact_email = rbuels@gmail.com
 
| status = mature
 
| status = mature
 
| dev = active
 
| dev = active
 
| support = active
 
| support = active
| os_linux = y
+
| type = Genome visualization
| os_mac = y
+
| platform = web
| os_unix = y
+
| os_win = y
+
| os_web = y
+
 
| logo = JBrowseLogo.png
 
| logo = JBrowseLogo.png
 +
| input = [[GFF3]], BED, FASTA, Wiggle, BigWig, BAM
 +
| output =
 +
| licence = [http://www.gnu.org/licenses/lgpl.txt LGPL] and [http://www.perlfoundation.org/artistic_license_2_0 Artistic license]
 +
| open source = yes
 +
| language = Javascript, Perl
 +
| release date = 2008
 
| home = http://jbrowse.org
 
| home = http://jbrowse.org
| about = 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.
+
| demo_server = [http://jbrowse.org/code/JBrowse-1.5.0-full/index.html?loc=ctgA%3A5947..26686&tracks=DNA%2CCDS%2CTranscript%2Cvolvox_microarray.wig%2Cvolvox_microarray.bw&data=sample_data%2Fjson%2Fvolvox Volvox example data]
 +
| wild_urls =
 +
| about = JBrowse is a genome browser with a fully dynamic HTML5 user interface, being developed as the 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.
  
 
===Features===
 
===Features===
 
*Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
 
*Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
*Scales easily to multi-gigabase genomes and deep-coverage sequencing.
+
*Scales easily to multi-gigabase genomes.
 
*Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, and more.
 
*Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, and more.
 
*Very light server resource requirements. Serve huge datasets from a single low-cost cloud instance.
 
*Very light server resource requirements. Serve huge datasets from a single low-cost cloud instance.
Line 31: Line 37:
 
| dl_src =  
 
| dl_src =  
 
| dl_src_url = http://github.com/GMOD/jbrowse
 
| dl_src_url = http://github.com/GMOD/jbrowse
| dl_dev =
+
| getting_started_preamble = The [http://jbrowse.org/code/latest-release/docs/tutorial/ JBrowse Quick-Start Tutorial] provides a basic step-by-step recipe for quickly getting up and running with JBrowse.
| dl_dev_url =
+
| getting_started_preamble = The [http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial] provides a basic step-by-step recipe for quickly getting up and running with JBrowse.
+
 
| req =  
 
| req =  
 
JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler.  On Ubuntu, you can install these prerequisites using the command:
 
JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler.  On Ubuntu, you can install these prerequisites using the command:
Line 42: Line 46:
  
 
| install =  
 
| install =  
The [http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial] provides a basic step-by-step recipe for quickly getting up and running with JBrowse.
+
The [http://jbrowse.org/code/latest-release/docs/tutorial/ JBrowse Quick-Start 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:
 
<!-- 0. Install libpng, Zlib, and GD development libraries, plus make and a C compiler.  On Ubuntu, you could do this with:
Line 48: Line 52:
 
   sudo apt-get install libpng-dev libgd2-noxpm-dev build-essential
 
   sudo apt-get install libpng-dev libgd2-noxpm-dev build-essential
 
-->
 
-->
1. [http://jbrowse.org/install/ Download JBrowse] on to your web server.
+
1. [http://jbrowse.org/install/ 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 <code>/var/www</code>.
 
2. Unpack JBrowse into a directory that is served by your web browser.  On many systems, this defaults to <code>/var/www</code>.
Line 57: Line 61:
 
'''Make sure you have permissions to write to the contents of the <code>jbrowse/</code> directory you have just created.'''
 
'''Make sure you have permissions to write to the contents of the <code>jbrowse/</code> directory you have just created.'''
  
3. Run the automated-setup script, <code>./setup.sh</code>, which will attempt to install all of JBrowse's (modest) prerequisites for you in the <code>jbrowse/</code> directory itself.  Note that <code>setup.sh</code> does not need to be run as root or with <code>sudo</code>.
+
3. Run the automated-setup script, <code>./setup.sh</code>, which will attempt to install all of JBrowse's (modest) prerequisites for you in the <code>jbrowse/</code> directory itself.  Note that <code>setup.sh</code> does not need to be run as root or with <code>sudo</code>.  For help troubleshooting failures of setup.sh, see [[JBrowse Troubleshooting]].
  
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!
+
4. Visit JBrowse on your machine, substituting the <nowiki>http://(your_machine/path_to_jbrowse)/index.html?data=sample_data/json/volvox</nowiki>.  If you can see the included Volvox example data, you are ready to configure JBrowse to show your own data!
  
 
| config =
 
| config =
Line 75: Line 79:
  
 
Additional topics:
 
Additional topics:
* [[JBrowseDev/Using Configuration Files With JBrowse|Using Configuration Files with biodb-to-json.pl]]
 
 
* [[JBrowseDev/Using a Database With JBrowse|Using an Existing Database with JBrowse]]
 
* [[JBrowseDev/Using a Database With JBrowse|Using an Existing Database with JBrowse]]
  
Line 86: Line 89:
 
If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.
 
If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.
  
| doc = For data format specifications, developer information, and so forth, see [[JBrowse Advanced Topics]].
+
| doc =
 
| papers =  
 
| papers =  
 
| presentations =
 
| presentations =
 +
* April 2013 - Bio-IT World, Robert Buels: [[Media:JBrowse_bioit_world_apr2013.pdf|PDF]]
 
* August 2012 - presentation given as part of the [[2012 GMOD Summer School]]: [[Media:JBrowse_gmod_aug2012.pdf|PDF]]  
 
* August 2012 - presentation given as part of the [[2012 GMOD Summer School]]: [[Media:JBrowse_gmod_aug2012.pdf|PDF]]  
 
* April 2012 - GMOD 2012 Community Meeting, Robert Buels: [[Media:RBuels_JBrowse_apr2012.pdf|PDF]]
 
* April 2012 - GMOD 2012 Community Meeting, Robert Buels: [[Media:RBuels_JBrowse_apr2012.pdf|PDF]]
Line 97: Line 101:
 
* July 2008 - [[July 2008 GMOD Meeting|GMOD Community Meeting]]: [[ July 2008 GMOD Meeting#GBrowse 3.0 | Talk summary ]] | [[:Image:GBrowse3GMOD2008.pdf|PDF]]
 
* July 2008 - [[July 2008 GMOD Meeting|GMOD Community Meeting]]: [[ July 2008 GMOD Meeting#GBrowse 3.0 | Talk summary ]] | [[:Image:GBrowse3GMOD2008.pdf|PDF]]
 
| tutorials =  
 
| tutorials =  
;[[JBrowse Tutorial 2012]]
+
; [[JBrowse Tutorial]] covering installation and configuration
:taught as part of the [[2012 GMOD Summer School]]
+
: part of the [[2013 GMOD Summer School]]
 
;[http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial]
 
;[http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial]
 
:part of the JBrowse documentation
 
:part of the JBrowse documentation
;[[JBrowse Tutorial 2010|Tutorial from 2010]]
+
; [[Media:Exploring_structural_variation_in_the_tomato_clade_using_JBrowse.pdf | Exploration of structural variation in the tomato clade using JBrowse]]
:taught as part of the [[2010 GMOD Summer School - Americas]]
+
: Tutorial explaining how to browse structural variants from the 150+ tomato genome resequencing project (http://www.tomatogenome.net) using JBrowse
  
| wild_urls =
 
 
| mail = Please direct questions and inquiries regarding JBrowse to the mailing lists below.
 
| mail = Please direct questions and inquiries regarding JBrowse to the mailing lists below.
  
''Requests for help should be directed to [mailto:gmod-ajax@lists.sourceforge.net gmod-ajax@lists.sourceforge.net].'''
+
''Requests for help should be directed to [mailto:gmod-ajax@lists.sourceforge.net gmod-ajax@lists.sourceforge.net].''
  
 
{{MailingListsFor|JBrowse}}
 
{{MailingListsFor|JBrowse}}
Line 121: Line 124:
 
The [http://github.com/GMOD/jbrowse 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 [http://help.github.com/fork-a-repo/ tutorial] on how to get started with this style of development.
 
The [http://github.com/GMOD/jbrowse 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 [http://help.github.com/fork-a-repo/ tutorial] on how to get started with this style of development.
  
| contact_email = rbuels@gmail.com
 
| input = GFF3, BED, FASTA, Wiggle, BigWig, BAM
 
| output =
 
 
| see_also =  
 
| see_also =  
| demo_server = [http://jbrowse.org/code/JBrowse-1.5.0-full/index.html?loc=ctgA%3A5947..26686&tracks=DNA%2CCDS%2CTranscript%2Cvolvox_microarray.wig%2Cvolvox_microarray.bw&data=sample_data%2Fjson%2Fvolvox Volvox example data]
+
| extras =
 +
{{GitcComponent}}
 
}}
 
}}
  

Latest revision as of 08:09, 28 January 2014


This page stores the data that populates the JBrowse wiki page.


{{ {{{template}}} | name = JBrowse | full_name = | contact_email = rbuels@gmail.com | status = mature | dev = active | support = active | type = Genome visualization | platform = web | logo = JBrowseLogo.png | input = GFF3, BED, FASTA, Wiggle, BigWig, BAM | output = | licence = LGPL and Artistic license | open source = yes | language = Javascript, Perl | release date = 2008 | home = http://jbrowse.org | demo_server = Volvox example data | wild_urls = | about = JBrowse is a genome browser with a fully dynamic HTML5 user interface, being developed as the 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.

Features

  • Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
  • Scales easily to multi-gigabase genomes.
  • Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, and more.
  • Very light server resource requirements. Serve huge datasets from a single low-cost cloud instance.
| screenshot =
JBrowse alignment and coverage.png

| public_server = | dl = | dl_url = http://jbrowse.org/install/ | dl_src = | dl_src_url = http://github.com/GMOD/jbrowse | getting_started_preamble = The JBrowse Quick-Start Tutorial provides a basic step-by-step recipe for quickly getting up and running with JBrowse. | req = 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.

| install = 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!

| config = 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.

| doc = | papers = | presentations =

| tutorials =

JBrowse Tutorial covering installation and configuration
part of the 2013 GMOD Summer School
Getting Started with JBrowse Tutorial
part of the JBrowse documentation
Exploration of structural variation in the tomato clade using JBrowse
Tutorial explaining how to browse structural variants from the 150+ tomato genome resequencing project (http://www.tomatogenome.net) using JBrowse

| mail = 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+)

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

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.

| dev_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.

| see_also = | extras =

Included in

Cloud component

}}