Skip to content

Latest commit

 

History

History
120 lines (61 loc) · 4.6 KB

README.md

File metadata and controls

120 lines (61 loc) · 4.6 KB
Raw

Cytoscape.js

DOI GitHub license npm npm installs master branch tests unstable branch tests

Graph theory (a.k.a. network) library for analysis and visualisation : http://js.cytoscape.org

Description

Cytoscape.js is a fully featured graph theory library. Do you need to model and/or visualise relational data, like biological data or social networks? If so, Cytoscape.js is just what you need.

Cytoscape.js contains a graph theory model and an optional renderer to display interactive graphs. This library was designed to make it as easy as possible for programmers and scientists to use graph theory in their apps, whether it's for server-side analysis in a Node.js app or for a rich user interface.

You can get started with Cytoscape.js with one line:

var cy = cytoscape({ elements: myElements, container: myDiv });

Learn more about the features of Cytoscape.js by reading its documentation.

Documentation

You can find the documentation and downloads on the project website.

Roadmap

Future versions of Cytoscape.js are planned in the milestones of the Github issue tracker. You can use the milestones to see what's currently planned for future releases.

Contributing to Cytoscape.js

Please refer to CONTRIBUTING.md.

Citation

To cite Cytoscape.js in a paper, please cite the Oxford Bioinformatics issue:

Cytoscape.js: a graph theory library for visualisation and analysis

Franz M, Lopes CT, Huck G, Dong Y, Sumer O, Bader GD

Bioinformatics (2016) 32 (2): 309-311 first published online September 28, 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Build dependencies

Install node, npm and gulp. Of course, npm install before using gulp.

Build instructions

Run gulp <target> in the console. The main targets are:

Building:

  • build (default) : build the library
  • clean : clean the build directory
  • watch : automatically build lib and tests for debugging
  • zip : build the release ZIP
  • dist : update the distribution JS for npm, bower, etc.

Testing:

  • test : run the Mocha unit tests
  • lint : lint the JS sources via eslint
  • benchmark : run benchmark regression tests
  • benchmark-single : run benchmarks only for the suite specified in benchmark/single
  • sniper : runs a BioJS sniper server that hosts demos

Documentation:

  • docs : build the documentation template
  • docsmin : build the documentation template with all resources minified
  • docspub : build the documentation for publishing (ZIPs, JS refs, etc.)
  • docspush : push the built documentation to js.cytoscape.org
  • unstabledocspush : push the built documentation to js.cytoscape.org/unstable

Release instructions

  1. Do each backport patch release before the corresponding current release. This ensures that npm lists the current version as the latest one.
  2. Make sure the docs are updated with the list of releases in documentation/md/intro.md
  3. Update the VERSION environment variable, e.g. export VERSION=1.2.3
  4. Confirm JS files pass linting: gulp lint
  5. Confirm all tests passing: gulp test
  6. Test the docs and demos with the latest code: gulp docspub
  7. Build and publish the release: gulp publish
  8. Create a release for Zenodo from the latest tag

Tests

Mocha tests are found in the test directory. The tests can be run in the browser or they can be run via Node.js (gulp test or mocha).