From 9a29b82a317b8a901440e32999a9cd7e0223eb3a Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 9 Dec 2024 02:28:18 +0000 Subject: [PATCH] site deploy Auto-generated via `{sandpaper}` Source : 6518409f70215b6fef0a973dcee2bcd14f782351 Branch : md-outputs Author : GitHub Actions Time : 2024-12-09 02:28:06 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 0ad6eb787c4c757c6120688e412f3a6545b8d3a5 Branch : main Author : April Lamb <55679202+aprildlamb@users.noreply.github.com> Time : 2024-12-09 02:27:16 +0000 Message : Merge pull request #9 from aspinuso/main Draft episode on Research Data and Software Management. --- 404.html | 25 +- CODE_OF_CONDUCT.html | 21 +- LICENSE.html | 21 +- aio.html | 225 ++++++++++- config.yaml | 1 + evolution_of_reports.html | 31 +- images.html | 27 +- index.html | 23 +- instructor-notes.html | 26 +- instructor/404.html | 25 +- instructor/CODE_OF_CONDUCT.html | 21 +- instructor/LICENSE.html | 21 +- instructor/aio.html | 228 ++++++++++- instructor/evolution_of_reports.html | 31 +- instructor/images.html | 27 +- instructor/index.html | 51 ++- instructor/instructor-notes.html | 27 +- instructor/introduction.html | 37 +- instructor/key-points.html | 35 +- instructor/licensing.html | 23 +- instructor/markdown.html | 41 +- instructor/profiles.html | 23 +- instructor/reference.html | 21 +- instructor/researchdatam.html | 571 +++++++++++++++++++++++++++ instructor/tutorial.html | 51 ++- introduction.html | 37 +- key-points.html | 35 +- licensing.html | 23 +- markdown.html | 39 +- md5sum.txt | 5 +- pkgdown.yml | 2 +- profiles.html | 23 +- reference.html | 21 +- researchdatam.html | 569 ++++++++++++++++++++++++++ sitemap.xml | 6 + test | 2 +- tutorial.html | 51 ++- 37 files changed, 2152 insertions(+), 294 deletions(-) create mode 100644 instructor/researchdatam.html create mode 100644 researchdatam.html diff --git a/404.html b/404.html index 4e09ca1..70a76cf 100644 --- a/404.html +++ b/404.html @@ -219,7 +219,7 @@

@@ -230,7 +230,7 @@

@@ -241,7 +241,7 @@

@@ -252,7 +252,18 @@

+ +
+
+ @@ -364,9 +375,9 @@

Page not found

"creativeWorkStatus": "active", "url": "https://IPCC-AR7.github.io/ipcc-author-guidance/404.html", "identifier": "https://IPCC-AR7.github.io/ipcc-author-guidance/404.html", - "dateCreated": "2024-10-25", - "dateModified": "2024-12-03", - "datePublished": "2024-12-03" + "dateCreated": "2024-12-09", + "dateModified": "2024-12-09", + "datePublished": "2024-12-09" } +
+ IPCC FAIR Tutorial for Authors +
+ +
+
+ + + + + +
+
+

Research Data and Software Managment

+

Last updated on 2024-12-09 | + + Edit this page

+ + + +

Estimated time: 11 minutes

+ +
+ +
+ + + +
+

Overview

+
+
+
+
+

Questions

+
  • What is research data?
    • +
  • What is research software?
    • +
  • Why is important to properly describe, protect and share research +data and software?
    • +
+
+
+
+
+
+

Objectives

+
  • Understand the importance of disseminating research data and the +code used for its generation
    • +
  • Undertand the benefits of a Research Data Management plan (via the +Turing Way)
    • +
  • Understad the difference between research code and software and the +benefits of a Software Management Plan
    • +
+
+
+
+
+

Research Data Management

+

Climate science has significant public interest, as it affects +people’s lives, economies, and ecosystems. Effective Research Data +Management supports open science initiatives by making data accessible +to the public, policymakers, and other stakeholders, increasing +transparency, and encouraging public engagement. This openness builds +trust and fosters greater awareness and informed decision-making +regarding climate action.

