npm

Grafteori (netværk) bibliotek til visualisering og analyse : https://js.cytoscape.org

Beskrivelse

Cytoscape.js er et fuldt udstyret grafteori-bibliotek. Har du brug for at modellere og/eller visualisere relationelle data, som f.eks. biologiske data eller sociale netværk? Hvis ja, er Cytoscape.js lige det, du har brug for.

Cytoscape.js indeholder en grafteorimodel og en valgfri renderer til visning af interaktive grafer. Dette bibliotek blev designet for at gøre det så nemt som muligt for programmører og forskere at bruge grafteori i deres apps, uanset om det er til server-sideanalyse i en Node.js-app eller til en rig brugergrænseflade.

Du kan komme i gang med Cytoscape.js med én linje:

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

Lær mere om funktionerne i Cytoscape.js ved at læse dokumentationen.

Dokumentation

Du kan finde dokumentationen og downloads på projektets websted.

Køreplan

Fremtidige versioner af Cytoscape.js er planlagt i milepælene i Github-emne-trackeren. Du kan bruge milepælene til at se, hvad der i øjeblikket er planlagt for fremtidige udgivelser.

Bidrage til Cytoscape.js

Vil du gerne blive bidragyder til Cytoscape.js? Du kan bidrage i tekniske roller (f.eks. funktioner, test) eller ikke-tekniske roller (f.eks. dokumentation, opsøgende arbejde), afhængigt af dine interesser. Kom i kontakt med os ved at skrive en GitHub-diskussion.

For mekanikken i at bidrage med en pull request henvises til CONTRIBUTING.md.

Funktioner udgives hver måned, mens patch-udgivelser udgives hver uge. Dette giver mulighed for hurtige udgivelser af første- og tredjepartsbidrag.

Citat

For at citere Cytoscape.js i en artikel, skal du citere Oxford Bioinformatics-udgaven:

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 offentliggjort online 28. september 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Build dependencies

Install node og npm. Kør npm install, før du bruger npm run.

Byggevejledning

Kør npm run <target> i konsollen. De vigtigste mål er:

Bygning:

• build: Udfør alle builds af biblioteket (umd, min, umd, umd, esm)
• build:min : lav det uminificerede build med bundtede afhængigheder (til simple html-sider, godt for nybegyndere)
• build:umd : lav umd (cjs/amd/globals) build
• build:esm : lav esm (ES 2015 modules) build
• clean : rydde op i build-mappen
• docs : bygge dokumentationen i documentation
• release : bygge alle udgivelsesartefakter
• watch : automatisk bygge lib til debugging (med sourcemap, ingen babel, meget hurtigt)
  • godt til generel test på debug/index.html
  • betjenes på http://localhost:8080 eller den første tilgængelige port derefter, med livereload på debug/index.html
• watch:babel : automatisk opbygge lib til debugging (med sourcemap, med babel, lidt langsommere)
  • godt til test af ydeevne eller til test af forældede browsere
  • betjenes på http://localhost:8080 eller den første tilgængelige port derefter, med livereload på debug/index.html
• watch:umd : automatisk bygge prod umd bundle (ingen sourcemap, med babel)
  • god til at teste cytoscape i et andet projekt (med en "cytoscape": "file:./path/to/cytoscape"-reference i dit projekts package.json)
  • ingen http-server
• dist : opdatere distribution js for npm osv.

Testning:

De standardtestskripter kører direkte agasinst kildekoden. Tests kan alternativt køres på et bygget bundle. Biblioteket kan bygges på node>=6, men bibliotekets bundle kan testes på node>=0.10.

• test : kører alle test & linting
• test:js : kører mocha-testene på lib’ets offentlige API (direkte på kildefilerne)
  • npm run test:js -- -g "my test name" kører testene kun på de matchende testcases
• test:build : kører mocha-testene på lib’ens offentlige API (på en bygget bundle)
  • npm run build bør køres på forhånd på en nyere version af node
  • npm run test:build -- -g "my test name" kører build-testene på kun de matchende testcases
• test:modules : kører enhedstests på private, interne API
  • npm run test:modules -- -g "my test name" kører modultests på kun de matchende testtilfælde
• lint : lint js-kilderne via eslint
• benchmark : kør alle benchmarks
• benchmark:single : kør kun benchmarks for den suite, der er angivet i benchmark/single

Udgivelsesinstruktioner

1. Før hver backport-patchudgave før den tilsvarende aktuelle udgave. Dette sikrer, at npm angiver den aktuelle version som den nyeste.
2. Sørg for, at dokumentationen er opdateret med listen over udgivelser i documentation/md/intro.md
3. opdatér miljøvariablen VERSION, f.eks. export VERSION=1.2.3
4. Bekræft, at alle tests består: npm run test (se også test/index.html for browsertestning)
5. Bevis, at alle testene består i IE9:
   1. npm run watch:umd
   2. Opnå en IE9 VM
   3. Opnå http://yourip:8081/test/ie.html i IE
6. Forbered en udgivelse: npm run release
7. Gennemse de filer, der netop blev oprettet i det foregående trin. Prøv den nybyggede dokumentation og demoer.
9. Føj udgivelsen til git: git add . && git commit -m "Build $VERSION"
10. Opdatér pakkeversionen: npm version $VERSION
11. Push ændringerne i udgivelsen: npm version $VERSION
12. Push ændringerne i udgivelsen: git push && git push --tags
13. Offentliggør udgivelsen til npm: git push && git push --tags
14. Publicér udgivelsen til npm: npm publish .
15. Opret en udgivelse til Zenodo fra det seneste tag
16. For feature releases: npm publish .
17. Opret en udgivelsesmeddelelse på bloggen. Del annoncen på postlister og sociale medier.

Test

Mocha-test findes i testmappen. Testene kan køres i browseren, eller de kan køres via Node.js (npm run test:js).