Software Management Plans (SMPs) for your Research Software (RS) & the PRESOFT model

Managing Research Software Managing Research Software Software Management Plans (SMPs) for your Research Software (RS) & the PRESOFT model Teresa Gomez-Diaz (CNRS/LIGM) LIBER Research Data Management Working Group 9.10.2025 https://libereurope.eu/event/webinar-managing-research-software/ T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 1 / 27 Software Management Plans (SMPs) for your Research Software (RS) & the PRESOFT model Teresa Gomez-Diaz CNRS - Laboratoire d’informatique Gaspard-Monge (LIGM) Including works in collaboration with G. Romier (CC-IN2P3) Including works in collaboration with Prof. T. Recio (Univ. Nebrija, Madrid) This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License (CC-BY-NC-ND 4.0) – http://creativecommons.org/licenses/by-nc-nd/4.0/ LIBER Research Data Management Working Group, 9 october 2025 T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 2 / 27 Plan Part I – 1Research Software Definition Software is a legal object RS authors Reference and citation 2Dissemination procedure 3Protocol(s) CDUR : research evaluation and RS The CDUR RS protocol(s) FAIR principles and CDUR protocols T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 3 / 27 Definition of Research Software (2019) TGD, T. Recio. On the evaluation of research software: the CDUR procedure Research software (RS) is a well identified set of code that has been written by a well identified research team. It is software that has been built and used to produce a result published or disseminated in some article or scientific contribution. Each RS encloses a set of files containing the source code and the compiled code. It can also include other elements as the documentation, specifications, use cases... (2010, 2015) TGD. Article vs. Logiciel : questions juridiques et de politique scientifique dans la production de logiciels Un logiciel du laboratoire est un programme utile pour faire avancer la recherche qui a ´et´e produit avec la participation d’un membre du laboratoire. Il arrive souvent que des publications de recherche soient associ´ees. -goal: research -un member of the lab participates to the code writing (likewise publications) -the important production are the articles, RS are associated objects The definitions do not take into account the state of the RS: “in preparation”, “finished”, disseminated, quality, scope, size, documented, maintained, used only by one team to produce a publication, or used in several laboratories T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 4 / 27 Software is a legal object (2010, 2015) TGD. Article vs. Logiciel : questions juridiques et de politique scientifique dans la production de logiciels (2022) TGD, T. Recio. Research Software vs Research Data I (Definition) -[FR] Code de la propri´et´e intellectuelle (CPI), Article L. 112-2 : un logiciel est une œuvre de l’esprit prot´eg´ee par le droit d’auteur. -[FR] Arrˆet´e du Minist`ere de l’Industrie du 22 d´ecembre 1981 (vocabulaire de l’informatique) : un logiciel est un ensemble des programmes, proc´ed´es et r`egles, et ´eventuellement de la documentation, relatifs au fonctionnement d’un ensemble de traitement de donn´ees. -[EC] Directive 2009/24/EC, 23/04/2009, on the legal protection of computer programs: For the purpose of this Directive, the term computer program shall include programs in any form, including those which are incorporated into hardware. This term also includes preparatory design work leading to the development of a computer program provided that the nature of the preparatory work is such that a computer program can result from it at a later stage. (2019) TGD, T. Recio. On the evaluation of research software: the CDUR procedure Research software (RS) is a well identified set of code that has been written by a well identified research team. It is software that has been built and used to produce a result published or disseminated in some article or scientific contribution. Each RS encloses a set of files containing the source code and the compiled code. It can also include other elements as the documentation, specifications, use cases... T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 5 / 27 RS authors (2019) TGD, T. Recio. On the evaluation of research software: the CDUR procedure What means to be a RS author ? legal concept : the author writes the code scientific concept : expert contributions, maybe no writing code without the scientific expert, the RS will not exist maybe other contributions : documentation, bug fixing, test, maintenance, translations... Definition of a RS author : in the article we select three rˆoles (limits can be fuzzy) : I(i) RS leader, I(ii) main or important contributor (code writing), I(iii) minor contributor (code writing or other contribution). Persons with no code writing can be assigned with some participation % by the team. T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 6 / 27 Reference and citation (2013) Pontille D, Torny D : La manufacture de l’´evaluation scientifique. . . https://hal.inrae.fr/hal-02646545v1 [...] the difference between reference and citation : the act of reference is the responsibility of a given author while the citation is a new property, possibly calculable, of the source text. According to P. Wouters (1999), this reversal has radically altered the practice of referral and has literally created a new “culture of citation”. (2019) TGD, T. Recio. On the evaluation of research software: the CDUR procedure A reference sets title, author(s), date, and identifies RS as a scientific object. The article considers three different types of reference : the one related to the RS paper (with software peer review), the one related to a classic research article describing the RS, a “reference” : author(s), RS title, short description, version, date, url. Remarks : There can be several references associated to a RS. There are more complete identifications : metadata, CITATION files... Software Citation Group, Software Citation Implementation Working Group... RDA Complex Citation Implementation Interest Group (CCI IG) T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 7 / 27 Plan Part I – 1Research Software 2Dissemination procedure 3Protocol(s) CDUR : research evaluation and RS T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 8 / 27 Research Software dissemination procedure Easy to adapt to many situations, also valid for (research) data. –Choose a name, avoid trademarks and proprietary names, associate date, version... (2018) DoRANum or Harvard. File Naming Conventions –(*) (research team step) Establish list of authors/contributors (% participation, affiliations). Consider a Software Management Plan (2018, TGD, G. Romier, PGLR V3.2, PRESOFT) –(*) Establish the list of main functionalities. –(*) Establish the list of included software & data components, their licenses –Choose a license, have an agreement (signed) with rightholders and authors, consider FLOSS licenses. Beware of license compatibility and inheritance issues. –Choose a website, forge, deposit for dissemination, indicate licenses and how to cite the work. Use PIDs if possible. –(*) (research work step) Establish the list of main functionalities, archive a tar.gz to keep track of added functionalities. –Inform your laboratories and head institutions (if not done in the license step). –Set and indicate clearly a contact address. –Distribute your (research) software or data component. –Inform the target scientific community. Consider Software or Data papers... (*) To be reviewed with each new version. (2014) TGD. Free software, Open source software, licenses. A short presentation including a procedure for RS and data... (2022) TGD, T. Recio. Research Software vs Research Data II (Dissemination, CDUR, FAIR) T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 9 / 27 Research Software life cycle, PRESOFT vision To develop procedures and models adapted to the Research Software life cycle. T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 16 / 27 Other models of software life cycles Spiral life cycle Image : Mod`ele en Spirale de Boehm, MDaumas. https://commons.wikimedia.org/wiki/File: Spirale_(Boehm,_1988).svg (1986) B. Boehm. A spiral model of software development and enhancement. ACM SIGSOFT Software engineering notes. https://dl.acm.org/doi/pdf/10.1145/12944.12948 https://www.wikiwand.com/fr/Mod%C3%A8le_en_spirale (2023) G. Courbebaisse et al. Research Software Lifecycle, EOSC Task Force on Infrastructures for Quality Research Software https://zenodo.org/records/8324828 CI/CD = Continuous Integration and Delivery T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 17 / 27 Presentation of the PRESOFT template (1/2) https://hal.science/hal-01802565 or https://doi.org/10.5281/zenodo.1405613 T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 18 / 27 Presentation of the PRESOFT template V3.2 (April 2018) The model is preceded by a presentation that shows how to use it, and explains its licensing. 0. Title of the Plan with the name of the software + dates, author(s), affiliation(s) 1. M´etadonn´ees / Metadata 2. Contexte du logiciel / Software context 2.1 Historique / History 2.2 Projet (s) li´e (s) au logiciel / Project(s) related to the software 2.3 Questions l´egales et politique de diffusion / Legal issues and distribution policy 3. Caract´eristiques du logiciel / Software features 3.1 Objectifs scientifiques / Scientific goals 3.2 Objectifs d’utilisation et de diffusion / Usage and distribution objectives 3.3 Caract´eristiques techniques / Technical features 4. Organisation de l’´equipe / Team organisation 5. Organisation du d´eveloppement / Development organisation 6. Organisation de la diffusion / Distribution organisation 7. Gestion du plan de gestion / SMP management R´ef´erences / References T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 19 / 27 The PRESOFT template is also available at DMP OPIDoR The PRESOFT model was integrated into DMP OPIDoR at the request of its team (April 2018). T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 20 / 27 Experience at LIGM, a computer science lab – Case study The main output of the project is the PRESOFT model. It has been developped and tested with some research software comming from two French labs. Plans done at LIGM and at LAAS (2017-2019) : BEC3 - Behaviour Crowd Centric Composition, set of tools that enable the creation of Internet of Things applications, is an online service. MIMO-802.11e, code under the NS-2 simulator for MIMO-802.11e networks (Multiple In Multiple Out). Goal : to improve the bandwidth of an 802.11e wireless network using MIMO technology. OpenMVG or Open Multiple View Geometry for computer-vision. ProPhyle, DNA sequence classification. TreeCloud : generation of tree clouds from a text, i.e., word clouds arranged around a tree that indicates their proximity in the text. RRHP fx, V. Baudin (LAAS) : assistance for the management of human resources in a research project. Real-time progress monitoring. Plans done in 2024 : Garamon, a generator of C++ libraries dedicated to Geometric Algebra Hygra, a C++/Python library for efficient sparse graph analysis Review of SPPAS - the automatic annotation and analyses of speech, B. Bigi (LPL) T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 21 / 27 Benefits of RS SMPs For a RS team ITo get a general overview of each RS ITo better organize the associated work and its monitoring ITo improve management methods and save time ITo identify what goes well, needs, risks, and avoid bad surprises ITo reflect and/or implement a strategy ITo improve the RS quality, and thus of the team research quality ITo facilitate RS reuse and foster new collaborations ITo increase integrity and transparency, visibility and impact For a lab or a research institution ITo improve knowledge of RS productions ITo increase the visibility of important productions ITo identify needs, risks. . . ITo increase the integrity, transparency, visibility and impact of research ITo facilitate policy implementation regarding RS and research in general New recommendations 2024 Science Europe, Developing and Aligning Policies on Research Software: Recommendations for RFOs and RPOs, https://doi.org/10.5281/zenodo.13740998 2024 UNESCO - Open Hidrology, N. Dogulu, K. Verbist, A. Mertens, https://unesdoc.unesco.org/ark:/48223/pf0000390401 2025 NASA Science Mission Directorate, Open-Source Science Guidance -PDF T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 22 / 27 Other works on SMPs (1/2) –SSI - Software Sustainability Institute, UK 2016 The Software Sustainability Institute, Checklist for a Software Management Plan, V0.1. https://zenodo.org/records/1422657 2018 The Software Sustainability Institute, Checklist for a Software Management Plan, V1.0. https://zenodo.org/records/2159713 https://www.software.ac.uk/software-management-plans 2021 N. Chue Hong, S. Crouch. Introduction to Software Management Plans Workshop. https://github.com/softwaresaved/introduction-to-software-management-plans/ –ELIXIR 2021 R. Alves, et al. ELIXIR Software Management Plan. https://github.com/elixir-europe/smp 2021 R. Alves, et al. ELIXIR Software Management Plan for Life Sciences. BioHackrXiv Preprint. https://osf.io/preprints/biohackrxiv/k8znb –Netherlands e-Science Center 2021 Netherlands e-Science Center. Software Management Plan Template. https://www.esciencecenter.nl/wp-content/uploads/2021/07/SMP2021-v1.057.pdf 2023 C. Martinez-Ortiz et al. Practical guide to Software Management Plans (1.1). Zenodo Preprint. https://doi.org/10.5281/zenodo.7589725 –ZIB - Zuse Institute Berlin 2023 T. Hasler et al. Software management plan developed in HPO-Navi. https://doi.org/10.12752/9250 –MDPL - Max Planck Digital Library, Germany 2024 M. Franke, YV. Grossmann. Software Management Plans as a Path for Sustainable and Reproducible Research Software. Poster, 4th conference for Research Software Engineering in Germany. https://pure.mpg.de/pubman/faces/ViewItemOverviewPage.jsp?itemId=item_3562663_4 –Digital Research Alliance of Canada 2024 Zhang, Qian and Dhane, Fares. Alliance Software Management Plan (SMP) Template. Zenodo Preprint. https://doi.org/10.5281/zenodo.13242503 –Recherche Data Gouv - Coll`ege Codes sources et logiciels, France 2025 Available at DMP OPIDoR (CNRS/INIST), https://dmp.opidor.fr/guidance_group_export/1161.pdf More references available at http://igm.univ-mlv.fr/~teresa/presoft/ T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 23 / 27 Other works on SMPs (2/2) DINI/nestor WG Research Data, sub-WG Software Management Plans, Germany 2024 YV. Grossmann et al. Software Management Plans - Current Concepts, Tools, and Application Data Science Journal, 23 : 43, 1-16. https://doi.org/10.5334/dsj-2024-043 2024 Workshop “Les Plans de Gestion des Logiciels de la Recherche ”, University Gustave Eiffel, https://igm.univ-mlv.fr/~teresa/presoft/2024FormationPlansGestionLogicielsRecherche/ 2024 TGD. Questions et R´eponses sur le Mod`ele PRESOFT et les Plans de Gestion, https://zenodo.org/records/13133081 2024 P. Schmidt. Planning your research software - a workshop in Paris, https://codeforthought.buzzsprout.com/ 1326658/episodes/15479406-en-planning-your-research-software-a-workshop-in-paris It’s the questions that matter... T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 24 / 27 References (1/2) 2007 TGD. Autour de la valorisation de logiciels d´evelopp´es dans un laboratoire de recherche, LIGM. 2009-13 Th`eme PLUME “Patrimoine logiciel d’un laboratoire” https://zenodo.org/communities/plume-patrimoine-logiciel-laboratoire/ 2009 JL Archimbaud, TGD. Licence & copyright pour les d´eveloppements de logiciels libres de laboratoires de recherche, PLUME, https://doi.org/10.5281/zenodo.7063145 2009 TGD. Guide laboratoire pour recenser ses d´eveloppements logiciels, PLUME, https://doi.org/10.5281/zenodo.7063162 2010 TGD. Diffuser un logiciel de laboratoire : recommandations juridiques et administratives, PLUME, https://doi.org/10.5281/zenodo.7096215 2010-15 TGD. Article vs. Logiciel : questions juridiques et de politique scientifique dans la production de logiciels, PLUME, https://doi.org/10.5281/zenodo.7063153 V2 March 2015, Soci´et´e Informatique de France, https://doi.org/10.48556/SIF.1024.5.119 2014 TGD. Articles, software, data: a study of the (French) scientific production, Poster, EUDAT 2014, http://igm.univ-mlv.fr/~teresa/logicielsLIGM/documents/Internacional/2014septeudat_70x100.pdf 2014 TGD. Free software, Open source software, licenses. A short presentation including a procedure for research software and data dissemination, Zenodo preprint, https://doi.org/10.5281/zenodo.11709 2018 TGD, G. Romier. Research Software Management Plan template PRESOFT V3.2, Zenodo preprint, https://doi.org/10.5281/zenodo.1405590 2019 TGD. Le Projet PLUME et le paysage actuel des logiciels de la recherche dans la science ouverte, Zenodo preprint, https://doi.org/10.5281/zenodo.2591473 2019 TGD. Les logiciels de la recherche et leurs licences : trois visions sur un objet, Cours CERFACS, https://hal.science/hal-02434287v1 2019 TGD, T. Recio. On the evaluation of research software: the CDUR procedure, F1000Research, Research on Research, https://doi.org/10.12688/f1000research.19994.2 2020-21 TGD, T. Recio. Towards an Open Science definition as a political and legal framework: on the sharing and dissemination of research outputs, POLIS N. 19, 2020,https://doi.org/10.58944/yuro5734, V3 du 28/02/2021,https://doi.org/10.5281/zenodo.4577065 2021 TGD. Free/Open source Research Software production at the Gaspard-Monge Computer Science laboratory (LIGM). Lessons learnt, FOSDEM’21, https://archive.fosdem.org/2021/schedule/event/open_research_gaspard_monge/, https://hal.science/hal-05242344v1 T. Gomez-Diaz (CNRS/LIGM) SMPs for your RS - PRESOFT LIBER, 9 october 2025 25 / 27