npm

Graphentheorie (Netzwerk) Bibliothek zur Visualisierung und Analyse : https://js.cytoscape.org

Beschreibung

Cytoscape.js ist eine voll funktionsfähige Graphentheorie-Bibliothek. Müssen Sie relationale Daten modellieren und/oder visualisieren, wie biologische Daten oder soziale Netzwerke? Dann ist Cytoscape.js genau das Richtige für Sie.

Cytoscape.js enthält ein Graphentheoriemodell und einen optionalen Renderer zur Darstellung interaktiver Graphen. Diese Bibliothek wurde entwickelt, um es Programmierern und Wissenschaftlern so einfach wie möglich zu machen, die Graphentheorie in ihren Anwendungen zu nutzen, sei es für die serverseitige Analyse in einer Node.js-App oder für eine reichhaltige Benutzeroberfläche.

Sie können mit Cytoscape.js mit einer Zeile beginnen:

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

Lernen Sie mehr über die Funktionen von Cytoscape.js, indem Sie die Dokumentation lesen.

Dokumentation

Die Dokumentation und Downloads finden Sie auf der Projektwebseite.

Roadmap

Zukünftige Versionen von Cytoscape.js sind in den Meilensteinen des Github Issue Trackers geplant. Sie können die Meilensteine nutzen, um zu sehen, was derzeit für zukünftige Versionen geplant ist.

Zu Cytoscape.js beitragen

Möchten Sie an Cytoscape.js mitarbeiten? Sie können je nach Ihren Interessen technische (z.B. Funktionen, Testen) oder nicht-technische Aufgaben (z.B. Dokumentation, Öffentlichkeitsarbeit) übernehmen. Setzen Sie sich mit uns in Verbindung, indem Sie eine GitHub-Diskussion eröffnen.

Wie Sie eine Pull-Anfrage einreichen, erfahren Sie in CONTRIBUTING.md.

Feature-Releases werden monatlich veröffentlicht, während Patch-Releases wöchentlich erscheinen. Dies ermöglicht eine schnelle Freigabe von Beiträgen von Erst- und Drittanbietern.

Zitat

Um Cytoscape.js in einem Artikel zu zitieren, zitieren Sie bitte die Oxford Bioinformatics Ausgabe:

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-Abhängigkeiten

Installieren Sie node und npm. Führen Sie npm install aus, bevor Sie npm run verwenden.

Build instructions

Run npm run <target> in the console. Die Hauptziele sind:

Building:

• build: mache alle Builds der Bibliothek (umd, min, umd, esm)
• build:min : Mache den unminified Build mit gebündelten Abhängigkeiten (für einfache HTML-Seiten, gut für Anfänger)
• build:umd : Mache den umd (cjs/amd/globals) Build
• build:esm : Mache den esm (ES 2015 Module) Build
• clean : bereinige das build Verzeichnis
• docs : baue die Docs in documentation
• release : baue alle Release Artefakte
• watch : Lib automatisch zum Debuggen bauen (mit Sourcemap, kein Babel, sehr schnell)
  • Gut für allgemeine Tests auf debug/index.html
  • auf http://localhost:8080 oder dem ersten verfügbaren Port danach, mit livereload auf debug/index.html
• watch:babel : Lib automatisch zum Debuggen bauen (mit Sourceemap, mit Babel, etwas langsamer)
  • gut zum Testen der Leistung oder zum Testen von veralteten Browsern
  • dient auf http://localhost:8080 oder dem ersten verfügbaren Port danach, mit livereload auf debug/index.html
• watch:umd : Automatisch prod umd bundle bauen (keine Sourcemap, mit babel)
  • gut zum Testen von cytoscape in einem anderen Projekt (mit einem "cytoscape": "file:./path/to/cytoscape" Verweis in deinem Projekt package.json)
  • kein http Server
• dist : Aktualisieren der distribution js für npm etc.

Testen:

Die Standard-Testskripte laufen direkt gegen den Quellcode. Die Tests können alternativ auf ein gebautes Bundle ausgeführt werden. Die Bibliothek kann auf node>=6 gebaut werden, aber das Bundle der Bibliothek kann auf node>=0.10 getestet werden.

• test : führt alle Tests aus & linting
• test:js : führt die Mocha-Tests auf der öffentlichen API der Bibliothek aus (direkt auf den Quelldateien)
  • npm run test:js -- -g "my test name" führt Tests nur auf den passenden Testfällen aus
• test:build : führt die Mocha-Tests auf der öffentlichen API der Lib aus (auf einem gebauten Bundle)
  • npm run build sollte vorher auf einer aktuellen Version von Node ausgeführt werden
  • npm run test:build -- -g "my test name" führt Build-Tests nur auf den passenden Testfällen aus
• test:modules : führt Unit-Tests für private, interne API aus
  • npm run test:modules -- -g "my test name" führt Modultests nur für die passenden Testfälle aus
• lint : lint die js-Quellen über eslint
• benchmark : run all benchmarks
• benchmark:single : run benchmarks only for the suite specified in benchmark/single

Release instructions

1. Do each backport patch release before the corresponding current release. Dies stellt sicher, dass npm die aktuelle Version als die neueste auflistet.
2. Stellen Sie sicher, dass die Dokumente mit der Liste der Releases in documentation/md/intro.md
3. Aktualisieren Sie die VERSION Umgebungsvariable, z.B. export VERSION=1.2.3
4. Überprüfen Sie, ob alle Tests erfolgreich sind: npm run test (siehe auch test/index.html für Browsertests)
5. Bestätigen Sie, dass alle Tests im IE9 erfolgreich sind:
   1. npm run watch:umd
   2. Öffnen Sie eine IE9 VM
   3. Öffnen Sie http://yourip:8081/test/ie.html im IE
6. Bereiten Sie eine Freigabe vor: npm run release
7. Überprüfen Sie die Dateien, die im vorherigen Schritt erstellt wurden. Probieren Sie die neu erstellten Dokumente und Demos aus.
8. Fügen Sie das Release zu git hinzu: git add . && git commit -m "Build $VERSION"
9. Aktualisieren Sie die Paketversion: npm version $VERSION
10. Pushen Sie die Versionsänderungen: git push && git push --tags
11. Veröffentlichen Sie die Version auf npm: npm publish .
12. Erstelle ein Release für Zenodo aus dem neuesten Tag
13. Für Feature Releases: Erstellen Sie eine Release-Ankündigung im Blog. Teilen Sie die Ankündigung auf Mailinglisten und sozialen Medien.

Tests

Mocha-Tests befinden sich im Testverzeichnis. Die Tests können im Browser oder über Node.js (npm run test:js) ausgeführt werden.