npm

GitHub repoAktualizacje TwitterAktualności i tutorialePytania na StackOverflowZadaj pytanie na StackOverflowSpołeczność discussionsLicenseDOICitenpmDownloadExtensionsnpm installsmaster branch testsunstable branch tests

Biblioteka teorii grafów (sieci) do wizualizacji i analizy : https://js.cytoscape.org

Opis

Cytoscape.js jest w pełni funkcjonalną biblioteką teorii grafów. Czy potrzebujesz modelować i/lub wizualizować dane relacyjne, takie jak dane biologiczne lub sieci społeczne? Jeśli tak, Cytoscape.js jest właśnie tym, czego potrzebujesz.

Cytoscape.js zawiera model teorii grafów i opcjonalny renderer do wyświetlania interaktywnych wykresów. Biblioteka ta została zaprojektowana tak, aby maksymalnie ułatwić programistom i naukowcom wykorzystanie teorii grafów w ich aplikacjach, czy to do analizy po stronie serwera w aplikacji Node.js, czy do bogatego interfejsu użytkownika.

Możesz rozpocząć pracę z Cytoscape.js za pomocą jednej linii:

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

Dowiedz się więcej o funkcjach Cytoscape.js czytając jego dokumentację.

Dokumentacja

Dokumentację i pliki do pobrania można znaleźć na stronie projektu.

Mapa drogowa

Przyszłe wersje Cytoscape.js są zaplanowane w kamieniach milowych na Github issue tracker. Możesz użyć kamieni milowych, aby zobaczyć, co jest obecnie planowane dla przyszłych wydań.

Wkład w Cytoscape.js

Czy chciałbyś zostać współtwórcą Cytoscape.js? Możesz wnieść swój wkład w role techniczne (np. funkcje, testowanie) lub nietechniczne (np. dokumentacja, zasięg), w zależności od Twoich zainteresowań. Skontaktuj się z nami, publikując dyskusję na GitHubie.

Mechanikę tworzenia pull requestów opisano w CONTRIBUTING.md.

Wydania funkcji są tworzone co miesiąc, podczas gdy wydania poprawek są tworzone co tydzień. Pozwala to na szybkie wydawanie wersji zarówno pierwszych, jak i tych pochodzących od osób trzecich.

Cytowanie

Aby powołać się na Cytoscape.js w artykule, proszę powołać się na wydanie 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 first published online September 28, 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Build dependencies

Install node and npm. Uruchom npm install przed użyciem npm run.

Instrukcje budowania

Uruchom npm run <target> w konsoli. Główne cele to:

Building:

  • build: zrób wszystkie kompilacje biblioteki (umd, min, umd, esm)
  • build:min : zrób unminified build z bundled dependencies (dla prostych stron html, dobre dla nowicjuszy)
  • build:umd : zrób umd (cjs/amd/globals) build
  • build:esm : zrób esm (ES 2015 modules) build
  • clean : wyczyść katalog build
  • docs : zbuduj docs do documentation
  • release : zbuduj wszystkie artefakty wydania
  • watch : automatically build lib for debugging (with sourcemap, no babel, very quick)
    • good for general testing on debug/index.html
    • served on http://localhost:8080 or the first available port thereafter, with livereload on debug/index.html
  • watch:babel : automatically build lib for debugging (with sourcemap, with babel, a bit slower)
    • dobry do testowania wydajności lub do testowania przestarzałych przeglądarek
    • served on http://localhost:8080 or the first available port thereafter, with livereload on debug/index.html
  • watch:umd : automatycznie buduje prod umd bundle (bez sourcemap, z babel)
    • dobry do testowania cytoscape w innym projekcie (z referencją "cytoscape": "file:./path/to/cytoscape" w package.json twojego projektu)
    • brak serwera http
  • dist : aktualizacja dystrybucji js dla npm itp.

Testowanie:

Domyślne skrypty testowe działają bezpośrednio na kodzie źródłowym. Testy mogą być alternatywnie uruchamiane na zbudowanym pakiecie. Biblioteka może być zbudowana na node>=6, ale bundle biblioteki może być testowany na node>=0.10.

  • test : uruchom wszystkie testy & linting
  • test:js : uruchom testy mokka na publicznym API biblioteki (bezpośrednio na plikach źródłowych)
    • npm run test:js -- -g "my test name" uruchamia testy tylko na pasujących przypadkach testowych
  • test:build : uruchamia testy mokka na publicznym API lib (na zbudowanym bundle)
    • npm run build powinien być uruchomiony wcześniej na najnowszej wersji node
    • npm run test:build -- -g "my test name" uruchamia testy build na tylko pasujących przypadkach testowych
  • test:modules : run unit tests on private, internal API
    • npm run test:modules -- -g "my test name" runs modules tests on only the matching test cases
  • lint : lint the js sources via eslint
  • benchmark : run all benchmarks
  • benchmark:single : run benchmarks only for the suite specified in benchmark/single

Release instructions

  1. Do each backport patch release before the corresponding current release. To zapewnia, że npm wymienia bieżącą wersję jako najnowszą.
  2. Upewnij się, że dokumenty są zaktualizowane o listę wydań w documentation/md/intro.md
  3. Zaktualizuj zmienną środowiskową VERSION, np. export VERSION=1.2.3
  4. Potwierdź, że wszystkie testy przechodzą: npm run test (zobacz także test/index.html dla testowania przeglądarki)
  5. Potwierdź, że wszystkie testy przechodzą w IE9:
    1. npm run watch:umd
    2. Otwórz maszynę wirtualną IE9
    3. Otwórz http://yourip:8081/test/ie.html w IE
  6. Przygotuj wydanie: npm run release
  7. Przeglądaj pliki, które właśnie zostały zbudowane w poprzednim kroku. Wypróbuj nowo zbudowane docs i dema.
  8. Dodaj wydanie do git: git add . && git commit -m "Build $VERSION"
  9. Uaktualnij wersję pakietu: npm version $VERSION
  10. Push the release changes: git push && git push --tags
  11. Publish the release to npm: npm publish .
  12. Utwórz release dla Zenodo z najnowszego tagu
  13. Dla feature releases: Utwórz ogłoszenie wydania na blogu. Udostępnij ogłoszenie na listach mailingowych i w mediach społecznościowych.

Testy

Testy Mocha znajdują się w katalogu testowym. Testy mogą być uruchamiane w przeglądarce lub przez Node.js (npm run test:js).

Dodaj komentarz