noaa-fisheries-integrated-toolbox / FIT-committee

Communication for the FIT committee
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link

Inventory how well the toolbox meets FAIR for research software principles and which elements can be improved #38

Closed k-doering-NOAA closed 1 month ago

k-doering-NOAA commented 9 months ago

@eeholmes , would this be something you would be interested in working on, given you are the PARR II representative for NOAA Fisheries? I tentatively scheduled this to happen in "April 2024", but if you take this up, the timing can change based on what works for you.

Feel free to tag someone else to work on this with you, if that seems helpful!

Also, more info on FAIR for research software here:

k-doering-NOAA commented 5 months ago
Principle Addressed by toolbox
F: Software, and its associated metadata, is easy for both humans and machines to find. -
F1. Software is assigned a globally unique and persistent identifier. Not addressed
F1.1. Components of the software representing levels of granularity are assigned distinct identifiers. Not addressed
F1.2. Different versions of the software are assigned distinct identifiers. Not addressed
F2. Software is described with rich metadata. Yes, links to the software provided
F3. Metadata clearly and explicitly include the identifier of the software they describe. Not addressed
F4. Metadata are FAIR, searchable and indexable. Not addressed
A: Software, and its metadata, is retrievable via standardised protocols. -
A1. Software is retrievable by its identifier using a standardised communications protocol. Typically addressed, but up to the author
A1.1. The protocol is open, free, and universally implementable. -
A1.2. The protocol allows for an authentication and authorization procedure, where necessary. -
A2. Metadata are accessible, even when the software is no longer available. FIT metadata would remain accessible if json files left in toolbox. Perhaps a separate archived section could be a future direction?
I: Software interoperates with other software by exchanging data and/or metadata, and/or through interaction via application programming interfaces (APIs), described through standards. Up to the author?
I1. Software reads, writes and exchanges data in a way that meets domain-relevant community standards. Up to the author?
I2. Software includes qualified references to other objects. Up to the author?
R: Software is both usable (can be executed) and reusable (can be understood, modified, built upon, or incorporated into other software). -
R1. Software is described with a plurality of accurate and relevant attributes. -
R1.1. Software is given a clear and accessible license. Implementing in tool quality standards
R1.2. Software is associated with detailed provenance. Not sure what this means?
R2. Software includes qualified references to other software. Up to the tool authors
R3. Software meets domain-relevant community standards. Up to the tool authors
k-doering-NOAA commented 2 months ago

Possibly topic for June 2024 meeting.

k-doering-NOAA commented 1 month ago

Closing this, as the table completes the inventory. I'll move this issue to "consider for FY25", as we may want to use it to consider changes in toolbox processes to futher address FAIR principles.

If time allows, we will discuss the table at the July 2024 meeting.