Comment faire

Comment utiliser Software Heritage dans son activité de recherche ?

L’archive Software Heritage (que nous vous présentions ici) comprend des millions de codes sources de logiciels, dans des domaines variés et dans une grande variété de langages de programmation. Cette archive peut donc constituer une ressource très utile dans votre activité de recherche. Mais comment l’utiliser, quelles sont les fonctionnalités qui pourraient vous être utiles ? Voici quelques manières de l’utiliser :

Trouver des codes source sur l’archive

Vous pouvez rechercher des bibliothèques et des logiciels open source existants, ce qui peut vous faire économiser beaucoup de temps et d’efforts de développement.

Ainsi, dans la barre de recherche de l’archive, vous pouvez rechercher des termes, soit dans l’URL du logiciel (cette URL correspond à l’emplacement d’origine du code, par exemple dans git), soit dans les métadonnées associées au code. Par exemple, en cherchant par le nom de la bactérie Klebsiella, vous pourrez trouver si un logiciel a été développé dans le cadre de travaux sur cette bactérie.

Il vous suffit ensuite de cliquer sur une URL dans les résultats de recherche pour accéder à l’interface de consultation du code source.

Naviguer dans l’interface de consultation du code source

Une fois sur l’interface de consultation du code (par exemple celle-ci), vous pouvez notamment :

  • Accéder directement à l’emplacement où le code source a été capturé, en cliquant sur la flèche à droite de l’URL ;
  • Consulter l’historique des révisions du code, en cliquant sur le bouton History (exemple ici). La première colonne de l’historique propose des liens pour parcourir le code source tel qu’il était à chaque révision. Cela peut vous aider à comprendre comment un projet a évolué au fil du temps, à identifier les problèmes rencontrés par les développeurs et les solutions trouvées pour y répondre.
  • Télécharger l’ensemble du répertoire que vous êtes en train de consulter au format tar.gz en cliquant sur le bouton Download.

Citer le code ou un morceau de code

Une fonctionnalité très intéressante de Software Heritage est sa capacité à générer des identifiants uniques et pérennes (SoftWare Heritage persistent IDentifiers, SWHIDs) pour permettre de citer facilement différents “objets” (répertoire, code, révision…).

Concrètement, vous pouvez à tout moment cliquer sur le bouton Permalinks à droite de votre page pour citer l’élément que vous êtes en train de consulter. Par exemple, si vous sélectionnez certaines lignes de codes et que vous cliquez sur ce bouton, Software Heritage génère automatiquement un identifiant et un lien pérenne vers ce morceau de code (exemple : ce permalien fait le lien vers les lignes 4 à 23 du code Risk_factor_mod_B.stan).

Vous pouvez ainsi incorporer dans vos publications des permaliens vers des parties de votre code, afin de souligner l’importance de certaines commandes ou l’apport de certains bouts de code dans votre travail.

 

Pour aller plus loin sur l’utilisation de Software Heritage, n’hésitez pas à suivre la visite guidée de l’interface.

Print Friendly, PDF & Email