Name: cytoscape.js
Owner: iVis-at-Bilkent
Description: Graph theory (a.k.a. network) library for analysis and visualisation (compatible with CommonJS/Node.js/Browserify/Webpack, AMD/Require.js, npm, Bower, jspm, Meteor/Atmosphere, jQuery, and plain JS/JavaScript)
Forked from: cytoscape/cytoscape.js
Created: 2016-11-25 07:23:21.0
Updated: 2017-11-08 18:36:46.0
Pushed: 2017-12-05 12:06:46.0
Homepage: http://js.cytoscape.org
Size: 151477
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Graph theory (a.k.a. network) library for analysis and visualisation : http://js.cytoscape.org
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:
cy = cytoscape({ elements: myElements, container: myDiv });
Learn more about the features of Cytoscape.js by reading its documentation.
You can find the documentation and downloads on the project website.
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.
Please refer to CONTRIBUTING.md.
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
Install node
, npm
and gulp
. Of course, npm install
before using gulp
.
Run gulp <target>
in the console. The main targets are:
Building:
build
(default) : build the libraryclean
: clean the build
directorywatch
: automatically build lib and tests for debuggingzip
: build the release ZIPdist
: update the distribution JS for npm, bower, etc.Testing:
test
: run the Mocha unit testslint
: lint the JS sources via eslintbenchmark
: run benchmark regression testsbenchmark-single
: run benchmarks only for the suite specified in benchmark/single
sniper
: runs a BioJS sniper server that hosts demosDocumentation:
docs
: build the documentation templatedocsmin
: build the documentation template with all resources minifieddocspub
: build the documentation for publishing (ZIPs, JS refs, etc.)docspush
: push the built documentation to js.cytoscape.orgunstabledocspush
: push the built documentation to js.cytoscape.org/unstabledocumentation/md/intro.md
VERSION
environment variable, e.g. export VERSION=1.2.3
gulp lint
gulp test
gulp docspub
gulp publish
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
).