Archiver, référencer et décrire

Les plateformes de référence pour l'archivage

Comme pour les données et les publications, il convient d’assurer la préservation à long terme d’un logiciel de recherche en l’archivant dans une plateforme adaptée.

Software Heritage (SWH) est une initiative, lancée par INRIA en 2016 et soutenue par l’UNESCO, qui vise à collecter, préserver, partager et archiver tous les logiciels disponibles publiquement sous forme de code source.

La plateforme Software Heritage permet de s’assurer très simplement de l’archivage et du référencement des logiciels disponibles publiquement et sans embargo. Le dépôt peut être également fait directement sur HAL. L’archive ouverte HAL permet, en collaboration avec Software Heritage, de gérer la description et la citation des logiciels de recherche.

Schéma de dépôt du code source d'un logiciel dans HAL et Software Heritage, description ci-dessous — Deux possibilités s’ouvrent à vous pour archiver vos logiciels : 1. Dépôt à partir d'un fichier compressé (format .zip/.tag.gz) de votre code source, développé localement, directement sur HAL. L'archivage sur Software Heritage est réalisé après un processus de modération sur HAL. 2. Dépôt du code source développé de manière collaborative depuis une forge logicielle type bitbucket ou Gitlab par exemple. Pour cela vous avez réalisé au préalable un archivage direct avec Software Heritage qui vous a fourni un SWHID que vous indiquez directement lors du dépôt sur HAL.

Comment documenter et préparer son logiciel

Personnage collection Passeport pour la science ouverte

La documentation de votre logiciel est fondamentale pour la recherche d’un logiciel, pour identifier son usage, spécifier le contexte et créditer plus facilement les créateurs.

En plus des métadonnées spécifiques à la discipline de recherche concernée par le code, il existe des schémas de métadonnées dédiés au logiciel :

Citation File Format (CFF)
Fichier schema.org, schéma de métadonnées généraliste
Fichier CodeMeta, est un format pour les métadonnées logicielles génériques, qui étend les fichiers schema.org

Pensez également à fournir les documents suivants :

- README : avec des informations telles que le nom du logiciel, sa description, le site web, lien vers la documentation, environnement de développement, mais aussi les usages, visuels ou nouveaux.

Pour réaliser un fichier README vous pouvez utiliser l'outil Software Release Practice HOWTO ou Make a README

- AUTHORS : Il identifie toutes les personnes autrices du logiciel.

- LICENCE : Lorsqu’il n’y a pas de licence associée, tous les droits sont réservés. Ce fichier va identifier les conditions de consultation et réutilisation de votre logiciel.

Consultez la page "questions juridiques" pour aller plus loin.