diff --git a/talks-public/2020-09-09-wooc/2020-09-09-wooc.org b/talks-public/2020-09-09-wooc/2020-09-09-wooc.org new file mode 100644 index 0000000..b2b296c --- /dev/null +++ b/talks-public/2020-09-09-wooc/2020-09-09-wooc.org @@ -0,0 +1,138 @@ +#+COLUMNS: %40ITEM %10BEAMER_env(Env) %9BEAMER_envargs(Env Args) %10BEAMER_act(Act) %4BEAMER_col(Col) %10BEAMER_extra(Extra) %8BEAMER_opt(Opt) +#+TITLE: Referencing (all) publicly available software source code +#+SUBTITLE: ... with Software Heritage ! +#+AUTHOR: Stefano Zacchiroli +#+DATE: 9 September 2020 +#+EMAIL: zack@upsilon.cc + +#+INCLUDE: "../../common/modules/prelude.org" :minlevel 1 +#+INCLUDE: "../../common/modules/169.org" +#+BEAMER_HEADER: \date[WOOC 2020]{9 September 2020\\Workshop on Open Citations\\and Open Scholary Metadata 2020\\[-2ex]} +#+BEAMER_HEADER: \institute[UParis \& Inria]{Université de Paris \& Inria --- {\tt zack@upsilon.cc, @zacchiro}} + +* Software Heritage + +** Software Heritage in a nutshell \hfill [[https://softwareheritage.org][softwareheritage.org]] + #+INCLUDE: "../../common/modules/swh-goals-oneslide-vertical.org::#goals" :only-contents t + +** The Software Heritage Archive \hfill [[https://archive.softwareheritage.org][archive.softwareheritage.org]] + #+INCLUDE: "../../common/modules/status-extended.org::#archive" :only-contents t + +* Saving and referencing research software + +** Saving and referencing research software +*** + 1. *Prepare your public repository*\\ + =README=, =AUTHORS=, & =LICENSE= files + metadata (e.g., CodeMeta) + 2. *Save your code*\\ + [[https://save.softwareheritage.org][https://save.softwareheritage.org]] + 3. *Reference your work* + #+BEAMER: \hfill + → using SWHIDs ! (next slide) \\ + full repository, specific version, or code fragment +*** Learn more + - /[[https://www.softwareheritage.org/2019/08/05/saving-and-referencing-research-software-in-software-heritage/][Saving and referencing research software in Software Heritage]]/\\ + on the Software Heritage blog, August 2019 + - /[[https://annex.softwareheritage.org/public/guidelines/archive-research-software.pdf][How to use Software Heritage for archiving and referencing your source + code: guidelines and walkthrough]]/ + #+BEAMER: \footnotesize + https://annex.softwareheritage.org/public/guidelines/archive-research-software.pdf + +** Software Heritage Identifiers (SWHIDs) \hfill [[https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html][(link to full spec)]] + # #+INCLUDE: "../../common/modules/swh-id-syntax.org::#swh-id-syntax" :only-contents t :minlevel 3 + #+LATEX: \centering%\forcebeamerstart + #+LATEX: \mode{\only<1>{\includegraphics[width=\linewidth]{SWHID-v1.4_1.png}}} + #+LATEX: \mode{\only<2>{\includegraphics[width=\linewidth]{SWHID-v1.4_2.png}}} + #+LATEX: \only<3->{\includegraphics[width=\linewidth]{SWHID-v1.4_3.png}} + #+LATEX: %\forcebeamerend +*** Standardization :B_block: + :PROPERTIES: + :BEAMER_act: <4-> + :BEAMER_COL: .6 + :BEAMER_env: block + :END: + - Linux Foundation [[https://spdx.github.io/spdx-spec/appendix-VI-external-repository-identifiers/#persistent-id][SPDX 2.2]] + - IANA registered "swh:" URI prefix + - Wikidata property [[https://www.wikidata.org/wiki/Property:P6138][P6138]] + #+BEAMER: \vspace{-1mm} +*** Examples :B_block: + :PROPERTIES: + :BEAMER_act: <5-> + :BEAMER_COL: .4 + :BEAMER_env: block + :END: + - [[https://archive.softwareheritage.org/swh:1:cnt:64582b78792cd6c2d67d35da5a11bb80886a6409;origin=https://github.com/virtualagc/virtualagc;lines=245-261/][Apollo 11 AGC excerpt]], + - [[https://archive.softwareheritage.org/swh:1:cnt:bb0faf6919fc60636b2696f32ec9b3c2adb247fe;origin=https://github.com/id-Software/Quake-III-Arena;lines=549-572/][Quake III rsqrt]] + + +** =biblatex-software= + #+BEAMER: \vspace{-1mm} +*** Referencing software with SWHIDs + - *citing v. referencing* software are separate concerns in scholarly works + - *referencing* is an often neglected need, but a particularly important + one in the context of scientific reproducibility + - *SWHID:* an identifier scheme to address source code referencing needs + #+BEAMER: \vspace{-1mm} +*** Citing software with =biblatex-software= \hfill (sample [[http://ctan.mines-albi.fr/macros/latex/contrib/biblatex-contrib/biblatex-software/biblio.bib][=.bib=]]) + - =biblatex-software=: a BibTeX extension to support citing software + - citable artifacts: *software*, *software versions*, *software modules*, + *code fragments* + - support SWHID (where appropriate) to /reference/ underling artifacts + #+BEAMER: \vspace{-1mm} +*** Learn more + - /[[https://www.softwareheritage.org/2020/05/26/citing-software-with-style/][Citing software with style]]/, Software Heritage blog, May 2020 + - /[[http://mirrors.ctan.org/macros/latex/contrib/biblatex-contrib/biblatex-software/software-biblatex.pdf][CTAN package documentation]]/ + +* Conclusion +** Wrapping up +*** strut :B_ignoreheading: + :PROPERTIES: + :BEAMER_env: ignoreheading + :END: + #+BEAMER: \vspace{-2mm} +*** + #+BEAMER: \small \setlength{\itemsep}{0pt} + - Software Heritage is the largest archive of *public software source + code*.\\ + It supports scholars in *archiving and referencing* source code relevant + to their work + - *Referencing and citing software* are separate concerns in scholarly + workflows + - *SWHID* identifiers are an adopted standard to /reference/ source code + artifacts + - *biblatex-software* allow to /cite/ software artifacts and integrates + well with SWHIDs + #+BEAMER: \vspace{-1mm} +*** strut :B_ignoreheading: + :PROPERTIES: + :BEAMER_env: ignoreheading + :END: + #+BEAMER: \vspace{-2mm} +*** + #+BEGIN_EXPORT latex + \begin{thebibliography}{Foo Bar, 1969} + \vspace{-1mm} + \scriptsize + \bibitem{Abramatic2018} Jean-François Abramatic, Roberto Di Cosmo, Stefano Zacchiroli + \newblock Building the Universal Archive of Source Code + \newblock Communication of the ACM, October 2018 + \bibitem{DiCosmo2020a} Roberto Di Cosmo, Morane Gruenpeter, Stefano Zacchiroli + \newblock Referencing Source Code Artifacts: a Separate Concern in Software Citation + \newblock Computing in Science \& Engineering, 2020, ISSN: 1521-9615 + \bibitem{DiCosmo2020d} Roberto Di Cosmo + \newblock Archiving and Referencing Source Code with Software Heritage + \newblock International Congress on Mathematical Software (ICMS), 2020 + \end{thebibliography} + #+END_EXPORT +*** strut :B_ignoreheading: + :PROPERTIES: + :BEAMER_env: ignoreheading + :END: + #+BEAMER: \vspace{-2mm} +*** + [[https://upsilon.cc/~zack/][Stefano Zacchiroli]] / [[mailto:zack@upsilon.cc][zack@upsilon.cc]] / [[https://twitter.com/zacchiro][@zacchiro]] / [[https://mastodon.xyz/@zacchiro][@zacchiro@mastodon.xyz]] + +* Appendix :B_appendix: + :PROPERTIES: + :BEAMER_env: appendix + :END: diff --git a/talks-public/2020-09-09-wooc/Makefile b/talks-public/2020-09-09-wooc/Makefile new file mode 100644 index 0000000..68fbee7 --- /dev/null +++ b/talks-public/2020-09-09-wooc/Makefile @@ -0,0 +1 @@ +include ../Makefile.slides