ISB Logo BioTapestry Caltech Logo

William Longabaugh and Hamid Bolouri, Institute for Systems Biology

Davidson Lab, California Institute of Technology


Contents
Running BioTapestry
BioTapestry in Action
Description
Documentation
What's New
Publications
Roadmap
Problems Running It?
Supported Platforms
Developer's Notes
Source Code
BioTapestry Viewer
Send Feedback
Get on the Mailing List
Credits
License and Disclaimer

November 11, 2008: Version 3.0.5 Now Available

Running BioTapestry

Click HERE to run the BioTapestry Editor (version 3.0.5) using Java Web Start.

IMPORTANT NOTE FOR MAC USERS (November 11, 2008): The above version should fix the problems that were caused by the recent 9/24/08 Java Update from Apple. The previous temporary workaround version (3.0.1), still available HERE, will be retired in the very near future. Please try to use the standard version.

NOTE: The above version 3.0.5 (released September 30, 2008 as 3.0; now updated to 3.0.5) includes several significant new features designed to make model creation more flexible, search more powerful, and long-term maintenance easier (see What's New). If you have difficulties running the new version, check the troubleshooting section for a link to run the older version.

If you haven't used BioTapestry before, you can get up to speed on the basics by going through the online Quick Start Tutorial. The BioTapestry Frequently Asked Questions is another good source of information. Those documents have not yet been updated to reflect the new features of Version 3, but should still provide a solid starting point. If you run into any difficulties, take at look at Problems Running It? and Supported Platforms below.


BioTapestry in Action

BioTapestry is an interactive tool for building, visualizing, and simulating genetic regulatory networks. Here are some uses of BioTapestry:

Interactive Web Models from the Davidson Lab

Other Interactive Web Models Around the Web

Papers and Books Using BioTapestry

Please let us know if you are using BioTapestry for your research!


Description

BioTapestry is designed around the concept of a developmental network model, and is intended to deal with large scale models with consistency and clarity. It is capable of representing systems that exhibit increasing complexity over time, such as the genetic regulatory network controlling endomesoderm development in sea urchin embryos:

Endomesoderm Screenshot

Another system that demonstrates BioTapestry's capabilities for representing systems that exhibit increasing complexity over time is the network for mouse ventral neural tube specification (Vokes et.al., 2007):

Mouse Ventral Neural Tube Screenshot

BioTapestry's auto layout templates and resizable workspace make it a good tool for working with much larger networks, such as this network for Halobacterium salinarum (Bonneau et.al., 2007):

Halobacterium Network

BioTapestry's framework for creating sets of submodels is well-suited for organizing such large networks in an understandable way, as this detail from the above Halobacterium salinarum network demonstrates:

Halobacterium Network Detail

Significant features include:

  • Supporting data resulting from the perturbation of expression of specific genes, measured in any way (QPCR, genetics, etc.), can be easily accessed for each gene. Temporal and spatial expression results are also accessible.
  • BioTapestry can portray hourly, localized views of the network during development based on data tables describing the network's local and temporal states.
  • BioTapestry can automatically layout the set of network models from lists of interactions provided either through interactive dialogs or comma-separated value (CSV) files exported by spreadsheet programs.


Documentation

BioTapestry Frequently Asked Questions

If you have a question about how something works in BioTapestry, consult the online BioTapestry Frequently Asked Questions list. If you have a question that isn't covered there, then please let us know so we can add it to the list. NOTE: The FAQ has not yet been updated to reflect Version 3.

Online Tutorials

A series of short tutorials that focus on different aspects of the software are available online. For example, for newcomers, the new Quick Start Tutorial covers the minimum material you need to get started working with BioTapestry. There are other tutorials that build upon that introductory material and cover more advanced topics. NOTE: The tutorials have not yet been updated to reflect Version 3.

Current Online Tutorial List

Quick Start Tutorial: This is the best way to learn the basics for using BioTapestry. It covers the minimum material you need to draw a top-level network model and then extend that into a multi-level model hierarchy. If you a newcomer, this will be the best way to begin.

Quick Start Tutorial Resource File (right-click & use "Save Link As...")
Completed BioTapestry ModelQuickStartModel.btp

Dynamic Submodels Tutorial: This tutorial covers how to create dynamic submodels, where data tables are used to automatically determine the active network elements, and the user can manipulate a time slider to see a dynamic presentation of the network behavior. This is the approach used for the S. purpuratus endomesoderm model.

Dynamic Submodels Tutorial Resource File (right-click & use "Save Link As...")
Starting BioTapestry ModelTutorialModelV2.btp
Time Course Data FileTutorialExpressionDataV2.xml
Temporal Input Data FileTutorialInputDataV2.xml
Completed BioTapestry ModelTutorialModelV2-Finished.btp

Tutorial on Building Networks from Interaction Tables: This tutorial covers how to build and layout networks automatically from lists of interactions, which are specified using interactive dialogs. It also covers how to use several tools that can help with common network layout tasks; these are useful even if you are drawing all your networks manually.

Interaction Tables Tutorial Resource File (right-click & use "Save Link As...")
Completed BioTapestry ModelFromDialogTutorial-Finished.btp

Building Networks from Comma-Separated Value Files: This tutorial covers how to build and layout networks automatically using lists of interaction commands that are created in a spreadsheet program such as Microsoft Excel, and then imported into BioTapestry as a comma-separated value (CSV) file.

CSV Tutorial Resource File (right-click & use "Save Link As...")
First-Pass CSV Input FileTutorialSpreadsheetVer2.csv
Second-Pass CSV Input FileTutorialSpreadsheetVer2Pass2.csv
Completed (First-Pass Only) BioTapestry ModelCSVTutorialModel-Finished.btp

Tutorial on Using and Creating Paths: This tutorial covers the feature of BioTapestry that allows you to define named paths through the model hierarchy. You may have situations where you have a complex model hierarchy, and you want to be able to easily progress through a series of closely related submodels that could be widely dispersed across that hierarchy. Paths allow you to do this.

Paths Tutorial Resource File (right-click & use "Save Link As...")
Starting BioTapestry ModelPathTutorialInitialModel.btp
Completed BioTapestry ModelPathTutorialModel-Finished.btp

Other Documentation

The BioTapestry User's Guide (PDF format) provides the same information as the BioTapestry help system currently built into the Editor. However, the User Guide is Revision A (August 16, 2005), and has not been updated to the current version of BioTapestry. A better bet for finding out about the details of BioTapestry is to check the BioTapestry Frequently Asked Questions.

Documentation Description File
User's Guide (Revision A: August 16, 2005)UserGuide.pdf
Comma-Separated Value (CSV) Input File Format DescriptionCSVGuide.txt

Obsolete Documentation

The original Version 1 documention is still available on this page for obsolete documentation.


What's New

Version 3.0.5 was released on 11/11/08. It is an incremental release on Version 3.0 (see below) that fixes bugs and adds a few new features:

  • The Apple Mac 9/08 Java update issue was resolved
  • The batch mode for generating images supports a new -compress option for CSV loads
  • New Tools->Show count of network elements feature provides counts of genes, nodes, and links in a model
  • There are now ten different evidence levels available for links (up from three)
  • Significant improvements in memory footprint and execution speed for large CSV imports and network layout operations
  • Several bug fixes, both for the Editor and the Viewer

Version 3.0 was released on 09/30/08. It includes several significant new features designed to make model creation more flexible, search more powerful, and long-term maintenance easier. The biggest change is that genes, nodes, and links can now be drawn at any level of the model hierarchy, where the user has the option of selecting from existing network elements or creating completely new ones:

Highlighted New Version 3.0 Feature

Other new features include:

  • It is now possible to change a link's source or target node in top-level models
  • The user can globally add a gene or node using a single dialog
  • There is now a global gene/node/linkage search and navigation tool
  • There are several new region operations, including explicit region ordering, full network import, single-region compression and expansion, and region moving
  • The Experimental Data display can now be stocked by specifying a list of URLs for simple web pages
  • Layout synchronization has been improved and made more flexible
  • The root model layout can be changed to match child model layouts
  • The BioTapestry Viewer has been enhanced to include the search and network exploration tools available in the Editor
  • The program supports a new batch mode, useful for generating network images on a server
  • The automatic link layout algorithms have been improved
  • Several efficiency improvements and bug fixes
  • Lots more!
More in-depth discussion of these new features can be found in the
Version 3 Release Notes

Older release notes are also available for Version 2 and for even older versions.


Publications

Please cite BioTapestry using [Longabaugh et.al. 2005] or [Longabaugh et.al. 2008] if you use BioTapestry in your research.

DB Cover Art



Roadmap

With the current version of BioTapestry, the user can: 1) draw networks by hand, or 2) specify a list of interactions either in interactive tables or comma-separated value (CSV) input files and then have the network laid out automatically. Also, when provided with separate tables of experimental data, BioTapestry can automatically show changes in the network state over time.

