Sprint HAL-SWH-IES - rapport 2020

Sprint HAL-SWH-IES - rapport 2020 ================================ ###### tags: `sprint` `sofwtare preservation` `HAL` `CCSD` `SWH` :::info :bulb: How to edit hack.md: Edit: See only the editor. View: See only the result. Both: See both in split view. ::: **Participants:** - CCSD : - Bruno Marmol ; - Yannick Barborini - Software Heritage : - Roberto Di Cosmo ; - Morane Gruenpeter - IES-Inria : - Jozéfina Sadowska ; - Estelle Nivault ; - Alain Monteil **Table des matières** [TOC] :dart: Objectif du sprint défini en Février 2020: --- 1. Finalisation du dépôt logiciel actuel avec: - les format d'export HAL (Citation, TEI, Bibtex, endnote, DC, DCterms) - et les nouveaus exports (CodeMeta, CFF) 2. Initialisation et spécification d'un dépôt sur HAL à partir d'un SWHID ou d'un repository 3. Intégration des logiciels dans hal data ## Liste des sujets traités ### 1. Interface utilisateur #### 1.1 Le Formulaire :::success - Ajout des métadonnes `institution`, `editeur` et `publications associées` (institution, publisher and Associated publications) ::: ##### 1.1.1 Les auteurs ###### 1.1.1.1 les rôles voir https://gitlab.ccsd.cnrs.fr/ccsd/hal/-/issues/249 :::success - les nouveaux rôles sont sur prod et pre-prod - supprimer crp (auteur correspondant) et contributeur ::: - [ ] ==CCSD== voir comment ajouter des roles multiples quand un auteur a plusieurs rôles - [ ] voir comment améliorer affichage des rôles - [x] ==IES-Inria== voir comment faire avec les 11 dépôts avec contributeur qui ont renseigné cette métadonnée ? [EN]Il s'agit en fait de 5 dépôts qui concernent 11 auteurs au total. Le rôle "contributeur" qui était renseigné a été corrigé pour tous les auteurs concernés, au profit des autres rôles appropriés (developpeur, auteur, design...) ###### 1.1.1.2 auteur collectif - ACTION: consulter un groupe (GT Citation) de chercheurs/ses, instittution / université / évaluateur sur ce point - voir si l'idée de la structure signante répond au besoin - [x] ==tous== décider pour l'auteur collectif - [ ] ==RDC== contacter GT citation et autres groupes #### 1.2 la notice :::success - affichage d'un SWHID complet (avec context)[#264](https://gitlab.ccsd.cnrs.fr/ccsd/hal/-/issues/264) ::: - [ ] ==CCSD== ajouter commentaire et lien vers le paquet BibLaTeX sur CTAN depuis le cadrant "citation" (sur texlive) #### 1.3 Transfert chez SWH - [ ] ==YB== Ajouter les nouvelles métadonnées aux exports et au transfert chez SWH - [ ] ==MG== Vérifier les nouvelles métadonnées aux exports et au transfert chez SWH ### 2. Formats exports: Citation, TEI, Bibtex, endnote, DC, DCterms, CodeMeta, CFF #### 2.1 TEI :::success Plusieurs modifications sur la TEI: à revoir avec la possibilité de faire un fichier ODD au lieu d'un fichier XSD ::: - [ ] ==YB== changer la TEI type=swh en type=swhid - [ ] ==?== évoluer d'un fichier XSD à un ODD? #### 2.2 Citation :::success Citation avec SWHID complet ::: - [ ] ==IES-SWH/ JS EN MG==Citation intégrer les champs ? exemple publisher ou institution ? voir cohérence avec biblatex - [ ] ==MG== recenser exemples citation - [ ] ==RDC== proposer quelques options comme choix éditorial au GT citation - [ ] ==MG== refaire le diagramme de la citation avec les modifications #### 2.3 BibTeX :::success Bibtex modifié avec la proposition du GT citation et l'implementation de Roberto Actuelement avec @softwareversion dans tous les cas ::: - [x] ==Morane & Yannick== [BibTeX] voir si on veut ajouter @software dans l’export? pour l’instant export seulement avec @softwareversion. - https://hal.archives-ouvertes.fr/hal-02089679v1/bibtex - [ ] ==?== reviser la feuille de style de génération du bibtex /!\ après la finalisation de la TEI - [ ] ACTION: Clarifier la spec/documentation de BibLaTeX sur l'utilisation de la propriété `title` dans un `@softwaremodule` #### 2.4 CodeMeta :::success implémentation d'un export codemeta.json ::: - [ ] ==YB== Ajouter un bouton pour accéder à cet export - [ ] ==MG== Créer correspondance sur la table CodeMeta [proposition sur CodeMeta->HAL PR](https://docs.google.com/spreadsheets/d/1w3NzzHuR8KNgYlGiLJH0FSc5eXxV9t3xcw9mKPXfK7k/edit?usp=sharing) - [ ] faire un PR sur CodeMeta - [ ] ==MG== vérifier les termes manquants (sur SWORD) et signaler au CCSD - [ ] downloadUrl -> file #### 2.5 Autres formats - [ ] ==IES-Inria== évaluer quels exports doivent être présent sur une notice logiciel - obligatoire OAI-PMH - [ ] endnote trouver une personne experte en endnote - [ ] DC - [ ] DCterms - [ ] ==AM MG== Créer une correspondance HAL -> Citation File Format (CFF) ou décider qu'une application de la correspondance HAL -> CodeMeta -> CFF est correcte **8** voir partie SWH - [ ] export citation.cff - voir l'utilité d'un citation.cff par rapport à une sortie bibtex - [ ] ==?== vérifier avec Zenodo et Open Aire - [ ] vérifier /rdf - [ ] ==IES-Inria== vérifier les entête schema.org des notices ### 3. Dépôt métadonnées avec SWHID :::success DECISION: un dépôt avec SWHID est comme un dépôt de contenu cela permet deux choses: - modération des dépôts SWHID - dépôt de plusieurs versions avec différent SWHID ::: #### 3.1 spécifications :::success - spécifications accesible ici: - hack.md: - docs SWH: https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-meta-deposit.html ::: ##### 3.1.1 spécifications spécial forge Inria - [ ] [En attente] ==MG + IES INRIA== détailler les scénarios de dépôt et de modération pour le cas spécifique forge Inria - DSI repousse la fermeture été 2021 #### 3.2 validation du nouveau scénario - [ ] ==CCSD / IES INRIA /SWH== scénario modifier métadonnées - [ ] ==CCSD / IES INRIA /SWH== scénario déposer métadonnées sur SWHID - [ ] ==CCSD / IES INRIA /SWH== scénario nouvelle version sur nouveau SWHID (même HAL-ID) #### 3.3 implémentation - [ ] ==CCSD== SWHID dans le nuage - lire un codemeta.json sur SWH pour pre-remplir le formulaire de depot - [x] ==SWH== proposer un lien sur lequel un codemeta.json est accesible - [ ] ==CCSD== envoyer a Software Heritage via SWORD les metadonnees validees (par la modération) #### 3.4 scénario de mise à jour des métadonnées :::success - DECISION: ne pas modérer pour l'instant les modifications de dépôt logiciel mais rester vigilant ::: - [ ] ==AM== (observation) créer un petit groupe pour suivre les modifications des notices - métadonnées de logiciels modifiées après modération hal-01730321 hal-01760120 hal-01836169 hal-01831369 hal-01863457 hal-01887126 (corrigé par l’IES : modification du rôle de l’un des auteurs par la fonction “Design”) hal-01937857 hal-02014516 hal-02079276 hal-02128878 hal-02130729 hal-02130801 - [ ] ==YB== envoyer les métadonnées des notices modifiées sur SWH (envoyer les métadonnées au niveau du document - modifications faites par l'utilisateur) ### 4. Software collection et module :::success Voici les collections de test sur la preprod avec les dépôts suivants: * https://inria.halpreprod.archives-ouvertes.fr/view/index/docid/2510118 hal-02510118 * https://inria.halpreprod.archives-ouvertes.fr/view/index/docid/2510117 hal-02510117 ::: - [ ] ==IES Inria== fiche collection: spécification comment créer une collection - [ ] ==CCSD== Réflexion globale pour faire évoluer les métadonnées pour les relations - [ ] **Conclusion possible**: Ajouter une métadonné `isModule` ou `estModule` :::warning Sujet à déveloper pour l'années 2021 ::: ### 5. Documentation - [ ] ==?== Organisme/institution voir la documentation d'accompagnement + tous les nouveaux champs ? - [ ] ==MG== signaler à Agnès Magron mise à jour des guides et de l'élément suivant sur BibLaTeX - [ ] ==Agnès== ajouter commentaire et lien vers le paquet BibLaTeX sur CTAN sur la documentation CCSD #### 5.1 Guide de dépôt https://drive.google.com/drive/folders/1wEmhBGY6YGhRP6w65DsNHQQkHRizcA6P - [ ] ==IES-INRIA + MG== mettre à jour guide de dépôt - [ ] ajouter lien vers BibLaTeX - [ ] Mise à jour du guide : rôles + tous les nouveaux champs #### 5.2 Guide de modération https://drive.google.com/drive/folders/1wEmhBGY6YGhRP6w65DsNHQQkHRizcA6P - [ ] ==IES-INRIA + MG== mettre à jour guide de modération #### 5.4 Q & A - [ ] ==?== créer pages de réponses aux questions déposant et modérateurs (2 pages différentes) https://hackmd.io/@HAL-SWH-IES/Hya_FvZiI ### 6. Communication #### 6.1 Comm export BibTeX :::success Réaliser en 2020 ::: - [x] ==RD== fournir texte pour "breve" Inria sur les nouveaux formats latex disponibles - [ ] ==GT citation== breves à valider en GT et faire une version anglaise #### 6.2 Comm fermeture de la forge Inria :::danger En attente de décision Inria ::: - [ ] écrire communication par paliers - [ ] forge Inria va être archiver sur SWH (code et mailing list) - [ ] vous pouvez déposer dans HAL (comme avant zip et métadonnées): clarifier que cela n'est pas adapté à l'archivage de l'historique - [ ] dépôt avec SWHID sur HAL #### 6.3 Comm dépôt SWHID - [ ] planifier comm quand dépôt est prêt et tester ### 7. Misc #### 7.1 Raweb - [ ] ==JS== A modifier sur Raweb(**): - [ ] Licence` changer en `License` - [ ] modifier l'export du contenu de `note` avec le contenu de la métadonnée `commentaire` #### 7.2 dépôt massif (type INRAE) - discuter de workflow possible pour les dépôts logiciel qui sont arrivés sur HAL depuis un dépôt massif (e.g INRAE) qui ne sont pas envoyer chez SWH. #### 7.3 autres - ? ACTION INRIA va demander l’évolution de Haltools pour mieux gérer l’affichage su SWHID + proposition de mettre l’icone SWH ## Objectifs et agenda réunion 15.12.2020 1. Discussion sur Auteur collectif https://gitlab.ccsd.cnrs.fr/ccsd/hal/-/issues/315 - pas spécifique au logiciel - deux aspects: - personne morale avec un traitement particulier(les auteurs n'ont plus la propriété du logiciel) - exprimer la paternité du groupe des auteurs plutot participation au groupe (exemple de publication : https://hal.archives-ouvertes.fr/hal-02976710, exemple de logiciel : https://hal.archives-ouvertes.fr/hal-02130729v1) - rapport d'activité d'une équipe est signé par l'équipe = signature par une structure dans Hal mais sans afficher les membres - affiliation au sens HAL - affiliation à la structure signante - auteur et co-auteur apparaît sur la signature - n'existe pas dans HAL actuellement - cas d'usage: - le groupe n'a pas résolu qui mérite le crédit - l'institution liste des logiciels auquels on a contribué - cas groupe rééllement anonyme ? à gérer comme auteur - rattachement à une autre structure (type institution, structure avec une tutelle) -> auteur collectif à la structure - question: si les personnes dans la structure `auteur collectif` changent, est ce qu'il y a un suivi temporel de leurs rattachement? - réponse: non, le groupe n'existe pas en dehors du document => pour la citation: affichage de l`auteur collectif` sur la citation, mais il faut ajouter tous les auteurs qui veulent avoir cette contribution dans leur CV => pour tous ces auteurs (personnes) j'ajoute un auteur collectif qui sera visible sur la citation et auquel tous les auteurs sont rattachés => tag de structure signante => fait par un admin? par tout le monde? => idée: utilisation du rôle `auteur collectif` pour lever l'obligation nom et prénom? DECISION: le document connecte les auteurs, groupe et affiliation - [ ] ==MG== vérifier comment l'écrire avec CodeMeta - [ ] ==CCSD== implémenter l'auteur collectif en tant que structure signante - [ ] ==IES-Inria== vérifier les répercussion des exports de ce type structure - bibtex, voir l'impact du . etc - [ ] ==IES-Inria + MG== ajouter de la documentation sur ce cas là au guides ------------ 2. Etat d'avancement sur scénario dépôt seulement avec SWHID https://hackmd.io/@HAL-SWH-IES/BkzfYx2MD - avec SWHID dans le nuage - évolution du protocol SWORD sur Software Heritage - https://docs.softwareheritage.org/devel/swh-deposit/specs/protocol-reference.html - staging SWH et pre-prod HAL 1. amélioration du CodeMeta 2. collecter des métadonnées avec un SWHID - [x] ==MG== trouver SWHID avec codemeta.json - [x] ==YB== vérifier si tous les tests sur la pre-prod HAL sont envoyés sur la staging SWH - [ ] ==MG== organiser une réunion CCSD-SWH pour l'avancement du scénario SWHID --------- 3. TEI: changer XSD en ODD (for "One Document Does it all") https://tei-c.org/release/doc/tei-p5-doc/de/html/TD.html#TDTAG - calc (oasis) - créer spec ODD pour CodeMeta - https://github.com/CCSDForge/HAL/blob/master/schema/RelaxNG/HALSpecification.rng - vocabulaire TEI, expression TEI - validation ODD avec php? - [ ] ==CCSD== vérifier si on peut valider l'ODD (relaxng) sur HAL (en php) - [x] ==AM== organiser une session de 2 heures avec Laurent Romary sur le sujet TEI / CodeMeta fin janvier 4. Planifier priorités 2021 (section ci-dessous) Sprint HAL-SWH-IES - priorités 2021 =================================== 1. interaction sur la nouvelle proposition UI/UX concernant les fiches logiciels (dépôt, modération, export) 2. Exports logiciel - CodeMeta, BibTeX, TEI - Vérifier autres exports (DCTERMS, EndNote) 3. Implémentation nouveau scénario SWHID - avec SWHID dans le nuage 4. revoir le format de la citation 5. documentation et guides (dépôt et modération) 6. communication du nouveau scénario SWHID (potentiellement avec une partie qui cible les utilisateurs de la forge Inria)