Ribbon

Please cite our paper in Bioinformatics: https://doi.org/10.1093/bioinformatics/btaa680 (preprint available on bioRxiv).

Ribbon is an interactive web visualization tool for viewing genomic alignments of short/long reads or assembled contigs to any reference genome.

Ribbon is available online at genomeribbon.com and can even read large bam files straight from your computer without a local install.

Local deployment

Ribbon works without internet access when deployed locally, although note that permalinks and examples don't work and will show errors in the console.

To deploy Ribbon locally:

# Clone this repository
git clone https://github.com/marianattestad/ribbon
cd ribbon

# Launch a web server to serve the assets
python3 -m http.server 1234
# If you only have python2, use python -m SimpleHTTPServer 1234

Ribbon is now available at http://localhost:1234.

Development

To develop new features in Ribbon, first install npm if you don't already have it.

Then clone this repository and build it:

# Clone repo and install dependencies
git clone https://github.com/marianattestad/ribbon
cd ribbon
npm install
npm run build

# Launch a web server
python3 -m http.server 1234