+

Research Data Management underpins the accuracy, reproducibility, and +impact of research findings. It supports collaborative and transparent +science. In IPCC it helps ensure that investments in the realisation of +the assessments continue to benefit scientific inquiry and public +policy.

+
+
+ +
+
+

Callout

+
+

“The Turing Way”, an open science and community-driven project +focused on making data science more accessible, understandable, and +effective, offers a general overview on the purposes and practices that +motivates RDM, illustrating guidelines and useful approaches to put that +into practice.

+

Reproducible +Research according to the Turing Way

+

For instance some IPCC Working Groups may propose a Data +Management Plan.

+
+
+
+

Software Management Plans

+

Before diving into Software Management Plans, it is important to +highlight the distinctions between research code and research +software

+

Rresearch Code is the individual, often +experimental, coding work that solves specific problems in the research +process, It is often a custom solution developed for a specific research +question or experiment. For instance the script used to generate one of +the figures in the IPCC reports.

+

Research Software is a broader, often more stable +tool or platform that assists in conducting research across various +stages of the workflow. Both are critical components of modern research, +with research code often contributing to the development of research +software. Eg. the ESMVal Tool

+

Key characteristics of Research Code

+
  • Custom and Domain-Specific: It is typically tailored to address the +unique needs of a particular research task or domain (e.g., +bioinformatics, physics simulations, social sciences).
    • +
  • Prototyping and Experimentation: Often experimental, evolving during +the research process as the researcher tests and refines ideas. This +could be in the form of scripts for data collection, analysis, or +visualization.
    • +
  • Reproducible: In many cases, research code is shared openly to +promote reproducibility and transparency. Open-source platforms like +GitHub, GitLab, and Bitbucket are commonly used for sharing and +collaborating on research code. Scripts my be expresssed as Jupyter +Notebooks and re-executed in Jupyter platforms like Jupyter Lab, Jupyter +Hub or Binder.
    • +

Key characteristics of Research Sofware

+
  • Comprehensive and integrated: supporting tasks like data management, +analysis, and visualization, often with a user-friendly interface. For +instance, tools like SPSS, MS Excel, or Tableau.
    • +
  • Production-ready: stable, and maintainable, featuring error handling +and documentation. It can be domain-specific (e.g., statistical tools, +simulation platforms) or general-purpose (e.g., text editors, database +systems) and is widely used in research.
    • +
+
+ +
+
+

Callout

+
+

Some working groups may consdier to propose a Software Management +Plan. This is usually a document that addresses questions such as.

+
  • What does it do?
    • +
  • Who is it for?
    • +
  • What resources does it need?
    • +
  • Who is responsible?
    • +
  • What licence does it needs?
    • +

Having such clarity early on, avoid problems later, with the +objective of facilitatng IPCC to deliver FAIR +code and software. Example of SMPs exists in many organisations. A +detailed list of elements that are relevant in the defintion of SMP +for Research Code and Software is provided by the Dutch insitute for +eScience.

+

In IPCC, SMPs can have the scope to define key aspects which should +be taken into account by the authors, depending whether they will +develop and release simple scripts, for data analysis and visualisation +purposes, or more complex Research Software, like for instance a new IPCC Atlas.

+
+
+
+

Challenge 1: Can you classify the following software types?

+
+
+ +
+
+

Challenge

+
+
  1. +
    2. +
  2. :::::::::::::::::::::::: solution
    3. +
+

Output

+
  1. +
+
+
+
+

::::::::::::::::::::::::::::::::::::::::::::::::

+
+
+ +
+
+

Key Points

+
+
  • +
    • +
  • +
    • +
+
+
+ +
+
+ + +
+
+ + + diff --git a/instructor/tutorial.html b/instructor/tutorial.html index ad2f9bb..408428b 100644 --- a/instructor/tutorial.html +++ b/instructor/tutorial.html @@ -118,11 +118,11 @@ IPCC FAIR Tutorial for Authors
-