Day3: FAIR cookbook working group HackMD

Cookbook / DMP work group, Day 3 (Wednesday)

Background: https://fairplus.github.io/the-fair-cookbook/content/home.html

  • What is a "recipe?" Could be useful to define the definition of this and "cookbook" in introduction
    • Not complete, but some answers can be found here: https://fairplus.github.io/the-fair-cookbook/content/recipes/help/how-to-create-recipe-with-git.html

To do's:

  • Create a mailing list -> meeting schedule
  • FAIRs fair - review of first draft.

Create a starting template

What platform/technology should we use for a cookbook? Jupyter book?, jupyter notebook? Github.

  • During the hackathon - use HackMD
  • After hackathon, migrate to github (Hamish)
  • Q. How to manage pull requests?
    • A. ??

Basic layout (first suggestion)

  1. Introduction

    • What this cookbook is, why has it been written
      • strive for best practices
    • Basics on FAIR
    • The data lifecycle - general description
      • Research objects
    • DMPs
  2. Instructions on how to contribute (to this cookbook)

(Hamish)

  1. Models workflow: capturing metadata

    1. NorESM / CESM

      • How to capture metadata within workflow (general)

      • Institutional specifics

        • Bolin Centre
          • Information for reproducing workflow
            • R markdown (examples, templates)
            • Jupyter notebooks (examples, templates)
            • Workflow managers (examples, templates)
            • Container
            • ...
          • Findability
            • Research/metadata object
            • ROHub
            • WorkflowHub
            • ...
        • UiO
          • Information for reproducing workflow
            • R markdown (examples, templates)
            • Jupyter notebooks (examples, templates)
            • Workflow managers (examples, templates)
            • Container
            • ...
          • Findability
            • Research/metadata object
            • ROHub
            • WorkflowHub
            • ...
        • ...
    2. RCM

      • How to capture metadata within workflow (general)
        • (Geographical) domain specifications
        • Boundary data (with identifiable version, e.g. POI)
        • Version of codebase (e.g. Github commit hash), local modifications
      • Institutional specifics
        • Bolin Centre
        • UiO
        • MET Norway
        • ...
    3. ...

  2. Data analysis: Recipe for citing

    1. Data
      1. CMIP/ESGF
      2. Observations.
      3. ...
    2. Software
    3. Reproducability
      • Tools for reproducing workflow
        • R markdown (examples, templates)
        • Jupyter notebooks (examples, templates)
        • Workflow managers (examples, templates)
        • Research Objects (examples, templates)
        • ...
      • Institution specifics
        • Bolin Centre gitlab, can create a repo of source code and publish to Bolin Centre Database: https://bolin.su.se/data/
          • If separate from data (if data is hosted elsewhere for example): https://git.bolin.su.se/
  3. Testing FAIRness

    • How to test FAIRness of your research work
      • data
      • software
      • workflow
      • ...
  4. License (cookbook license)

    • Types of license
      • CC BY, CC BY-NC-ND
    • Legal requirements of license (by funding, etc.)
  5. Acknowledgements

Challenges

  • Searchability
  • Practicality of downloading/acquiring
    • Downloading from certain databases (e.g. our own in Dataverse) can be cumbersome, as all has to be downloaded at once. Can it be separated for individual download?
  • Environments, containers etc.
  • What data is required to be stored? (Storing only certain variables, restart files and ICs, etc.)
  • Separate/consolidated metadata

Funding

NICEST2 is a project within the Nordic e-Infrastructure Collaboration (NeIC). NeIC is an organisational unit under NordForsk.

Follow us

NordicESMHub GitHub organization