npm

Bibliotek för grafteori (nätverk) för visualisering och analys : https://js.cytoscape.org

Beskrivning

Cytoscape.js är ett fullt utrustat grafteoribibliotek. Behöver du modellera och/eller visualisera relationsdata, som biologiska data eller sociala nätverk? I så fall är Cytoscape.js precis vad du behöver.

Cytoscape.js innehåller en grafteorimodell och en valfri renderer för att visa interaktiva grafer. Det här biblioteket utformades för att göra det så enkelt som möjligt för programmerare och forskare att använda grafteori i sina appar, oavsett om det är för serveranalys i en Node.js-app eller för ett innehållsrikt användargränssnitt.

Du kan komma igång med Cytoscape.js med en rad:

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

Lär dig mer om funktionerna i Cytoscape.js genom att läsa dess dokumentation.

Dokumentation

Du hittar dokumentation och nedladdningar på projektets webbplats.

Färdplan

Framtida versioner av Cytoscape.js planeras i milstolparna i Github issue tracker. Du kan använda milstolparna för att se vad som för närvarande planeras för framtida versioner.

Bidra till Cytoscape.js

Vill du bli en bidragsgivare till Cytoscape.js? Du kan bidra i tekniska roller (t.ex. funktioner, testning) eller icke-tekniska roller (t.ex. dokumentation, uppsökande verksamhet), beroende på dina intressen. Ta kontakt med oss genom att lägga upp en GitHub-diskussion.

För mekaniken för att bidra med en pull request, se CONTRIBUTING.md.

Funktionssläpp görs varje månad, medan patch-släpp görs varje vecka. Detta gör det möjligt att snabbt släppa bidrag från första och tredje part.

Citat

För att citera Cytoscape.js i en artikel, vänligen citera Oxford Bioinformatics-utgåvan:

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 först publicerad online 28 september 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Bygg beroenden

Installera node och npm. Kör npm install innan du använder npm run.

Bygginstruktioner

Kör npm run <target> i konsolen. De viktigaste målen är:

Bygga:

• build: gör alla byggnationer av biblioteket (umd, min, umd, esm)
• build:min : gör den ominifierade byggnaden med medföljande beroenden (för enkla html-sidor, bra för nybörjare)
• build:umd : gör umd-byggnaden (cjs/amd/globals)
• build:esm : gör esm-byggnaden (ES 2015-moduler)
• clean : rensa build-katalogen
• docs : bygg dokumentationen i documentation
• release : bygg alla artefakter för utgåvan
• watch : automatiskt bygga lib för felsökning (med sourcemap, ingen babel, mycket snabbt)
  • bra för allmän testning på debug/index.html
  • servas på http://localhost:8080 eller den första tillgängliga porten därefter, med livereload på debug/index.html
• watch:babel : bygger automatiskt lib för felsökning (med sourcemap, med babel, lite långsammare)
  • bra för att testa prestanda eller för att testa föråldrade webbläsare
  • servas på http://localhost:8080 eller den första tillgängliga porten därefter, med livereload på debug/index.html
• watch:umd : bygger automatiskt prod umd bundle (ingen sourcemap, med babel)
  • bra för att testa cytoscape i ett annat projekt (med en "cytoscape": "file:./path/to/cytoscape"-referens i ditt projekts package.json)
  • ingen http-server
• dist : uppdaterar distributions-JS:en för npm osv.

Testning:

De standardiserade testskripten körs direkt i källkoden. Testerna kan alternativt köras på ett byggt paket. Biblioteket kan byggas på node>=6, men bibliotekets bunt kan testas på node>=0.10.

• test : kör alla tester & linting
• test:js : kör mocha-testerna på bibliotekets offentliga API (direkt på källfilerna)
  • npm run test:js -- -g "my test name" kör testerna på endast de matchande testfallen
• test:build : kör mocha-testerna på lib:s offentliga API (på ett byggt paket)
  • npm run build bör köras i förväg på en nyare version av node
  • npm run test:build -- -g "my test name" kör byggtest på endast de matchande testfallen
• test:modules : kör enhetstester på privata, interna API
  • npm run test:modules -- -g "my test name" kör modultester på endast matchande testfall
• lint : Lintar js-källorna via eslint
• benchmark : kör alla benchmarks
• benchmark:single : kör benchmarks endast för den svit som anges i benchmark/single

Instruktion för utgivning

1. Gör varje backport-patchutgåva före motsvarande aktuella utgåva. Detta säkerställer att npm listar den aktuella versionen som den senaste.
2. Säkerställ att dokumentationen är uppdaterad med listan över utgåvor i documentation/md/intro.md
3. Uppdatera miljövariabeln VERSION, t.ex. export VERSION=1.2.3
4. Bekräfta att alla tester går igenom: npm run test (se även test/index.html för testning av webbläsare)
5. Bekräfta att alla tester klarar IE9:
   1. npm run watch:umd
   2. Öppna en IE9 VM
   3. Öppna http://yourip:8081/test/ie.html i IE
6. Förbereda en release: npm run release
7. Se de filer som just byggdes i föregående steg. Prova den nybyggda dokumentationen och demonstrationerna.
8. Lägg till utgåvan i git: git add . && git commit -m "Build $VERSION"
9. Uppdatera paketversionen: npm version $VERSION
10. Push the release changes: npm version $VERSION
11. Push the release changes: git push && git push --tags
12. Publicera utgåvan till npm: npm publish .
13. Skapa en utgåva för Zenodo från den senaste taggen
14. För funktionsutgåvor: Skapa ett tillkännagivande om en utgåva på bloggen. Dela tillkännagivandet på sändlistor och sociala medier.

Tester

Mocha-tester finns i testkatalogen. Testerna kan köras i webbläsaren eller via Node.js (npm run test:js).