A web tool for exploring large maps of molecular interactions
Branch: master
Clone or download

README.md

NaviCell

Before using NaviCell Factory, CellDesigner maps should be prepared in a specific manner to be most compatible with NaviCell. Here is the procedure for construction of maps in CellDesigner and preparation of modular hierarchical map structure. The procedure contains instructions for generation of semantic zoom levels for maps using a set of scripts.

This is a NaviCell Factory package allowing to convert a CellDesigner map into NaviCell Google Maps-based enviroment, allowing to explore the map online and visualize high-throughput data on top of it with NaviCell Web Service.

If you've never seen NaviCell then click here in order to see an example.

Using NaviCell Factory consists of several steps

  1. Download the NaviCell Factory package from github into a folder. Let us assume it is "C:\NaviCell" (and we assume to work under Windows though all instructions will work under any other operating system as well).

  2. If you use NaviCell Factory for the first time then go to "C:\NaviCell\factory\examples" and build the examples from there or from "C:\NaviCell\factory\maps" folder. Open and browse the result locally.

  3. Prepare the images of CellDesigner files including, if necessary, several zoom images, b/w images for coloring the map, module definitions (examples of map preparation are provided with the NaviCell Factory package in "C:\NaviCell\factory\examples". Detailed instructions on preparation of high-quality set of images for NaviCell are provided at here (though for very simple use of the maps it is sufficient to look at the examples). Beware of exact naming of the files (i.e.,all images and main xml files shoud end up with "master", black/white image files should end with "_nobg-[k].png" string, enumeration of png files goes from 0 (lowest resolution) to k (highest resolution), etc.).

Simplest minimal set of files for NaviCell Factory can be found at "C:\NaviCell\factory\examples\simple_map_src".

  1. Copy the prepared files into the "C:\NaviCell\factory\maps\[src_folder]"

  2. Create a .bat or .sh file for launching the command line based on the provided templates in "C:\NaviCell\factory\examples". You must modify the first two lines with: set outFolderName=[out_folder] set srcFolderName=[src_folder]

  3. Launch the .bat or .sh file accordingly

  4. Find the results in "C:\NaviCell\site\docroot\navicell\maps\[out_folder]\master"

  5. Either browse the map locally from "C:\NaviCell\site\docroot\navicell\maps\[out_folder]\master\index.html". Beware of launching Chrome browser with "--allow-file-access-from-files" option!

  6. Or copy the whole content of "C:\NaviCell\site\docroot\navicell\maps\[out_folder]" to a web-server and browse online.