Metadata model for machine-actionable Software Management Plans

About

This project corresponds to an extension of the Research Data Alliance (RDA) machine-actionable Data Management Plan (maDMP) application profile and its corresponding DMP Common Standard ontology (DCSO) in order to cover the case of ELIXIR Software Management Plans (SMPs). Similar to DMPs, SMPs help formalize a set of structures and goals that ensure the software is accessible and reusable in the short, medium and long term. Although targeting the life sciences community, most of the elements of the ELIXIR SMPs are domain agnostic and could be used by other communities as well. DMPs and SMPs can be presented as text-based documents, sometimes guided by a set of questions corresponding to key points related to the lifecycle of either data or software. The RDA DMP Common Standards working group defined a maDMP to overcome limitations of text-based documents. We propose a similar path for the ELIXIR SMPs so they turn into machine-actionable SMPs (maSMPs).

Acknowledgements

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 101017536 and is part of the Research Data Alliance and European Open Science Cloud Future call 2022. This project has been supported by the Good Practices Focus Group part of the ELIXIR Tools Platform. The work presented in this poster was part of Project 17 at the BioHackathon Europe 2022.

Relevant sources

Structure

contact

contributor

funding

maintenance

retirement

project_timeline

purpose

reliability_strategy

software

data_storage

security_and_privacy

distribution

license
production

documentation

citation
deployment_documentation
developer_documentation
user_documentation

repository

license

testing

version_control

software_engineering_quality

Properties in 'contact'

Name	Description	Cardinality	Example Value
contact	Contact person for the SMP	1	Elizabeth Smith contact@example.com

Properties in 'contributor'

Name	Description	Cardinality	Example Value
contributor	The contributers of code, planning and data involved in the software project	0..*	Elizabeth Smith, Adam Miller

Properties in 'funding'

Name	Description	Cardinality	Example Value
funding	Who is funding the project	0..*

Properties in 'maintenance'

Name	Description	Cardinality	Example Value
maintenance	Running post-production modifications on the software to improve user functionaility or resolve technical issues	0..*
retirement	The strategy that will be used to put an end to the use of the software project	0..1

Properties in 'project timeline'

Name	Description	Cardinality	Example Value
project_timeline	Establish the keydates of project development	0..*	Development start: "Apr 9, 2020", Development end: "Jul 24, 2023"

Properties in 'purpose'

Name	Description	Cardinality	Example Value
purpose	A brief description of the software stating its purpose and intended audience	1..*

Properties in 'reliability strategy'

Name	Description	Cardinality	Example Value
reliability_strategy	How can it be ensured that the software will keep running	0..*

Properties in 'software'

Name	Description	Cardinality	Example Value
testing	Code testing strategies and its pipeline to successful testing results covering a broad range of testing-categories	0..*
version_control	The system used to manage changes in code shared across all developers	1..*	git

Properties in 'data storage'

Name	Description	Cardinality	Example Value
data_storage	The location and type of storage solutions for data used or created by the software.	0..*	SQLite
security_and_privacy	What measures will be taken to ensure the security and privacy of the users data and the data generated by the app?	0..*

Properties in 'distribution'

Name	Description	Cardinality	Example Value
distribution	To provide technical information on a specific instance of the software like the link to access it, the byte size, description, format	0..*
license	The license of the software regarding the rights distribution	0..*	MIT license
production	The resulting active running instance of the software which is either publically or internally accessible	0..1

Properties in 'documentation'

Name	Description	Cardinality
citation	Method to cite the software in form of a citation file (CFF)	0..*
deployment_documentation	Deployment documentation guiding how the software project is being deployed into production	0..*
developer_documentation	Documentation regarding the code-components of the software	0..*
user_documentation	Software documentation regarding the user, instructing how the application is being used from a non-developer perspective	0..*

Properties in 'repository'

Name	Description	Cardinality	Example Value
repository	Name the platforms that are going to be used to store the source files	0..*	github.com/maSPMs
license	The license of the software regarding the rights distribution	0..*	MIT license

Properties in 'software engineering quality'

Name	Description	Cardinality	Example Value
software_engineering_quality	Guidelines shared across the softwares to provide standardized documentation, testing or code structure	0..*

yvgrossmann/maSMPs