The Version 3 release in Autumn 2008 includes many new features to improve the program based on user feedback and experience gained by building and maintaining a growing number of large-scale networks.

Work is ongoing to create a version that will analyze experimental spatial/temporal expression data and raw perturbation data, guide the user through the process of deciding what network connections should be included in the network diagram, and then automatically creating the full dynamic network hierarchy.

Other planned enhancements include:

If you have suggestions for other enhancements that would make BioTapestry more useful to you, please let us know.


Problems Running It?

If you run into any issues with getting BioTapestry to run on your computer that you cannot resolve, or have a program crash, please send a report to biotapestry at systemsbiology dot org so we can address your problem.

If problems arise due to the version of Java installed on your computer, see the section below to learn about obtaining a supported version of Java.

If the program is failing to run, or if you are not getting the correct version, it is a good idea to remove any locally cached previous versions of the software that are on your computer. You can do this by running the Java Web Start Applications Manager/Cache Viewer, and deleting the existing local copy of BioTapestry. Finding and running the Manager depends on your operating system and Java version. This section of the FAQ details how to find and run the Manager program:

Do I have to be online to run BioTapestry?

and this section talks about deleting the current cache copy:

I'm not getting the most recent version. What do I do?

IMPORTANT: In addition to deleting the BioTapestry Editor, you should also delete the Sun JavaHelp Support library if it is listed and you are having problems getting BioTapestry to run.

