npm

Graafien teorian (verkko) kirjasto visualisointiin ja analysointiin : https://js.cytoscape.org

Kuvaus

Cytoscape.js on täysin varusteltu graafiteoriakirjasto. Pitääkö sinun mallintaa ja/tai visualisoida relaatiodataa, kuten biologista dataa tai sosiaalisia verkostoja? Jos näin on, Cytoscape.js on juuri sitä, mitä tarvitset.

Cytoscape.js sisältää graafiteorian mallin ja valinnaisen renderöijän interaktiivisten graafien näyttämiseen. Tämä kirjasto on suunniteltu tekemään ohjelmoijille ja tutkijoille mahdollisimman helpoksi käyttää graafiteoriaa sovelluksissaan, olipa kyse sitten palvelinpuolen analyysistä Node.js-sovelluksessa tai rikkaasta käyttöliittymästä.

Voit aloittaa Cytoscape.js:n käytön yhdellä rivillä:

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

Lue lisää Cytoscapen ominaisuuksista.js:stä lukemalla sen dokumentaatiota.

Dokumentaatio

Dokumentaatio ja lataukset löytyvät projektin verkkosivuilta.

Tiekartta

Cytoscape.js:n tulevia versioita suunnitellaan Githubin ongelmanseurannan virstanpylväissä. Voit käyttää virstanpylväitä nähdäksesi, mitä tuleviin versioihin on tällä hetkellä suunnitteilla.

Contributing to Cytoscape.js

Haluatko ryhtyä Cytoscape.js:n avustajaksi? Voit osallistua teknisissä rooleissa (esim. ominaisuudet, testaus) tai ei-teknisissä rooleissa (esim. dokumentointi, tiedottaminen) kiinnostuksesi mukaan. Ota meihin yhteyttä julkaisemalla GitHub-keskustelu.

Pullipyynnön lähettämisen mekaniikka on esitetty kohdassa CONTRIBUTING.md.

Ominaisuusjulkaisuja tehdään kuukausittain, kun taas korjausjulkaisuja tehdään viikoittain. Tämä mahdollistaa nopeat julkaisut ensimmäisen ja kolmannen osapuolen panoksille.

Citation

Jos haluat siteerata Cytoscape.js:ää artikkelissa, siteeraa Oxford Bioinformatics -julkaisua:

Cytoscape.js: graafiteorian kirjasto visualisointiin ja analyysiin

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 ja npm. Suorita npm install ennen kuin käytät npm run.

Rakennusohjeet

Suorita npm run <target> konsolissa. Tärkeimmät tavoitteet ovat:

Building:

• build: tee kaikki kirjaston buildit (umd, min, umd, esm)
• build:min : tee unminified build niputetuilla riippuvuuksilla (yksinkertaisille html-sivuille, hyvä aloittelijoille)
• build:umd : tee umd (cjs/amd/globals) build
• build:esm : tee esm (ES 2015 modules) build
• clean : Siivoa build hakemisto
• docs : rakenna dokumentit documentation
• release : rakenna kaikki julkaisun artefaktit
• watch : build lib automaattisesti debuggausta varten (sourcemapilla, ei babelia, erittäin nopea)
  • hyvä yleiseen testaukseen debug/index.html
  • palvelu http://localhost:8080 tai ensimmäiseen saatavilla olevaan porttiin sen jälkeen, livereloadilla debug/index.html
• watch:babel : rakentaa automaattisesti lib:n debuggausta varten (sourcemapilla, babelilla hieman hitaampi)
  • hyvä suorituskyvyn testaamiseen tai vanhentuneiden selainten testaamiseen
  • palvelu http://localhost:8080 tai ensimmäiseen saatavilla olevaan porttiin sen jälkeen, livereloadilla debug/index.html
• watch:umd : build prod umd bundle automaattisesti (ei sourcemapia, babelilla)
  • hyvä testata cytoscapea toisessa projektissa (viittaus "cytoscape": "file:./path/to/cytoscape" oman projektin package.json:ssa)
  • ei http-palvelinta
• dist : päivitä jakelun js:t npm:lle jne.

Testaus:

Vakiotestiskriptit ajetaan suoraan agasinst lähdekoodiin. Testit voidaan vaihtoehtoisesti ajaa rakennetulle nipulle. Kirjasto voidaan rakentaa node>=6, mutta kirjaston bundle voidaan testata node>=0.10.

• test : suorittaa kaikki testit & linting
• test:js : suorittaa mocha-testit lib:n julkiselle API:lle (suoraan lähdetiedostoille)
  • npm run test:js -- -g "my test name" suorittaa testit vain vastaaville testitapauksille
• test:build : ajaa mocha-testit lib:n julkiselle API:lle (rakennetulle nipulle)
  • npm run build on ajettava etukäteen uudemmalla node-versiolla
  • npm run test:build -- -g "my test name" ajaa rakennetestit vain vastaaville testitapauksille
• test:modules : ajaa yksikkötestit yksityiselle, sisäiselle API:lle
  • npm run test:modules -- -g "my test name" ajaa moduulitestejä vain vastaaville testitapauksille
• lint : linttaa js-lähteet eslintin avulla
• benchmark : run all benchmarks
• benchmark:single : run benchmarks only for the suite specified in benchmark/single

Julkaisuohjeet

1. Do each backport patch release before the corresponding current release. Näin varmistetaan, että npm listaa nykyisen version uusimpana.
2. Varmista, että dokumentit on päivitetty julkaisuluettelolla documentation/md/intro.md
3. Päivitä ympäristömuuttuja VERSION, esim. export VERSION=1.2.3
4. Varmista, että kaikki testit menevät läpi: npm run test (katso myös test/index.html selaintestauksesta)
5. Varmista, että kaikki testit läpäisevät IE9:ssä:
   1. npm run watch:umd
   2. Avaa IE9 VM
   3. Avaa http://yourip:8081/test/ie.html IE:ssä
6. Valmista julkaisu: npm run release
7. Katsele tiedostot, jotka luotiin juuri edellisessä vaiheessa. Kokeile juuri rakennettuja dokumentteja ja demoja.
8. Lisää julkaisu gitiin: git add . && git commit -m "Build $VERSION"
9. Päivitä paketin versio: npm version $VERSION
10. Täydennä julkaisun muutokset: git push && git push --tags
11. Julkaise julkaisu npm:ään: npm publish .
12. Luo julkaisu Zenodolle uusimmasta tagista
13. Ominaisuusjulkaisuja varten: Luo julkaisuilmoitus blogiin. Jaa ilmoitus postituslistoilla ja sosiaalisessa mediassa.

Testit

Mochan testit löytyvät testihakemistosta. Testit voidaan ajaa selaimessa tai ne voidaan ajaa Node.js:n kautta (npm run test:js).