6 - Valoriser

Valoriser auprès de la communauté scientifique

• Associer publications-données-logiciels
• Citer un logiciel
• Les articles exécutables
• Les software papers

Commencer

Associer publications-données-logiciels

Associer publications-données-logiciels

Pourquoi ?

Les laboratoires sont producteurs de logiciels et de codes sources développés pour traiter les données issues de la recherche scientifique. Si l’archivage des données de la recherche dans la perspective de leur réutilisation a donné lieu à la mise en place d’infrastructures dédiées, les logiciels et codes sources utilisés dans le cadre de l’analyse répondent aux mêmes impératifs : la reproductibilité des résultats de recherche (résultats similaires dans des conditions identiques) implique la réutilisation des mêmes outils lors du traitement.

Les bonnes pratiques dans HAL

Citer un logiciel

Citer un logiciel

Or, cette pratique ne permet pas d’identifier facilement et avec certitude le logiciel en question. Par ailleurs, il n’existe pas toujours d’article associé au logiciel : il peut avoir été développé en dehors d’une communauté académique, ou simplement, n’avoir jamais été présenté dans une revue. Cela renforce donc le besoin de citer le logiciel lui-même, au même titre qu’ une autre ressource académique.

Les pratiques de citation de logiciels ne sont pas encore très codifiées dans les communautés académiques. Il n’existe pas de standard descriptif. Cependant, sur la base de recommandations d’experts, il existe une proposition de noyau minimal d’informations à mentionner.

Citer un logiciel s’avère nécessaire lorsque celui-ci a joué un rôle déterminant dans la réalisation des travaux de recherche. La question suivante peut servir de repère : dans quelle mesure le logiciel a-t-il un impact direct sur les résultats obtenus ? En pratique, il est courant de voir la citation d'un article décrivant le logiciel, plutôt que le logiciel lui-même.

voir

À INRAE

Les articles exécutables

Les articles exécutables

A noter que ce type de publication est donc uniquement adapté à la recherche qui s’appuie sur du code informatique !

C'est quoi ?

Quelle forme ?

Pourquoi publier ?

Comment écrire un article exécutable ?

L'article exécutable permet donc...

Les lecteurs et lectrices ont accès à un article interactif où il est possible de rejouer les codes progressivement tout au long de l’article.

Pendant le processus de soumission

Le ou la reviewer peut rejouer et même modifier les codes utilisés ce qui permet d’améliorer le code par les interactions entre auteurs, autrices et reviewers

Après publication

Ces 2 aspects ont un fort impact pour la Science Ouverte et la reproductibilité de la recherche dans les publications.

Les software papers

Les software papers

C'est quoi ?

Pourquoi publier ?

Quelle forme ?

Où publier ?

Quelle licence ?

Ce support a été créé dans le cadre de la formation à la science ouverte

développée par la Direction pour la science ouverte d'INRAE

A réutiliser sans modération

Les bonnes pratiques dans HAL

Lorsqu’un logiciel est déposé dans HAL INRAE, la notice obtenue affiche une métadonnée Ressources associées permettant de faire le lien vers les jeux de données stockés dans des entrepôts distincts et également vers les publications issues de la recherche, disponibles dans une archive en ligne. Cette configuration lie l’ensemble des éléments constituant le triptyque publications-données-logiciels pour les mettre à la disposition de l’utilisateur et de l'utilisatrice et améliorer le dialogue entre les différents entrepôts et archives.

Pensez à mentionner clairement la licence dans les fichiers déposés afin de valider le champ dédié dans HAL qui est obligatoire pour ce type de dépôt.

Quelle licence ?

Le logiciel décrit est généralement accessible sous une licence permettant de le réutiliser. L’article doit faire un lien vers la version du logiciel au moment de la publication de l’article et peut aussi faire un lien vers les versions plus récentes. Le lecteur ou la lectrice peut donc facilement se faire une idée de l’intérêt du logiciel et accéder au code pour le réutiliser ou le faire évoluer.

Quelle forme ?

Les articles exécutables sont écrits dans des logiciels dynamiques (notebook jupyter, quarto, etc.) intégrant du markdown ou LaTeX pour le texte et un ou des langages de programmation pour le code (python, julia, R etc.).

Où publier un software paper ?

Dans une revue en informatique publiant exclusivement des software papers ou dans une revue classique.

Liste « Où publier ? » du CIRAD Liste du Software Sustainability Institut

Pour aller plus loin : Un article : Romano JD, Moore JH (2020) Ten simple rules for writing a paper about scientific software. PLOS Computational Biology 16(11): e1008390. Un article du blog de l'Institut Pasteur Une ressource DoRANum en 10 chapitres

Quelle forme ?

Généralement plus courts que les articles traditionnels, la forme des software papers peut varier selon les revues. Certains articles sont focalisés sur le logiciel alors que d’autres décrivent une question de recherche originale qui inclut le développement d’un nouveau logiciel. Voici quelques exemples :

