Hardware considerations for Research Software Sharing, Publication, & Distribution Checklists?

Hi everyone,

Sharing something that is IMHO quite relevant to open science hardware.

My friend Richard Acton created a very impressive “Research Software Sharing, Publication, & Distribution Checklists (RSSPDF)”:

Richard is interested in making these checklists useful for use in conjunction with publishing hardware.

For example, are the checklists useful for embedded software in open source and open science hardware? How could the checklists be improved to be more relevant for publishing hardware? @hikinghack @julianstirling @jpearce or others might be able to critique?

Richard says:

…feel free to share this in any forum where you think it might find
someone who may be qualified / interested to comment on embedded
specific considerations for sharing research software. Or even adapt the
checklist format to this area themselves - that would be great I’m
hoping to find some engaged contributors to the project.

This is the email for generic project inquiries: info@rsspdc.org
I’ve made an issue for this question on the project gitlab:
https://gitlab.com/rsspdc/checklists/-/issues/18

Please chime in on this impressive initiative!

@jamaica @jamaicajones: Possible newsletter and other comms content!

3 Likes

Hmm very nice. A checklist by definitions is opinionated and I agree with most (but not all*) of the opinions in the software package one. But I do really like that it is granular and rewards starting.

I think for hardware we can start something. But I think there are still lots of “missing” best practices, or if they exist they are very specialised and overly technical.

I could write a checklist but I think it would be less Are you following OpenHardware best practices? and more Are you developing this like Julian would? or Is this repository the OpenFlexure Microscope?

Still I think we should try. Maybe the sort of thing to sketch out over a pint? :beer:


* e.g like citation.cff, not overly useful, poorly structured as it uses non-standard YAML to parse, .cff community is unwelcoming and rude)

1 Like