markdown source builds

Auto-generated via `{sandpaper}`
Source  : 0ad6eb7
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.

config.yaml

@@ -67,6 +67,7 @@ contact: 'april.lamb@ipcc-wg3.gov' # Still need to decide who this should be
 # Order of episodes in your lesson
 episodes:
 - introduction.md
+- researchdatam.md
 - tutorial.md
 - markdown.md
 - evolution_of_reports.md

introduction.md

@@ -1,7 +1,7 @@
 ---
 title: "IPCC FAIR Background"
 teaching: 10
-exercises: 2
+exercises: 2 
 ---
 
 :::::::::::::::::::::::::::::::::::::: questions 

md5sum.txt

@@ -1,10 +1,11 @@
 "file" "checksum" "built" "date"
 "CODE_OF_CONDUCT.md" "c93c83c630db2fe2462240bf72552548" "site/built/CODE_OF_CONDUCT.md" "2022-08-05"
 "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2023-04-07"
-"config.yaml" "9990dce1366397237d9455eb1433395b" "site/built/config.yaml" "2024-10-25"
+"config.yaml" "5069ab761d4ac556c646b7105abdb3f1" "site/built/config.yaml" "2024-12-09"
 "index.md" "a02c9c785ed98ddd84fe3d34ddb12fcd" "site/built/index.md" "2022-04-22"
 "links.md" "8184cf4149eafbf03ce8da8ff0778c14" "site/built/links.md" "2022-04-22"
-"episodes/introduction.md" "f20c2fc377f1d5f4a073f58c514f4604" "site/built/introduction.md" "2024-10-25"
+"episodes/introduction.md" "0656d10cb7ca8616d85d473a75348c15" "site/built/introduction.md" "2024-12-09"
+"episodes/researchdatam.md" "4a110cd8c60616085817d8f9fa2b82c3" "site/built/researchdatam.md" "2024-12-09"
 "episodes/tutorial.md" "ba52111d2950481b62621b0a734817f0" "site/built/tutorial.md" "2024-10-25"
 "episodes/markdown.md" "e76025134a989ae48efdfc3544d5bb90" "site/built/markdown.md" "2024-10-25"
 "episodes/evolution_of_reports.md" "35327d01856e4b9b784af071e6294c25" "site/built/evolution_of_reports.md" "2024-10-25"

researchdatam.md

@@ -0,0 +1,96 @@
+---
+title: "Research Data and Software Managment"
+teaching: 10
+exercises: 1
+---
+
+:::::::::::::::::::::::::::::::::::::: 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](https://book.the-turing-way.org/reproducible-research/rdm) 
+
+For instance some IPCC Working Groups may propose a [Data Management Plan](https://book.the-turing-way.org/reproducible-research/rdm/rdm-dmp).
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+## 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](https://esmvaltool.org/)
+
+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](https://www.rug.nl/digital-competence-centre/research-data/research-software-management/fair-research-software?lang=en). 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](https://esciencecenter-digital-skills.github.io/research-software-support/modules/softwaremanagementplans/slides-smp) 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](https://interactive-atlas.ipcc.ch/).
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Challenge 1: Can you classify the following software types?
+::::::::::::::::::::::::::::::::::::: challenge
+
+
+
+1. 
+2. 
+:::::::::::::::::::::::: solution
+
+## Output
+
+1. 
+
+:::::::::::::::::::::::::::::::::
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: keypoints
+
+- 
+- 
+
+::::::::::::::::::::::::::::::::::::::::::::::::

test

@@ -1,7 +1,7 @@
 ---
 title: 'AR7 Tutorial'
 teaching: 60
-exercises: 30
+exercises: 30 
 ---
 
 :::::::::::::::::::::::::::::::::::::: questions