• Picault S, Huang Y-L, Sicard V, Arnoux S, Beaunée G, Ezanno P (2019) EMULSION: Transparent and flexible multiscale stochastic models in human, animal and plant epidemiology. PLoS Comput Biol 15(9): e1007342.
• Koutsovoulos GD, Granjeon Noriot S, Bailly-Bechet M, Danchin EGJ, Rancurel C (2022) AvP: A software package for automatic phylogenetic detection of candidate horizontal gene transfers. PLoS Comput Biol 18(11): e1010686.
• Villani, V., & Tsakiris, M. (2023). Cuspis: A MATLAB Suite for Tasks Investigating Heart-Brain Interactions during fMRI. Journal of Open Research Software, 11(1), 15.
• Madsen J and Susi T. The abTEM code: transmission electron microscopy from first principles [version 2; peer review: 2 approved]. Open Res Europe 2021, 1:24
• Elbaz, M., Buterman, R. & Ezra Tsur, E. NeuroConstruct-based implementation of structured-light stimulated retinal circuitry. BMC Neurosci 21, 28 (2020).

C’est quoi un software paper ?

Un software paper (ou software article ou software tool articles) est une publication revue par les pairs dont l’objectif est de présenter un logiciel à la communauté scientifique. Il est l’équivalent d’un data paper mais pour publier des codes, scripts, algorithmes, logiciels. Il décrit un logiciel qui a été développé pour la recherche, les objectifs ayant conduit à son développement, le processus de conception, les détails techniques sur son fonctionnement, des instructions sur la façon de l’utiliser, son potentiel de réutilisation…

Proposition d'informations minimales à mentionner pour citer un logiciel

• Le nom du logiciel de la manière la plus précise possible (par exemple le nom du package)
• La date de mise à disposition de la version ou, à défaut, la date d’utilisation du logiciel par l’utilisateur, à l’exemple de ce qui se pratique pour les citations de pages web
• L’auteur du logiciel
• La localisation initiale (par exemple le lien vers la plateforme de développement)
• L’identifiant pérenne (par exemple le SWHID)

Exemple : Jean-Christophe Fabre, Aline Libres, Armel Thöni, Michael Rabotin, Manuel Chataignier. OpenFLUID : a software platform for spatial modelling in landscapes. 2020, ⟨swh:1:dir:342fe58efc0054e282e3b934154c5f48713ac320;origin=https://hal.archives-ouvertes.fr/hal-03010066;visit=swh:1:snp:83cd81d6b14f41d9444d90c68704ce412ab83ebd;anchor=swh:1:rev:6f9f4ac9753ccd66517be62a6d03d986ce6584d4;path=/⟩. ⟨hal-03010066⟩

Pour en savoir plus :

MIT Library

Force 11

Programming Historian

Pourquoi publier un software paper ?

Publier un software paper permet de :

• Faire connaître un logiciel et toucher un grand nombre d’utilisateurs et utilisatrices potentiel.les.
• Démontrer que le logiciel est robuste et de haute qualité, puisque l’article est passé par un processus de révision par les pairs. A noter que le code associé à la publication n’est pas toujours examiné lors du peer-reviewing (tout dépend de la revue), mais la disponibilité du code et sa description détaillée permettent au lecteur ou à la lectrice de se faire sa propre opinion.
• Faire preuve de transparence sur le processus de développement du logiciel et sur le code lui-même (évite les « boîtes noires »).
• Valoriser le travail des développeur.ses et le temps passé pour que le logiciel soit robuste, bien documenté, facile à utiliser, maintenu…

Ecrire un article exécutable

Écrire un article exécutable ou notebook demande beaucoup de rigueur et d’anticipation. Comme ce type d’article repose sur la disponibilité des données, des codes et de la documentation associée, il est nécessaire de prévoir ces aspects dès le début de la recherche. Il est en effet très compliqué de transformer un article non exécutable en exécutable sans l’avoir prévu dès le début du projet.

Quelques exemples de journaux dynamiques :

Quelques recommandations pour écrire un article exécutable :

• Computo Journal
• eLife
• F1000Research

• Utiliser directement une programmation dynamique (Jupyter, quarto)
• Utiliser directement un système de versioning (git via gitlab, SVC...)
• Documenter régulièrement la démarche utilisée et le code écrit (oxygen)
• Suivre les bonnes pratiques de gestion et partage des données afin qu’elles soient bien organisées, documentées et mises à disposition sur des entrepôts de données facile d’accès (ie. Recherche Data Gouv).

Pour en savoir plus...

Article du blog de l'Institut Pasteur

Ressource DoRANum sur le Notebook

Pourquoi publier un article exécutable ?

Ces logiciels dynamiques permettent donc de combiner le texte de l’article correctement formaté (avec possibilité d’utiliser l’avantage d’écrire des formules mathématiques, du pseudo-code, d’intégrer des images, des gifs, tout type de media utiles...) avec des données analysées via le code écrit et exécuté dans l’article.

C’est quoi un article exécutable ?

Les articles exécutables (Executable Research Articles ou Executable papers en anglais) ou encore appelés notebooks ou articles computationnels sont une combinaison de code et de texte permettant de rendre la recherche plus reproductible.

Un article du blog de l'Institut Pasteur