npm

Knihovna teorie grafů (sítí) pro vizualizaci a analýzu : https://js.cytoscape.org

Popis

Cytoscape.js je plně vybavená knihovna pro teorii grafů. Potřebujete modelovat a/nebo vizualizovat relační data, například biologická data nebo sociální sítě? Pokud ano, Cytoscape.js je přesně to, co potřebujete.

Cytoscape.js obsahuje model teorie grafů a volitelný renderer pro zobrazení interaktivních grafů. Tato knihovna byla navržena tak, aby programátorům a vědcům co nejvíce usnadnila používání teorie grafů v jejich aplikacích, ať už jde o analýzu na straně serveru v aplikaci Node.js, nebo o bohaté uživatelské rozhraní.

S Cytoscape.js můžete začít pracovat na jednom řádku:

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

Přečtěte si více o funkcích Cytoscape.js přečtením jeho dokumentace.

Dokumentace

Dokumentaci a soubory ke stažení naleznete na webových stránkách projektu.

Cestovní mapa

Budoucí verze Cytoscape.js jsou plánovány v milnících v issue trackeru Github. Pomocí milníků můžete zjistit, co je aktuálně plánováno pro budoucí verze.

Přispívání do Cytoscape.js

Chcete se stát přispěvatelem do Cytoscape.js? Podle svých zájmů můžete přispívat v technických rolích (např. funkce, testování) nebo netechnických rolích (např. dokumentace, osvěta). Spojte se s námi prostřednictvím diskuse na GitHubu.

Mechaniku přispívání žádostí o stažení naleznete v dokumentu CONTRIBUTING.md.

Vydávání funkcí probíhá jednou měsíčně, zatímco vydávání oprav jednou týdně. To umožňuje rychlé vydávání příspěvků od prvních i třetích stran.

Citace

Chcete-li citovat Cytoscape.js v článku, uveďte prosím odkaz na vydání Oxford Bioinformatics:

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 poprvé publikováno online 28. září 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Závislosti sestavení

Instalace node a npm. Před použitím npm run spusťte npm install.

Pokyny pro sestavení

V konzoli spusťte npm run <target>. Hlavní cíle jsou:

Stavba:

• build: proveďte všechna sestavení knihovny (umd, min, umd, esm)
• build:min : provést neminované sestavení s přibalenými závislostmi (pro jednoduché html stránky, vhodné pro začátečníky)
• build:umd : provést sestavení umd (cjs/amd/globals)
• build:esm : provést sestavení esm (moduly ES 2015)
• clean : vyčistí adresář build
• docs : sestaví dokumentaci do documentation
• release : sestaví všechny artefakty vydání
• watch : automaticky sestavit lib pro ladění (se zdrojovou mapou, bez babelu, velmi rychlé)
  • dobré pro obecné testování na debug/index.html
  • slouží na http://localhost:8080 nebo prvním dostupném portu poté, s livereloadem na debug/index.html
• watch:babel : automaticky sestaví lib pro ladění (se zdrojovou mapou, s babel, trochu pomalejší)
  • vhodné pro testování výkonu nebo pro testování zastaralých prohlížečů
  • slouží na http://localhost:8080 nebo prvním dostupném portu poté, s livereload na debug/index.html
• watch:umd : automaticky sestaví prod umd bundle (bez sourcemap, s babel)
  • hodí se pro testování cytoscape v jiném projektu (s odkazem "cytoscape": "file:./path/to/cytoscape" v package.json vašeho projektu)
  • bez http serveru
• dist : aktualizace distribučního js pro npm atd.

Testování:

Výchozí testovací skripty se spouštějí přímo ve zdrojovém kódu. Testy lze alternativně spustit na sestaveném balíčku. Knihovna může být sestavena na node>=6, ale svazek knihovny může být testován na node>=0.10.

• test : spustí všechny testy & linting
• test:js : spustí testy mocha na veřejném API lib (přímo na zdrojových souborech)
  • npm run test:js -- -g "my test name" spustí testy pouze na odpovídajících testovacích případech
• test:build : spustí mocha testy na veřejném API lib (na sestaveném balíčku)
  • npm run build měl by být spuštěn předem na poslední verzi node
  • npm run test:build -- -g "my test name" spustí testy sestavení pouze na odpovídajících testovacích případech
• test:modules : spustí unit testy na soukromém, interním API
  • npm run test:modules -- -g "my test name" spustí testy modulů pouze na odpovídajících testovacích případech
• lint : lint zdrojové kódy js pomocí eslint
• benchmark : spustit všechny benchmarky
• benchmark:single : spustit benchmarky pouze pro sadu uvedenou v benchmark/single

Pokyny pro vydání

1. Každé vydání záplaty backportu proveďte před příslušným aktuálním vydáním. Tím zajistíte, že npm uvede aktuální verzi jako nejnovější.
2. Ujistěte se, že jsou dokumenty aktualizovány seznamem vydání v documentation/md/intro.md
3. Aktualizujte proměnnou prostředí VERSION, například export VERSION=1.2.3
4. Ujistěte se, že všechny testy procházejí: npm run test (viz také test/index.html pro testování prohlížeče)
5. Potvrdit, že všechny testy v IE9 procházejí:
   1. npm run watch:umd
   2. Otevřít virtuální počítač IE9
   3. Otevřít http://yourip:8081/test/ie.html v IE
6. Připravit vydání: npm run release
7. Prohlédněte si soubory, které byly právě sestaveny v předchozím kroku. Vyzkoušejte nově sestavené dokumenty a ukázky:
8. Přidejte vydání do systému git: git add . && git commit -m "Build $VERSION"
9. Aktualizujte verzi balíčku: npm version $VERSION
10. Pošlete změny vydání: git push && git push --tags
11. Zveřejněte vydání v npm: npm publish .
12. Vytvořte vydání pro Zenodo z nejnovějšího tagu
13. Pro vydání funkcí: Vytvořte oznámení o vydání na blogu. Oznámení sdílejte v poštovních konferencích a na sociálních sítích.

Testy

Testy Mocha najdete v adresáři testů. Testy lze spustit v prohlížeči nebo je lze spustit prostřednictvím Node.js (npm run test:js).

.