npm

Graph theory (network) library for visualisation and analysis : https://js.cytoscape.org

Leírás

Cytoscape.js egy teljes funkcionalitású gráfelméleti könyvtár. Relációs adatokat kell modelleznie és/vagy vizualizálnia, például biológiai adatokat vagy társadalmi hálózatokat? Ha igen, akkor a Cytoscape.js pontosan az, amire szüksége van.

A Cytoscape.js tartalmaz egy gráfelméleti modellt és egy opcionális renderelőt az interaktív gráfok megjelenítéséhez. Ezt a könyvtárat úgy terveztük, hogy a programozók és tudósok számára a lehető legegyszerűbbé tegye a gráfelmélet használatát az alkalmazásaikban, legyen szó akár szerveroldali elemzésről egy Node.js alkalmazásban, akár gazdag felhasználói felületről.

A Cytoscape.js-t egy sorral elkezdheti használni:

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

Tudjon meg többet a Cytoscape funkcióiról.js dokumentációjának elolvasásával.

Dokumentáció

A dokumentációt és a letöltéseket a projekt weboldalán találja.

Útiterv

A Cytoscape.js jövőbeli verzióit a Github issue tracker mérföldköveiben tervezzük. A mérföldkövek segítségével láthatja, hogy jelenleg mit terveznek a jövőbeli kiadásokhoz.

Hozzájárulás a Cytoscape.jshez

Szeretne a Cytoscape.jshez hozzájárulni? Hozzájárulhatsz technikai szerepkörben (pl. funkciók, tesztelés) vagy nem technikai szerepkörben (pl. dokumentáció, ismeretterjesztés), attól függően, hogy mi érdekel. Vedd fel velünk a kapcsolatot egy GitHub-beszélgetés közzétételével.

A pull-kérelemmel való hozzájárulás mechanikájához lásd a CONTRIBUTING.md.

A feature-kiadások havonta, míg a patch-kiadások hetente készülnek. Ez lehetővé teszi az első és harmadik féltől származó hozzájárulások gyors kiadását.

Citation

A Cytoscape.js cikkekben való idézéséhez kérjük, hivatkozzon az Oxford Bioinformatics kiadására:

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 dependencies

Install node és npm. A npm run használata előtt futtassa npm install.

Építési utasítások

Futtassa npm run <target> a konzolon. A fő célok a következők:

Building:

• build: a könyvtár összes buildje (umd, min, umd, esm)
• build:min : csináld meg a nemminifikált buildet csomagolt függőségekkel (egyszerű html oldalakhoz, jó kezdőknek)
• build:umd : csináld meg az umd (cjs/amd/globals) buildet
• build:esm : csináld meg az esm (ES 2015 modules) buildet
• clean : Tisztítsa meg a build könyvtárat
• docs : építse a dokumentációkat a documentation
• release : építse az összes kiadási artefaktumot
• watch : automatikusan build lib hibakereséshez (sourcemap-el, babel nélkül, nagyon gyors)
  • jó általános teszteléshez debug/index.html
  • kiszolgálva http://localhost:8080 vagy az első elérhető porton utána, livereloaddal debug/index.html
• watch:babel : automatic build lib for debugging (with sourcemap, with babel, a bit slowower)
  • good for testing performance or for testing out of date browsers
  • served on http://localhost:8080 or the first available port thereafter, with livereload on debug/index.html
• watch:umd : prod umd bundle automatikus építése (nincs sourcemap, babel-el)
  • jó a cytoscape tesztelésére egy másik projektben ("cytoscape": "file:./path/to/cytoscape" hivatkozással a projektedben package.json)
  • nincs http szerver
• dist : frissíti a disztribúciós js-t az npm-hez stb.

Tesztelés:

Az alapértelmezett tesztszkriptek közvetlenül a forráskóddal szemben futnak. A tesztek alternatívaként egy épített csomagon is futtathatók. A könyvtár építhető a node>=6, de a könyvtár kötege tesztelhető a node>=0.10.

• test : az összes teszt futtatása & linting
• test:js : a mocha tesztek futtatása a lib nyilvános API-ján (közvetlenül a forrásfájlokon)
  • npm run test:js -- -g "my test name" csak a megfelelő teszteseteken futtatja a teszteket
• test:build : futtatja a mocha teszteket a lib nyilvános API-ján (egy épített csomagon)
  • npm run build előzetesen futtatni kell a node egy újabb verzióján
  • npm run test:build -- -g "my test name" csak a megfelelő teszteseteken futtatja a build teszteket
• test:modules : egységtesztek futtatása a privát, belső API-n
  • npm run test:modules -- -g "my test name" csak a megfelelő teszteseteken futtatja a modulteszteket
• lint : lint a js forrásokat az eslint segítségével
• benchmark : futtassa az összes benchmarkot
• benchmark:single : csak a benchmark/single

megadott csomaghoz tartozó benchmarkok futtatása

1. Minden backport patch kiadása a megfelelő aktuális kiadás előtt történik. Ez biztosítja, hogy az npm az aktuális verziót a legfrissebbként tüntesse fel.
2. Győződjön meg róla, hogy a dokumentáció frissítve van a documentation/md/intro.md
3. ben található kiadások listájával.
4. Frissítse a VERSION környezeti változót, pl. export VERSION=1.2.3
5. Visszaigazolja, hogy minden teszt átment: npm run test (lásd még test/index.html a böngésző teszteléséhez)
6. Minden teszt átmegy az IE9-ben:
   1. npm run watch:umd
   2. Megnyit egy IE9 VM-et
   3. Megnyit http://yourip:8081/test/ie.html az IE-ben
7. Készítsen elő egy kiadást: npm run release
8. Nézze át az előző lépésben elkészített fájlokat. Próbáld ki az újonnan elkészített dokumentumokat és demókat.
9. Add hozzá a kiadást a githez: git add . && git commit -m "Build $VERSION"
10. Frissítse a csomag verzióját: npm version $VERSION
11. Push the release changes: git push && git push --tags
12. Publish the release to npm: npm publish .
13. Létrehoz egy kiadást a Zenodo számára a legújabb tagből
14. Funkciókiadásokhoz: Hozzon létre egy kiadási bejelentést a blogon. Ossza meg a bejelentést a levelezőlistákon és a közösségi médiában.

Tesztek

A Mocha tesztek a test könyvtárban találhatók. A tesztek futtathatók a böngészőben vagy futtathatók a Node.js-en keresztül (npm run test:js).