Recognising contributions COSIMA model configurations and simulations

A straw-man proposal (please critique):

If we want to keep track of

  • multiple contributors, each of whom made
    • different contributions and
    • requests different attribution/embargo/collaboration/whatever

and we want it to be readily parsed, I guess we’d need something like this in metadata.yaml, with

  • a “contributors” dictionary, with
    • each key being an individual contributor’s name, whose value is a dictionary containing
      • “email”
      • “contributions” and
      • “requests”
        keys whose values are free-form text,

e.g.

contributors:
    'Marie Curie':
        email: m.curie@ens.fr
        contributions: 'implemented radium tracer in MOM6'
        requests: 'to be offered collaboration on projects using radium tracer'
    'Alan Turing':
        email: al@bletchley.gov.uk
        contributions: 'configured and ran this simulation for my PhD'
        requests: 'until Dec 2027, check with me before using this output (so you don't beat me to publication)'
    'Grace Hopper':
        email: grace@upenn.edu
        contributions: 'created configuration for Europa'
        requests: 'contact me for assistance before using, to avoid misconfiguration'

Configs will be cloned from ACCESS-NRI GitHub repos (e.g. github.com/ACCESS-NRI/access-om3-configs), where they will already have a contributors entry in metadata.yaml containing the names, contributions and requests of any developers who would like recognition. Users can then reconfigure them for experiments and add their own entries giving their requests.

It’s assumed that the absence of an entry with your name means you’re making no requests of users of the config and resulting data.

Hopefully the contributors lists would not grow so long as to become onerous for people using a given config/dataset to honour everyone’s requests.