Cytoscape.js
Graph theory (network) library for visualisation and analysis : https://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.
Feature releases are made at the start of each month, while patch releases are made at the start of each week. This allows for rapid releases of first- and third-party contributions.
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
Build dependencies
Install node and npm. Run npm install before using npm run.
Build instructions
Run npm run <target> in the console. The main targets are:
Building:
build: do all builds of the library (unmin, min, umd)build:unmin: do the unminified build with bundled dependencies (for simple html pages, good for novices)build:min: do the unminified build with bundled dependencies (for simple html pages, good for novices)build:umd: do the umd (cjs/amd/globals) buildclean: clean thebuilddirectorydocs: build the docs intodocumentationrelease: build all release artifactswatch: automatically build lib for debugging (with sourcemap, no babel, very quick)- good for general testing on
debug/index.html - served on
http://localhost:8080or the first available port thereafter, with livereload ondebug/index.html
- good for general testing on
watch:babel: automatically build lib for debugging (with sourcemap, with babel, a bit slower)- good for testing performance or for testing out of date browsers
- served on
http://localhost:8080or the first available port thereafter, with livereload ondebug/index.html
watch:umd: automatically build prod umd bundle (no sourcemap, with babel)- good for testing cytoscape in another project (with a
"cytoscape": "file:./path/to/cytoscape"reference in your project'spackage.json) - no http server
- good for testing cytoscape in another project (with a
dist: update the distribution js for npm etc.
Testing:
The default test scripts run directly agasinst the source code. Tests can alternatively be run on a built bundle. The library can be built on node>=6, but the library's bundle can be tested on node>=0.10.
test: run all testing & lintingtest:js: run the mocha tests on the public API of the lib (directly on source files)npm run test:js -- -g "my test name"runs tests on only the matching test cases
test:build: run the mocha tests on the public API of the lib (on a built bundle)npm run buildshould be run beforehand on a recent version of nodenpm run test:build -- -g "my test name"runs build tests on only the matching test cases
test:modules: run unit tests on private, internal APInpm run test:modules -- -g "my test name"runs modules tests on only the matching test cases
lint: lint the js sources via eslintbenchmark: run all benchmarksbenchmark:single: run benchmarks only for the suite specified inbenchmark/single
Release instructions
- Do each backport patch release before the corresponding current release. This ensures that npm lists the current version as the latest one.
- Make sure the docs are updated with the list of releases in
documentation/md/intro.md - Update the
VERSIONenvironment variable, e.g.export VERSION=1.2.3 - Confirm all the tests are passing:
npm run test(see alsotest/index.htmlfor browser testing) - Confirm all the tests are passing in IE9:
npm run watch:umd- Open an IE9 VM
- Open
http://yourip:8081/test/ie.htmlin IE
- Prepare a release:
npm run release - Review the files that were just built in the previous step. Try out the newly-built docs and demos.
- Add the the release to git:
git add . && git commit -m "Build $VERSION" - Update the package version:
npm version $VERSION - Push the release changes:
git push && git push --tags - Publish the release to npm:
npm publish . - Create a release for Zenodo from the latest tag
- For feature releases: Create a release announcement on the blog. Share the announcement on mailing lists and social media.
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 (npm run test:js).