diff --git a/common/images/citation_format_en.png b/common/images/citation_format_en.png new file mode 100644 index 0000000..fb8e95d Binary files /dev/null and b/common/images/citation_format_en.png differ diff --git a/common/images/deposit_communication_en.png b/common/images/deposit_communication_en.png new file mode 100644 index 0000000..002f9b1 Binary files /dev/null and b/common/images/deposit_communication_en.png differ diff --git a/common/images/software_life_cycle_en.png b/common/images/software_life_cycle_en.png new file mode 100644 index 0000000..79e9a8e Binary files /dev/null and b/common/images/software_life_cycle_en.png differ diff --git a/talks-public/2018-03-21-RDA-plenary-Poster/2018-01-22-JSO2018-Poster.tex b/talks-public/2018-03-21-RDA-plenary-Poster/2018-01-22-JSO2018-Poster.tex index 508e7bf..c72fce3 100644 --- a/talks-public/2018-03-21-RDA-plenary-Poster/2018-01-22-JSO2018-Poster.tex +++ b/talks-public/2018-03-21-RDA-plenary-Poster/2018-01-22-JSO2018-Poster.tex @@ -1,345 +1,366 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % MUW Poster % LaTeX Template % Version 1.0 (31/08/2016) % (Based on Version 1.0 (31/08/2015) of the Jacobs Portrait Poster % % License: % CC BY-NC-SA 3.0 (http://creativecommons.org/licenses/by-nc-sa/3.0/) % % Created by: % Nicolas Ballarini, CeMSIIS, Medical University of Vienna % nicoballarini@gmail.com % http://statistics.msi.meduniwien.ac.at/ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Software Heritage poster % % License: % CC BY-SA 4.0 (http://creativecommons.org/licenses/by-sa/4.0/) % Created by: % the Software Heritage team % contact: morane@softwareheritage.org %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \def\footer#1{\def\insertfooter{#1}} %-------------------------------------------------------------------------------------- % PACKAGES AND OTHER DOCUMENT CONFIGURATIONS %-------------------------------------------------------------------------------------- \documentclass[final]{beamer} \usepackage[scale=1.150]{beamerposter} % Use the beamerposter package \usetheme{MUWposter} % Use the MUWposter theme supplied with this template % Include a logo of your project if desired \logo{\pgfputat{\pgfxy(-10,102)}{\pgfbox[center,base]{\includegraphics[width=13cm]{../../common/logos/hal-inria-ccsd-swh-logo.png}}}} \usepackage{multicol} \usepackage{array} %The following two are column definitions for the aknowledgements section \newcolumntype{L}{>{\arraybackslash}m{22cm}} \newcolumntype{S}{>{\arraybackslash}m{5cm}} \usepackage{pgf} \usepackage{mathtools} \usepackage{amsmath, amsthm, amssymb, amsfonts} \usepackage{exscale} \usepackage{xcolor} \usepackage{ushort} \usepackage{setspace} \usepackage[square,numbers]{natbib} \usepackage{url} \bibliographystyle{abbrvnat} \renewcommand{\vec}[1]{\ushort{#1}} \renewcommand{\vec}[1]{\mathbf{#1}} \definecolor{greenMUW}{RGB}{60,191,174} \definecolor{blueMUW}{RGB}{17,29,79} \definecolor{skinMUW}{RGB}{254,228,217} \definecolor{hellblauMUW}{RGB}{95,180,229} \definecolor{swhred}{RGB}{252,43,20} \usepackage{xcolor} \usepackage{graphicx} \usepackage{wrapfig} %----------------------------------------------- % START Set the colors % Uncomment to apply colors you want to use. %----------------------------------------------- \colorlet{themecolor}{swhred} \usebackgroundtemplate{\includegraphics{background}} %\colorlet{themecolor}{skinMUW} %\colorlet{themecolor}{blueMUW} %\usebackgroundtemplate{\includegraphics{MUW_skin.pdf}} %%\colorlet{themecolor}{blueMUW} %\colorlet{themecolor}{hellblauMUW} %\usebackgroundtemplate{\includegraphics{MUW_hellblau.pdf}} %----------------------------------------------- % END Set the colors %----------------------------------------------- %----------------------------------------------- % START Set the width of the columns %----------------------------------------------- \setlength{\paperwidth}{33.1in} % A0 width: 46.8in \setlength{\paperheight}{46.8in} % A0 height: 33.1in \newlength{\sepmargin} \newlength{\sepwid} \newlength{\onecolwid} \newlength{\twocolwid} \newlength{\threecolwid} % The following measures are used for 2 columns %\setlength{\sepmargin}{0.055\paperwidth} % Separation width (white space) between columns %\setlength{\sepwid}{0.03\paperwidth} % Separation width (white space) between columns %\setlength{\onecolwid}{0.43\paperwidth} % Width of one column %\setlength{\twocolwid}{0.9\paperwidth} % Width of two columns %----------------------------------------------------------- % The following measures are used for 3 columns \setlength{\sepmargin}{0.06\paperwidth} % Separation width (white space) between columns \setlength{\sepwid}{0.02\paperwidth} % Separation width (white space) between columns \setlength{\onecolwid}{0.28\paperwidth} % Width of one column \setlength{\twocolwid}{0.58\paperwidth} % Width of two columns %\setlength{\threecolwid}{0.88\paperwidth} % Width of three columns \setlength{\columnsep}{30pt} %----------------------------------------------- % END Set the width of the columns %----------------------------------------------- %-------------------------------------------------------------------------------------- % TITLE SECTION %-------------------------------------------------------------------------------------- \setbeamertemplate{title}[center] \setbeamertemplate{frametitle}[default][center] \setmainfont{Alegreya-sans} \subtitle{The creation of a new type of scientific deposit:} \title{Software} % Poster title \author{CCSD¹, HAL-Inria², Software Heritage³} % Author(s) \institute{Y. Barborini¹, R. Di Cosmo³, A.R. Dumont³, M. Gruenpeter³, B. Marmol¹, A. Monteil², J. Sadowska², S. Zacchiroli³} % Institution(s) %-------------------------------------------------------------------------------------- \begin{document} \addtobeamertemplate{block end}{}{\vspace*{1ex}} % White space under blocks \addtobeamertemplate{block alerted end}{}{\vspace*{0ex}} % White space under highlighted (alert) blocks \setlength{\belowcaptionskip}{2ex} % White space under figures \setlength\belowdisplayshortskip{1ex} % White space under equations \begin{frame}[t] % The whole poster is enclosed in one beamer frame \begin{columns}[t] % The whole poster consists of two major columns \begin{column}{\sepmargin}\end{column} \begin{column}{\twocolwid} % The first column \begin{block}{Software preservation: a scientific challenge} + Software has become an indisociable support of + \textbf{technical and scientific knowledge}. + The preservation of this universal + body of knowledge has become as essential as preserving research + articles and data sets. + + Software preservation is a pillar of \textbf{reproducibility}. - Les logiciels sont devenus le support indissociable des - \textbf{connaissances techniques et scientifiques} de l’humanité - tout entière. Ils constituent un véritable socle pour les sciences. - La préservation des logiciels est à la base de - \textbf{la reproductibilité}. L’utilisation des logiciels - intervient à toutes les étapes de la recherche, dans tous - les domaines scientifiques, et se révèle essentielle - à de multiples égards. \end{block} % space between cycle and intro (- up, + down) \vspace*{-1cm} \begin{figure} \raggedleft % making cycle more central (- to left, + to right) -\hspace*{28cm} -\includegraphics[width=.44\linewidth]{../../common/images/software_life_cycle_fr.png} +\hspace*{24cm} +\includegraphics[width=.52\linewidth]{../../common/images/software_life_cycle_en.png} \end{figure} \end{column} \begin{column}{\sepmargin}\end{column} \begin{column}{\onecolwid} \begin{block}{} %\begin{multicols}{2} \end{block} \end{column} \begin{column}{\sepmargin}\end{column} \end{columns} % space between two columns and intro (- up, + down) \vspace*{-10cm} \begin{columns} \begin{column}{\sepmargin}\end{column} \begin{column}{\onecolwid} % space between one column and intro (- up, + down) -\vspace*{-7 cm} +\vspace*{-13 cm} + +In the quest for making scientific results +reproducible, and pass the knowledge over to future +generations, the three main pillars are: \textbf{scientfic articles}, +that describe the results, the \textbf{data sets} used or produced, and the +\textbf{software} that embodies the logic of the data transformation[1]. \begin{figure} -\vspace*{-1cm} +\vspace*{0cm} -\includegraphics[width=.5\linewidth]{../../common/images/preservation_triangle_color.png} -\caption{Les piliers de la préservation de la connaissance} +\includegraphics[width=.82\linewidth]{../../common/images/preservation_triangle_color.png} +\caption{The pillars of knowledge preservation} \end{figure} % space between figure and text (- up, + down) -\vspace*{-2.3cm} +\vspace*{-4cm} \begin{block} - Dans la quête pour la reproductibilité des résultats scientifiques - et la transmission des connaissances scientifiques aux générations futures, les trois piliers principaux sont: - des articles scientifiques, - décrivant les résultats, les ensembles de données et les logiciels utilisés ou produits[1]. \end{block} -\begin{block}{Le dépôt logiciel} -La collaboration entre \textbf{Software Heritage (SWH), Hal-Inria et le CCSD} a permis l'ouverture de Hal vers le nouveau type de données scientifiques: \\ -\textit{le logiciel}.\\ -Les chercheurs ont désormais la possibilité de \\ déposer* le code source via Hal-Inria tout en\\ contribuant au patrimoine logiciel constitué par SWH. +\begin{block}{Software deposit} +The collaboration between \textbf{Software Heritage (SWH), Hal-Inria and the CCSD} +has resulted with a new type of scientific deposit in the national open archive.\\ +Researchers have now the possibility to deposit \\ +\textit{software} source code on Hal-Inria. +\vspace*{-2cm} \begin{figure} -\includegraphics[width=1\linewidth]{../../common/images/HAL_form.png} -\caption{Le formulaire dédié au dépôt de logiciel} +\includegraphics[width=1.1\linewidth]{../../common/images/HAL_form.png} +\caption{The form dedicated to software deposits} \end{figure} -Les étapes pour le dépôt de logiciel: +The steps for a software deposit: \begin{itemize} - \item déposer une archive du code source (.zip) - \item choisir le type de dépôt : \textit{Logiciel} - \item ajouter les métadonnées associées - \item ajouter les auteurs du logiciel - \item valider l'archivage du logiciel sur SWH + \item deposit a source code archive(.zip) + \item choose deposit type : \textit{software} + \item add associated metadata + \item add the software authors + \item accept the archival of the deposit on SWH \end{itemize} -\begin{flushright} -\footnotesize{* ouverture printemps 2018} -\end{flushright} +%\begin{flushright} +%\footnotesize{* ouverture printemps 2018} +%\end{flushright} \end{block} \end{column} \begin{column}{\sepmargin} \end{column} \begin{column}{\onecolwid} % space between cycle and caption (- up, + down) \vspace*{9cm} \begin{figure} -\caption{Le cycle de vie du logiciel de recherche} +\caption{The life cycle of research software} \end{figure} % space between caption and metadata block (- up, + down) \vspace*{-4cm} \begin{block} -\textbf{Les métadonnées} +\textbf{The descriptive metadata} \\ - Des métadonnées pour bien décrire le logiciel sont disponibles sur le formulaire de dépôt et sont préservées avec le logiciel dans l'archive SWH. - +To ensure an accurate description of the software, different metadata +are available on the deposit form and are preserved with the software in the +SWH archive. Here an example: \begin{table}[] \centering \small \begin{tabular}{llll} -\textbf{Fournie par le système:} & & \textbf{ Obligatoire:} & \\ -- identifiant Hal & & - titre & \\ -- date de publication & & - description & \\ -- SWH-ID & & - auteurs & \\ +\textbf{Provided by the system:} & & \textbf{ \textit{MUST:}} & \\ +- Hal identifier & & - title & \\ +- publication date & & - description & \\ +- SWH-ID & & - authors & \\ & & &\\ -\textbf{Recommandée:} & & \textbf{Possible:} & \\ -- licence & & - dépendances & \\ -- mots-clés & & - platform/OS & \\ -- repository & & - financement & \\ +\textbf{\textit{SHOULD:} } & & \textbf{\textit{MAY:}} & \\ +- license & & - dependencies & \\ +- keywords & & - platform/OS & \\ +- repository & & - funding & \\ \end{tabular} \end{table} -\textbf{L'identifiant intrinsèque et pérenne} +\textbf{The intrinsic and persistent identifier} \\ -Software Heritage fournit l'identifiant \textit{SWH-ID}, intrinsèquement lié aux composants logiciels, garantissant une traçabilité pérenne à travers les futures évolutions du développement logiciel et de l'orga- nisation. - Le \textit{SWH-ID} comme une empreinte digitale du logiciel est spécifique, pérenne et unique et ne dépend pas d'un résolveur. \\ - Pour reproduire une expérience, il est indispensable de connaître avec exactitude la version du logiciel. - \end{block} - \begin{figure} -\includegraphics[width=0.95\linewidth]{../../common/images/HAL_deposit.png} -\caption{Le dépôt final sur Hal-Inria} +To be able to reproduce an experiment, knowing the exact version +of the software used is essential. +Software Heritage will provide the \textit{SWH-ID}, +intrinsically bound to software components, ensuring persistent traceability +across future development and organizational changes. +The \textit{SWH-ID}, like a finger print of the Software is specific, +persitent and unique and does not depend on an ID resolver. +\end{block} +\begin{figure} +\includegraphics[width=1\linewidth]{../../common/images/HAL_deposit.png} +\caption{The deposit on Hal-Inria} \end{figure} - \end{column} - \begin{column}{\sepmargin} \end{column} - \begin{column}{\onecolwid} +\end{column} +\begin{column}{\sepmargin} \end{column} +\begin{column}{\onecolwid} - \end{column} - \begin{column}{\sepmargin} \end{column} +\end{column} +\begin{column}{\sepmargin} \end{column} - \end{columns} +\end{columns} \begin{columns} \begin{column}{\sepmargin} \end{column} \begin{column}{\twocolwid} % space between deposit and actors (- up, + down) -\vspace*{-2.7cm} -\begin{block}{Les acteurs} -\textbf{Software Heritage} a relevé le défi de collecter, préserver et partager les logiciels sous leur forme fondamentale : leur code source. -\textbf{Hal-Inria} est l'archive ouverte d'Inria- Institut national de recherche dédié au numérique. Elle permet, depuis 2005, de déposer des publications et d'accéder à l'ensemble du portail Hal développé par le \textbf{ CCSD - Centre pour la Communication Scientifique Directe} dont la mission principale est de fournir, dans l’esprit du libre accès, des outils pour l’archivage, la diffusion et la valorisation des publications et des données scientifiques. +\vspace*{-4cm} +\begin{block}{The actors} +\textbf{Software Heritage} took the challenge to collect, +preserve and share all software that is publicly available in source code form. +\textbf{Hal-Inria} is the open archive of Inria- The French Institute for +Research in Computer Science and Automation. +Hal-Inria provides, since 2005, access to the Hal platform, developped by the +\textbf{ CCSD}- The Center for Direct Scientific Communication. Its main +mission is to provide tools, in the respect of open access principles, +for archiving and the dissemination of scientific publications and data. \end{block} \end{column} \begin{column}{\sepmargin} \end{column} \begin{column}{\onecolwid} % space before column start (- up, + down) -\vspace*{-78cm} -\begin{block}{L'archivage du dépôt} -Une fois le dépôt validé il est poussé grâce au protocole SWORD sur Software Heritage. -SWH procède à l'injection du logiciel dans la Bibliothèque d'Alexandrie du code source et génère l'identifiant intrinsèque - le \textit{SWH-ID}. Hal revient récupérer le \textit{SWH-ID} qui est mis à disposition sur la page du dépôt et dans le format de citation. +\vspace*{-80.5cm} +\begin{block}{The archiving of the deposit} +Once the deposit is validated, it is pushed to SWH using SWORD protocol. +SWH will proceed with the injection of the source code into the +\textbf{Library of Alexandria of Software} and +will generate the intrinsic identifier - the \textit{SWH-ID}. +Hal retrieves the \textit{SWH-ID} to use in the citation format. \vspace*{1cm} \begin{figure} \centering -\includegraphics[width=.7\linewidth]{../../common/images/deposit_communication.png} -\caption{Le processus de dépôt et d'archivage} +\includegraphics[width=.9\linewidth]{../../common/images/deposit_communication_en.png} +\caption{The software deposit work flow} \end{figure} \vspace*{-1cm} \begin{figure} \includegraphics[width=.9\linewidth]{../../common/images/SWH_deposit.png} -\caption{Feuilleter le dépôt sur Software Heritage} +\caption{Browse the deposit on Software Heritage} \end{figure} \end{block} -\vspace*{-1.5cm} -\begin{block}{La citation du logiciel} - Suivant les principes de citation de logiciel [2] et en considérant ainsi que le logiciel est \textbf{un produit légitime et citable de recherche}, le format de citation proposé sur Hal contient une partie des métadonnées obligatoires soumises avec le logiciel. +\vspace*{-1.3cm} +\begin{block}{Software citation} + Following the software citation principles [2]and thus considering that + Software is a legitimate and citable product of + research, we have proposed a citation format containing metadata + submitted with the software. \begin{figure} \centering -\includegraphics[width=.7\linewidth]{../../common/images/citation_format_fr.png} - \caption{Le format de citation d'un logiciel[3]} +\includegraphics[width=.9\linewidth]{../../common/images/citation_format_en.png} + \caption{Software citation format[3]} \end{figure} - -La citation est indispensable pour promouvoir le rôle du logiciel dans la recherche et s'assurer que les développeurs de logiciels de recherche voient leurs contributions reconnues et récompensées[4]. +\vspace*{-.5cm} + Citation is essential for promoting the recognition of software as a valuable research output, and ensuring that the authors have their contributions recognised and rewarded [4]. +\vspace*{-.5cm} \end{block} \begin{block}{\large Références} \small 1.Roberto Di Cosmo, Stefano Zacchiroli (2017) Software Heritage: Why and How to Preserve Software Source Code. iPRES 2017. https://hal.archives-ouvertes.fr/hal-01590958\\ 2.Smith et al. (2016), Software citation principles. PeerJ Comput. Sci. 2:e86; DOI 10.7717/peerj-cs.862.\\ 3.Yolanda Gil (2015) Documenting Software through Metadata. Geosoft.\\ 4.Mike Jackson (2014) How to cite and describe software. The Software Sustainability Institute https://www.software.ac.uk/how-cite-and-describe-software \end{block} \end{column} \begin{column}{\sepmargin} \end{column} \end{columns} \vspace*{1cm} \includegraphics[width=.18\linewidth]{../../common/logos/CC_by_sa.png} \end{frame} \end{document}