npm

Bibliothèque de théorie graphique (réseau) pour la visualisation et l’analyse : https://js.cytoscape.org

Description

Cytoscape.js est une bibliothèque complète de théorie des graphes. Avez-vous besoin de modéliser et/ou de visualiser des données relationnelles, comme des données biologiques ou des réseaux sociaux ? Si oui, Cytoscape.js est exactement ce dont vous avez besoin.

Cytoscape.js contient un modèle de théorie des graphes et un moteur de rendu optionnel pour afficher des graphes interactifs. Cette bibliothèque a été conçue pour faciliter au maximum l’utilisation de la théorie des graphes par les programmeurs et les scientifiques dans leurs apps, que ce soit pour une analyse côté serveur dans une app Node.js ou pour une interface utilisateur riche.

Vous pouvez démarrer avec Cytoscape.js avec une ligne :

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

Apprenez-en plus sur les fonctionnalités de Cytoscape.js en lisant sa documentation.

Documentation

Vous pouvez trouver la documentation et les téléchargements sur le site web du projet.

Plan de route

Les futures versions de Cytoscape.js sont planifiées dans les jalons du traqueur de problèmes Github. Vous pouvez utiliser les jalons pour voir ce qui est actuellement prévu pour les futures versions.

Contribuer à Cytoscape.js

Vous souhaitez devenir un contributeur de Cytoscape.js ? Vous pouvez contribuer dans des rôles techniques (par exemple, fonctionnalités, tests) ou non techniques (par exemple, documentation, sensibilisation), en fonction de vos intérêts. Entrez en contact avec nous en postant une discussion GitHub.

Pour les mécanismes de contribution d’une demande de pull, reportez-vous à CONTRIBUTING.md.

Les versions de fonctionnalités sont faites mensuellement, tandis que les versions de correctifs sont faites hebdomadairement. Cela permet de publier rapidement les contributions des premiers et des tiers.

Citation

Pour citer Cytoscape.js dans un article, veuillez citer le numéro Oxford Bioinformatics:

Cytoscape.js : une bibliothèque de théorie des graphes pour la visualisation et l’analyse

Franz M, Lopes CT, Huck G, Dong Y, Sumer O, Bader GD

Bioinformatics (2016) 32 (2) : 309-311 première publication en ligne le 28 septembre 2015 doi:10.1093/bioinformatics/btv557 (PDF)

PubMed Abstract

Dépendances de construction

Installer node et npm. Exécutez npm install avant d’utiliser npm run.

Instructions de construction

Exécutez npm run <target> dans la console. Les principales cibles sont:

Construction:

• build : faire toutes les constructions de la bibliothèque (umd, min, umd, esm)
• build:min : faire le build non minifié avec les dépendances regroupées (pour les pages html simples, bon pour les novices)
• build:umd : faire le build umd (cjs/amd/globals)
• build:esm : faire le build esm (modules ES 2015)
• clean : nettoyer le répertoire build
• docs : construire les docs dans documentation
• release : construire tous les artefacts de la version
• watch : construire automatiquement la lib pour le débogage (avec sourcemap, pas de babel, très rapide)
  • bon pour les tests généraux sur debug/index.html
  • servi sur http://localhost:8080 ou le premier port disponible par la suite, avec livereload sur debug/index.html
• watch:babel : construire automatiquement lib pour le débogage (avec sourcemap, avec babel, un peu plus lent)
  • bon pour tester les performances ou pour tester des navigateurs obsolètes
  • servi sur http://localhost:8080 ou le premier port disponible après, avec livereload sur debug/index.html
• watch:umd : construire automatiquement le bundle prod umd (pas de sourcemap, avec babel)
  • bon pour tester cytoscape dans un autre projet (avec une référence "cytoscape": "file:./path/to/cytoscape" dans le package.json de votre projet)
  • pas de serveur http
• dist : mettre à jour les js de distribution pour npm etc.

Testing:

Les scripts de test par défaut s’exécutent directement agasinst le code source. Les tests peuvent alternativement être exécutés sur un bundle construit. La bibliothèque peut être construite sur node>=6, mais le bundle de la bibliothèque peut être testé sur node>=0.10.

• test : exécuter tous les tests & linting
• test:js : exécuter les tests mocha sur l’API publique de la lib (directement sur les fichiers sources)
  • npm run test:js -- -g "my test name" exécute les tests sur seulement les cas de tests correspondants
• test:build : exécuter les tests mocha sur l’API publique de la lib (sur un bundle construit)
  • npm run build doit être exécuté au préalable sur une version récente de node
  • npm run test:build -- -g "my test name" exécute les tests de construction sur seulement les cas de test correspondants
• test:modules : exécuter les tests unitaires sur l’API interne et privée
  • npm run test:modules -- -g "my test name" exécuter les tests de modules sur seulement les cas de tests correspondants
• lint : lint les sources js 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. Cela garantit que npm répertorie la version actuelle comme la plus récente.
2. S’assurer que les docs sont mis à jour avec la liste des versions dans documentation/md/intro.md
3. Mettre à jour la variable d’environnement VERSION, par exemple export VERSION=1.2.3
4. Confirmer que tous les tests passent : npm run test (voir aussi test/index.html pour les tests de navigateur)
5. Confirmer que tous les tests passent dans IE9:
   1. npm run watch:umd
   2. Ouvrir une VM IE9
   3. Ouvrir http://yourip:8081/test/ie.html dans IE
6. Préparer une version : npm run release
7. Revoir les fichiers qui viennent d’être construits à l’étape précédente. Essayez les docs et démos nouvellement construits.
8. Ajouter la release à git : git add . && git commit -m "Build $VERSION"
9. Mettre à jour la version du paquet : npm version $VERSION
10. Pousser les changements de la version : git push && git push --tags
11. Publier la version à npm : npm publish .
12. Créer une release pour Zenodo à partir du dernier tag
13. Pour les releases de fonctionnalités : Créez une annonce de release sur le blog. Partagez l’annonce sur les listes de diffusion et les médias sociaux.

Tests

Les tests de Mocha se trouvent dans le répertoire de test. Les tests peuvent être exécutés dans le navigateur ou ils peuvent être exécutés via Node.js (npm run test:js).