Evaluación interna - Fase del desarrollo del software

Para evaluar la integridad y el nivel de finalización de cada uno de los componentes se usará el Software Management Plan (SMP) for Life Sciences de ELIXIR.

Enlace al Software Management Plan (SMP): https://osf.io/preprints/biohackrxiv/k8znb.

El SMP de ELIXIR define las siguientes etapas en el proceso de desarrollo del software:

  1. Inicio. Incluye la definición del concepto, escritura de la propuesta, planificación e inicio.

  2. Construcción. Incluye prototipado, construcción e implementación de las funcionalidades principales

  3. Aplicación. Incluye lanzamiento y evaluación de la calidad.

  4. Producción. Incluye el uso del software bajo condiciones del mundo real, de manera escalable y estable.

  5. Publicación. Publicación del software y/o de resultados de investigación obtenidos a través del uso del software.

Para realizar la evaluación de cada componente, el SMP de ELIXIR analiza los parámetros definidos en la siguiente tabla. Dichos parámetros están basados en los conceptos FAIR de gestión abierta y transparente de datos.

Accesibilidad / Licencia

¿Como pueden acceder terceros al software?

  • Disponible publicamente (p.ej. GitHUb, via URL, etc.)
  • No es relevante/aplicable a este software
  • Otros

El software sin licencia no puede ser usado por otros. ¿El software tiene licencia?

  • NO
  • SI

En caso afirmativo, ¿que licencia tiene el software?

  • Lista SPDX
  • Otros
  • N/A
Documentación

¿Qué tipo de documentación está disponible, facilitada con el software y entregada bajo las mismas condiciones? (por favor, incluye una URL en caso de que esté disponible)

  • Documentación para Usuarios
  • Documentación para Programadores
  • Documentación APIs
  • Archivo README
  • Notas de lanzamiento (release)
  • Docstring/comentarios en el código fuente
  • Changelog
  • Otros (para más de uno, por favor, añadir varias filas)
  • Ninguna

¿Se especifica el propósito del software en la documentación?

  • NO
  • SI

¿Describe la documentación como...

 

 

...probar el software?

  • NO
  • SI

... usar el software?

  • NO
  • SI

...construir el software?

  • NO
  • SI
  • N/A

...desplegar el software?

  • NO
  • SI
  • N/A

...instalar el software?

  • NO
  • SI
  • N/A
Validación (Testing)

¿Qué tipo de validación se ha usado?

 

 

 

 

Ninguna

  • NO
  • SI

Unidad

  • NO
  • SI (Manual)
  • SI (Automática)

Integración

  • NO
  • SI (Manual)
  • SI (Automática)

Funcional

  • NO
  • SI (Manual)
  • SI (Automática)

End-to-end

  • NO
  • SI (Manual)
  • SI (Automática)

Linting

  • NO
  • SI (Manual)
  • SI (Automática)

Regresión

  • NO
  • SI (Manual)
  • SI (Automática)

Frontend-GUI

  • NO
  • SI (Manual)
  • SI (Automática)

Otros

 

¿Los datos de ejemplo  y/o parámetros que se pueden usar para probar el software están disponibles junto al código fuente?

  • SI
  • NO
  • N/A
Interoperabilidad

¿El software utiliza formatos de input/output estándar y pre-existentes?

  • NO
  • SI (parcialmente)
  • SI

En caso afirmativo (ya sea completa o parcialmente), por favor, seleccione los estándares que está usando de la lista.

 

Si no está listado, por favor utilice el registro FAIRsharing para proporcionar tant el nombre como la URL

 

Si no está listado en FAIRsharing, por favor, facilite una URL que sea automatizable si es posible.

  • Nombre (de cada estándar)
  • URL(de cada estándar)
  • Descripción (opcional) (de cada estándar)
Versionado

¿El software usa un sistema de control por versiones?

  • SI
  • NO

¿Que sistema de control por versiones usa?

  • Selección múltiple con Otros como texto
  • Git
  • Mercurial
  • Subversion
  • CVS
  • Otros

¿Usa versionado semántico?

  • SI
  • NO
Reproducibilidad

¿provees lanzamientos (releases) del software?

  • SI
  • NO

¿cómo defines dependencias lenguaje-específicas del software y su versión?

  • Texto
  • N/A

¿Cómo captura el entorno necesario para correr el software?

  • Texto
  • N/A

¿Provee ejemplos de inputs y outputs que se puedan usar para reproducir el funcionamiento del software?

En caso afirmativo, ¿donde se puede encontrar?

  • SI
  • NO

 

URL, por favor, indique la URL si está disponible.

¿Se especifica como los usuarios pueden informar de bugs y/o problemas de usabilidad?

P.ej. Indicando un correo, un protocolo de mensajes directos o indicando que no hay soporte de bugs.

  • SI
  • NO
Reconocimiento

¿Se incluye información de citación?

P.ej. Información de como citar tu software como citación.

  • SI
  • NO

 

¿los diferentes lanzamientos tienen un identificador global único persistente (PID)? (p.ej. DOI de ZENODO)

  • SI
  • NO

 

¿la información de citación incluye el ORCID de, al menos uno, los autores?

  • SI
  • NO

¿el software está registrado en un registro especifico de su dominio?

En caso afirmativo, por favor, liste los registros correspondientes (nombre y URL de cada uno).

  • SI
  • Nombre y URL
  • NO
  • N/A

 

Los desarrolladores de cada uno de los componentes descritos en la Implementación de Referencia deberán indicar en cual de las 4 etapas de desarrollo se encuentra su componente. A continuación completar el checklist del SMP de ELIXIR, indicando la respuesta a cada uno de los parámetros descritos. Esto permitirá evaluar de formar sistmática y metódica cada componente, indicando si para la fase de desarrollo indicada, el componente cumple con todos los parámetros esperados.

Software Management Wizard

Para facilitar la tarea a los desarrolladores y sistematizar al máximo el proceso de evaluación se usará el «Software Management Wizard» de Elixir.

Importante

Enlace al Software Management Wizard de Elixir: Software Management Wizard.

SMP componentes

Contacto

Para cualquier duda durante el periodo de uso y validación de los componentes de la Implementación de Referencia de IMPaCT-Data (Marzo, 2025), podéis poneros en contacto con: