npm

Repo de GitHubActualizaciones de TwitterNoticias y tutorialesPreguntas en StackOverflowHaga una pregunta en StackOverflowComunidad discusionesLicenciaDOICitenpmDescargaExtensionesnpm installspruebas de la rama maestrapruebas de la rama inestable

Librería de teoría de gráficos (redes) para visualización y análisis : https://js.cytoscape.org

Descripción

Cytoscape.js es una biblioteca de teoría de grafos con todas las funciones. ¿Necesita modelar y/o visualizar datos relacionales, como datos biológicos o redes sociales? Si es así, Cytoscape.js es justo lo que necesitas.

Cytoscape.js contiene un modelo de teoría de grafos y un renderizador opcional para mostrar gráficos interactivos. Esta librería fue diseñada para facilitar a los programadores y científicos el uso de la teoría de grafos en sus aplicaciones, ya sea para el análisis del lado del servidor en una aplicación Node.js o para una rica interfaz de usuario.

Puedes empezar con Cytoscape.js con una línea:

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

Aprende más sobre las características de Cytoscape.js leyendo su documentación.

Documentación

Puede encontrar la documentación y las descargas en el sitio web del proyecto.

Hoja de ruta

Las futuras versiones de Cytoscape.js están planificadas en los hitos del issue tracker de Github. Puede utilizar los hitos para ver lo que está actualmente planeado para futuras versiones.

Contribuir a Cytoscape.js

¿Le gustaría convertirse en un colaborador de Cytoscape.js? Puedes contribuir en roles técnicos (por ejemplo, características, pruebas) o en roles no técnicos (por ejemplo, documentación, divulgación), dependiendo de tus intereses. Ponte en contacto con nosotros publicando una discusión en GitHub.

Para la mecánica de contribuir con un pull request, consulta CONTRIBUTING.md.

Los lanzamientos de características se hacen mensualmente, mientras que los lanzamientos de parches se hacen semanalmente. Esto permite una rápida liberación de las contribuciones de primera y tercera parte.

Citación

Para citar Cytoscape.js en un artículo, por favor cite el número de 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 publicado por primera vez en línea el 28 de septiembre de 2015 doi:10.1093/bioinformatics/btv557 (PDF)

Resumen de PubMed

Construir dependencias

Instalar node y npm. Ejecute npm install antes de usar npm run.

Instrucciones de construcción

Ejecute npm run <target> en la consola. Los objetivos principales son:

Construir:

  • build: hacer todas las construcciones de la biblioteca (umd, min, umd, esm)
  • build:min : hacer el build no minificado con dependencias empaquetadas (para páginas html simples, bueno para novatos)
  • build:umd : hacer el build umd (cjs/amd/globals)
  • build:esm : hacer el build esm (módulos ES 2015)
  • clean : limpiar el directorio build
  • docs : construir los docs en documentation
  • release : construir todos los artefactos de liberación
  • watch : construir automáticamente lib para la depuración (con sourcemap, no babel, muy rápido)
    • bueno para las pruebas generales en debug/index.html
    • servido en http://localhost:8080 o el primer puerto disponible después, con livereload en debug/index.html
  • watch:babel : construir automáticamente lib para la depuración (con sourcemap, con babel, un poco más lento)
    • bueno para probar el rendimiento o para probar los navegadores fuera de fecha
    • servido en http://localhost:8080 o el primer puerto disponible después, con livereload en debug/index.html
  • watch:umd : construir automáticamente prod umd bundle (sin sourcemap, con babel)
    • bueno para probar cytoscape en otro proyecto (con una referencia "cytoscape": "file:./path/to/cytoscape" en el package.json de su proyecto)
    • sin servidor http
  • dist : actualizar la distribución js para npm etc.

Pruebas:

Los scripts de prueba por defecto se ejecutan directamente contra el código fuente. Las pruebas pueden ejecutarse alternativamente en un paquete construido. La biblioteca puede ser construido en node>=6, pero el paquete de la biblioteca puede ser probado en node>=0.10.

  • test : ejecuta todas las pruebas & linting
  • test:js : ejecuta las pruebas mocha en la API pública de la librería (directamente en los archivos fuente)
    • npm run test:js -- -g "my test name" ejecuta las pruebas sólo en los casos de prueba coincidentes
  • test:build : ejecuta las pruebas de mocha en la API pública de la lib (en un bundle construido)
    • npm run build debe ejecutarse previamente en una versión reciente de node
    • npm run test:build -- -g "my test name" ejecuta las pruebas de construcción sólo en los casos de prueba coincidentes
  • test:modules : ejecuta pruebas unitarias en la API privada e interna
    • npm run test:modules -- -g "my test name" ejecuta pruebas de módulos sólo en los casos de prueba que coinciden
  • lint : lint las fuentes js a través de eslint
  • benchmark : ejecuta todos los benchmarks
  • benchmark:single : ejecuta los benchmarks sólo para la suite especificada en benchmark/single

Instrucciones de lanzamiento

  1. Haz cada lanzamiento de parches backport antes del correspondiente lanzamiento actual. Esto asegura que npm lista la versión actual como la más reciente.
  2. Asegúrese de que los docs están actualizados con la lista de lanzamientos en documentation/md/intro.md
  3. Actualice la variable de entorno VERSION, por ejemplo export VERSION=1.2.3
  4. Confirme que todas las pruebas están pasando: npm run test (ver también test/index.html para las pruebas del navegador)
  5. Confirmar que todas las pruebas pasan en IE9:
    1. npm run watch:umd
    2. Abrir una VM de IE9
    3. Abrir http://yourip:8081/test/ie.html en IE
  6. Preparar un lanzamiento: npm run release
  7. Revise los archivos que se acaban de construir en el paso anterior. Pruebe los docs y demos recién construidos.
  8. Agregar la liberación a git: git add . && git commit -m "Build $VERSION"
  9. Actualiza la versión del paquete: npm version $VERSION
  10. Pulsar los cambios de la versión: git push && git push --tags
  11. Publicar la liberación a npm: npm publish .
  12. Crear una release para Zenodo a partir de la última etiqueta
  13. Para los feature releases: Crear un anuncio de lanzamiento en el blog. Comparta el anuncio en las listas de correo y en las redes sociales.

Las pruebas

Las pruebas de Mocha se encuentran en el directorio de pruebas. Las pruebas se pueden ejecutar en el navegador o se pueden ejecutar a través de Node.js (npm run test:js).

Deja un comentario