Guidelines for archiving and referencing (research) software in Software Heritage

06 Sep 2019

Dear all,
one of the core goals of Software Heritage
is to support reproducible research, and
to this end it provides two essential and unique functionalities:
- a *universal archive* of software source code, because research
software depends on a myriad software components, that need all be archived
and referenced
- a *uniform identifier schema* that abstracts away the details of
source code provenance and version control, based on *intrinsic
identifiers* that are *compatible with git commit hashes *
I am delighted to share a first set of guidelines explaining how to
leverage these functionalities to seamlessly archive and reference the
source code of software in research articles and documentation:
- blog post with high level overview:
https://www.softwareheritage.org/2019/08/05/saving-and-referencing-resea...
- full detailed guidelines, with a running example and LaTeX snippets:
https://annex.softwareheritage.org/public/guidelines/archive-research-so...
Do not hesitate in reading/using/spreading the word, and of course all
feedback will be welcome.
All the best
--
Roberto Di Cosmo
P.S.: for advanced users that are interested in going further on the road
to reproducibility, it might be interesting to look into the combination of
Guix and Software Heritage, that is described in this older blog post:
https://www.softwareheritage.org/2019/04/18/software-heritage-and-gnu-gu...
------------------------------------------------------------------
Computer Science Professor
(on leave at INRIA from IRIF/University Paris Diderot)
Director
Software Heritage E-mail : ***@***.***
INRIA Web : http://www.dicosmo.org
Bureau C328 Twitter : http://twitter.com/rdicosmo
2, Rue Simone Iff Tel : +33 1 80 49 44 42
CS 42112
75589 Paris Cedex 12
------------------------------------------------------------------
GPG fingerprint 2931 20CE 3A5A 5390 98EC 8BFC FCCA C3BE 39CB 12D3