cytoscape.js README

The project's README from github.com/cytoscape/cytoscape.js. As one markdown file: README.md.

GitHub repo News and tutorials License npm DOI npm installs Automated tests Extensions Cloudflare

Created at the University of Toronto and published in Oxford Bioinformatics (2016, 2023).
Authored by: Max Franz, Christian Lopes, Dylan Fong, Mike Kucera, ..., Gary Bader

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.

Example

The Tokyo railway stations network can be visualised with Cytoscape:

A live demo and source code are available for the Tokyo railway stations graph. More demos are available in the 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

Would you like to become a Cytoscape.js contributor? You can contribute in technical roles (e.g. features, testing) or non-technical roles (e.g. documentation, outreach), depending on your interests. Get in touch with us by posting a GitHub discussion.

For the mechanics of contributing a pull request, refer to CONTRIBUTING.md.

Feature releases are made monthly, while patch releases are made weekly. 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

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

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:

Testing:

The default test scripts run directly against 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.

Release instructions

Background

Patch version

  1. Go to Actions > Release
  2. Go to the 'Run workflow' dropdown
  3. Select 'patch' in the 'Release type' dropdown
  4. Press the green 'Run workflow' button
  5. Close the milestone for the release

Feature version

  1. Go to Actions > Release
  2. Go to the 'Run workflow' dropdown
  3. Select 'feature' in the 'Release type' dropdown
  4. Press the green 'Run workflow' button
  5. Close the milestone for the release
  6. Make the release announcement on the blog

Notes on GitHub Actions UI

Recovering from a failed npm publish

If the 'npm publish' job fails after the release job succeeded (e.g. a transient npm registry error), open the failed run and use 'Re-run failed jobs'. Do not dispatch a new release: the version bump has already been committed and pushed, so a fresh dispatch would bump the version again and leave the previous version unpublished on npm.

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).

cytoscape.js (cytoscape/cytoscape.js)

Searching Database…

Что это такое?Cytoscape.js — это библиотека по теории графов (сетей) для моделирования, визуализации и анализа связанных данных, например биологических или социальных сетей. Её можно использовать в браузере или в Node.js.
Это приложение с интерфейсом или то, что я встраиваю в свой код?Это JavaScript-библиотека: модель теории графов и необязательный рендерер, который вы встраиваете в своё приложение. Её можно использовать для анализа на сервере в Node.js или для богатого интерактивного интерфейса в браузере.
Как добавить это в мой проект?Cytoscape.js можно начать использовать в одну строку кода после установки через npm. Чтобы собрать библиотеку из исходного кода, установите Node и npm, затем выполните npm install, а после этого npm run build.
Нужны ли мне Node и npm, чтобы собрать или использовать это?Node и npm нужны только если вы собираете или тестируете библиотеку из исходного кода; у самого опубликованного пакета не указано никаких зависимостей для работы.
Могу ли я использовать это для анализа без визуального вывода?Да, рендерер необязателен, так что можно использовать только модель теории графов для анализа на сервере в приложении на Node.js без какого-либо визуального вывода.
О чём демо с токийской железной дорогой?Это живое демо, которое идёт вместе с документацией: оно визуализирует станции токийского метро как интерактивный граф сети с помощью Cytoscape.js. Исходный код доступен.
Связана ли это с настольным приложением Cytoscape, которое используют в биоинформатике?Cytoscape.js имеет академические корни общие с исследовательским проектом Cytoscape (создан в Университете Торонто, опубликован в Oxford Bioinformatics), но это отдельная самостоятельная JavaScript-библиотека для веба и Node.js.
Как часто обновляется библиотека?Новые функции выходят ежемесячно, а исправления — еженедельно, поэтому исправления ошибок и вклад в проект попадают в библиотеку быстро.
What are similar projects?sigma.js, graph, G6, networkx, uPlot, charts, rete, bokeh
Creator
cytoscape
Size
114.3 MB
Stars
11.2K
Age
15y
Commits · 90 Days