Since the BioTapestry Editor needs to be able to load and save edited BioTapestry (.btp) files from your hard drive, you are asked if you want to allow this before running the application. The code consists of two packages, one signed by the Institute for Systems Biology, and one signed by Sun Microsystems. You must accept these certificates to be able to use the program. If you are running on a Mac and find you need to accept these certificates every time you run the program, consult this section of the FAQ to find out how to avoid this. Please e-mail biotapestry at systemsbiology dot org if you have any questions about this requirement to accept certificates.

If you have previous BioTapestry files that are not loading into the current version correctly, or run into any other show-stopping bugs with the new version, the previous version (2.1.0) is still available HERE. Note that .btp files created by the current version may not load correctly in this older version. PLEASE let us know if you are running into problems that require you to use this version, so we can resolve the issue.

URL change: If you are running an early (pre-v2) version of BioTapestry using a desktop shortcut icon that was installed when you first downloaded it, that version will no longer work; the previous URL for the BioTapestry web site was retired in 2007. You should delete your previous shortcut and launch the program from the link at the top of this page.


Supported Platforms

BioTapestry is currently available as a downloadable application using Java Web Start, which is bundled with any recent version of the Java Runtime Environment (JRE). If you have problems launching BioTapestry, you will need to make sure you have installed the JRE. The JRE can be download from here (click the "Free Java Download" button) or here if you want to select from a wide variety of versions. On MacOS X, Java should already be factory-installed on new computers.

Please note that although BioTapestry is launched on your computer by connecting to the www.BioTapestry.org web server to download the program and check to make sure you have the latest updates, all of your files stay on your personal machine. In the future, we plan to provide a BioTapestry package that can be installed locally on your computer. In the meantime, the Java Web Start version can be run unconnected from the network. Also, Web Start provides you with the option of starting BioTapestry from an icon on your desktop, so it behaves very much like a locally installed application.

BioTapestry is designed to work with all versions of Java available since ~2003, including Java versions v1.4.2, 1.5 and 1.6. If you encounter problems with a particular version of Java, please let us know about it; switching to a different version should solve any version-related problems.

BioTapestry is known to work on Windows (XP, Vista), Linux (many versions, including Red Hat 8.0, Fedora Core Releases 1 & 3, CentOS 5), and MacOS X (version 10.2 had some quirks, but versions 10.3 and newer should work fine).

NOTE for Mac users: There have been reports that launching BioTapestry from Safari in MacOS 10.3 may fail after the application has been downloaded; you get an incorrect error message saying that the correct version of Java is not present. If this occurs, you can still run BioTapestry from the Java Web Start control panel. Run Applications->Utilities->Java->Java Web Start, select BioTapestry Editor, and click the Start button.


Developer's Notes

BioTapestry supports user-written plugins for creating a customized experimental data display. There are example plugins in the source code tree (see below) that can serve as a starting point. If you need any guidance on building plugins, feel free to contact us.


Source Code

A tar file of the current version of the source code is available
here.

Viewer

The BioTapestry Viewer can be installed on your web server to provide a read-only interactive interface for sharing your network on the web. The stripped-down .jar file for the current version (now 3.0.5) of the Viewer is available
here (NOTE: right-click & use "Save Link As..."). While we are planning to post a HOWTO on setting up a viewer on your server, please contact us in the interim if you need guidance.

Send Feedback

We are eager to receive any feedback you wish to send us, such as questions, bug reports, feature requests, and usability issues. Please send us email at:
biotapestry at systemsbiology dot org

Get on the Mailing List

If you want to receive announcements regarding BioTapestry development and releases, just let us know at:
biotapestry at systemsbiology dot org

Credits

BioTapestry is a joint project of the Institute for Systems Biology and the Davidson Lab at Caltech. Primary contributors are:
  • William Longabaugh
  • Eric Davidson
  • Hamid Bolouri
Also:
  • Stephen Ramsey of the Institute for Systems Biology has helped write the SBML output and simulation support
  • Dan Tenenbaum of the Institute for Systems Biology has helped write the Gaggle 2007-4 support

BioTapestry is supported by a grant from NIH General Medical.


License and Disclaimer

This software is licensed under the GNU Lesser General Public License (LGPL), which is a standard "free software" and "open source" license. A copy of the license agreement is available online here.

BioTapestry is under continual development, and despite our best efforts there are bugs in the software. Please be advised that, as stated in the license agreement, the Institute for Systems Biology and the authors disclaim any liability stemming from the use of this software.


Last updated: November 11, 2008

biotapestry at systemsbiology dot org