Le logiciel joue un rôle clé dans la recherche scientifique, dont il est à la fois un outil, un résultat et un objet d’étude. La mise à disposition des codes sources des logiciels, avec la possibilité de les modifier, les réutiliser et les diffuser, est un enjeu majeur pour permettre la reproductibilité des résultats scientifiques et soutenir le partage et la création de connaissances, dans une logique de Science ouverte.
Deuxième Plan national pour la Science ouverte

Pourquoi archiver votre code source ?

  • Palier la « fragilité » du code source et garantir une conservation pérenne

Les forges logicielles (GitLab, GitHub, etc.), ne sont pas des archives pérennes : les projets qu’elles contiennent peuvent être modifiés ou effacés, et ces plateformes peuvent également disparaître.

  • Assurer une grande visibilité aux logiciels

Grâce à la complémentarité entre Software Heritage et HAL

  • Vous inscrire dans une démarche de science ouverte

L’ouverture des codes sources est une des mesures inscrites dans le second plan pour la Science ouverte
 

Où archiver ?

 
Logo software heritage
Logo software heritage
Développé par l’Inria en partenariat avec l’UNESCO, Software Heritage (SWH) est une archive universelle du code source des logiciels. Son but est de collecter, organiser, préserver, partager et permettre de réutiliser les logiciels open source.

HAL et Software Heritage offrent une complémentarité de services pour la diffusion, l’accessibilité et l’archivage pérenne des logiciels de recherche.

Comment archiver ?

Le logiciel a été développé sur une plateforme de développement en ligne

Le logiciel a été développé sur une plateforme de développement en ligne incluant un outil de contrôle de version telles que : GitLab, GitHub, etc...

Vérifier les données

  • vérifier que le code source soit déjà archivé dans SWH : la plateforme moissonne les forges logicielles, il est probable que le code soit déjà présent
  • vous assurer que les fichiers obligatoires soient bien présents : Readme, Authors et License
    • README : explique à quels besoins répond le logiciel que vous déposez, voir aussi Make a README
    • AUTHORS : contient la liste de tous les auteurs et des contributeurs éventuels.
    • LICENSE (ou COPYING) : décrit les droits d’utilisation du code source déposé. La licence est à choisir en collaboration avec les services de valorisation des organismes de rattachement des auteurs. Il est notamment possible d’attribuer plusieurs licences à un même logiciel. Voir aussi la section Choisir une licence pour un code source de logiciel dans la documentation.
  • optionnel mais fortement recommandé : le fichier CodeMeta décrit le logiciel, son contexte de création : https://codemeta.github.io/codemeta-generator/


Valoriser votre code source

HAL
HAL
La plateforme HAL permet de déposer le code source d'un logiciel de recherche. Cela va favoriser sa visibilité et sa citabilité.

Si vous avez joint un fichier CodeMeta au code source archivé, vous pouvez récupérer les métadonnées à partir du SWHID, identifiant pérenne attribué par Software Heritage, pour faciliter votre dépôt dans HAL.
 
Le logiciel a été développé en dehors d'une plateforme de développement en ligne

Le logiciel a été développé en local etc...
Pour le diffuser, vous devez préparer le code source :

  • créer les fichiers : Readme, Authors et License
  • compresser le dossier en format .zip
  • déposer mon logiciel dans HAL :
  • télécharger le dossier et complète les métadonnées
  • autoriser le transfert du code source vers Software Heritage

Vous avez besoin d’aide pour déposer votre code source dans HAL ou l’archiver dans Software Heritage ?
Contactez-nous

Pour aller plus loin :