From 5bc253ea705fcfd59df01b226de1bcf7064745da Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 25 Oct 2024 06:31:21 +0200 Subject: [PATCH 01/19] Update config.yaml --- config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.yaml b/config.yaml index b140be4..e5c4231 100644 --- a/config.yaml +++ b/config.yaml @@ -34,7 +34,7 @@ life_cycle: 'pre-alpha' # FIXME license: 'CC-BY 4.0' # Link to the source repository for this lesson -source: 'https://github.com/IPCC-AR7/ipcc-author-guidance' # FIXME +source: 'https://github.com/aspinuso/ipcc-author-guidance' # FIXME # Default branch of your lesson branch: 'main' From bae08f7205cce9d9891d03a2d7e4b0d027c1d6d6 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 25 Oct 2024 06:36:17 +0200 Subject: [PATCH 02/19] Update introduction.md --- episodes/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/introduction.md b/episodes/introduction.md index e842e05..e531f1e 100644 --- a/episodes/introduction.md +++ b/episodes/introduction.md @@ -1,7 +1,7 @@ --- title: "IPCC FAIR Background" teaching: 10 -exercises: 2 +exercises: 2 --- :::::::::::::::::::::::::::::::::::::: questions From cb8817d3f872b1da30e1c41a0fd423c109964480 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 25 Oct 2024 06:39:26 +0200 Subject: [PATCH 03/19] Update test --- episodes/test | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/test b/episodes/test index e37e54c..a6025ce 100644 --- a/episodes/test +++ b/episodes/test @@ -1,7 +1,7 @@ --- title: 'AR7 Tutorial' teaching: 60 -exercises: 30 +exercises: 30 --- :::::::::::::::::::::::::::::::::::::: questions From b4679706f90c6de4b153dc5ec0b5a504c329b403 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 15:48:18 +0100 Subject: [PATCH 04/19] Create ResearchDataManagment.md --- episodes/figures/ResearchDataManagment.md | 56 +++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 episodes/figures/ResearchDataManagment.md diff --git a/episodes/figures/ResearchDataManagment.md b/episodes/figures/ResearchDataManagment.md new file mode 100644 index 0000000..ce4703b --- /dev/null +++ b/episodes/figures/ResearchDataManagment.md @@ -0,0 +1,56 @@ +--- +title: "Research Data Managment" +teaching: 10 +exercises: 1 +--- + +:::::::::::::::::::::::::::::::::::::: questions + +- What licenses are required for datasets or data products that are used? +- What licenses should we apply to created datasets? + +:::::::::::::::::::::::::::::::::::::::::::::::: + +::::::::::::::::::::::::::::::::::::: objectives + +- Understand how to classify source code and data (input, intermediate assessment, final assessment) +- Understand recommended licenses for each data type and code + +:::::::::::::::::::::::::::::::::::::::::::::::: + + +## Introduction + + +::::::::::::::::::::::::::::::::::::: callout + + +:::::::::::::::::::::::::::::::::::::::::::::::: + + + +::::::::::::::::::::::::::::::::::::: challenge + +## Challenge 1: Can you classify the following data types? + +1. A map used in the report +2. Output from a CMIP6 model +3. Model agreement on changes in temperature in a warming scenario + +:::::::::::::::::::::::: solution + +## Output + +1. A map used in the report: Final +2. Output from a CMIP6 model: Input +3. Model agreement on changes in temperature in a warming scenario: Intermediate + +::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::: + +::::::::::::::::::::::::::::::::::::: keypoints + +- +- + +:::::::::::::::::::::::::::::::::::::::::::::::: From 22d483e624af16c555deea3e2a1a3647d4d752a9 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 15:50:38 +0100 Subject: [PATCH 05/19] Create researchdatam.md --- episodes/researchdatam.md | 56 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 episodes/researchdatam.md diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md new file mode 100644 index 0000000..ce4703b --- /dev/null +++ b/episodes/researchdatam.md @@ -0,0 +1,56 @@ +--- +title: "Research Data Managment" +teaching: 10 +exercises: 1 +--- + +:::::::::::::::::::::::::::::::::::::: questions + +- What licenses are required for datasets or data products that are used? +- What licenses should we apply to created datasets? + +:::::::::::::::::::::::::::::::::::::::::::::::: + +::::::::::::::::::::::::::::::::::::: objectives + +- Understand how to classify source code and data (input, intermediate assessment, final assessment) +- Understand recommended licenses for each data type and code + +:::::::::::::::::::::::::::::::::::::::::::::::: + + +## Introduction + + +::::::::::::::::::::::::::::::::::::: callout + + +:::::::::::::::::::::::::::::::::::::::::::::::: + + + +::::::::::::::::::::::::::::::::::::: challenge + +## Challenge 1: Can you classify the following data types? + +1. A map used in the report +2. Output from a CMIP6 model +3. Model agreement on changes in temperature in a warming scenario + +:::::::::::::::::::::::: solution + +## Output + +1. A map used in the report: Final +2. Output from a CMIP6 model: Input +3. Model agreement on changes in temperature in a warming scenario: Intermediate + +::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::: + +::::::::::::::::::::::::::::::::::::: keypoints + +- +- + +:::::::::::::::::::::::::::::::::::::::::::::::: From f04a5382c7c5c89b648c7b2a1dc8b24aaa8a2589 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 15:51:30 +0100 Subject: [PATCH 06/19] Delete episodes/figures/ResearchDataManagment.md --- episodes/figures/ResearchDataManagment.md | 56 ----------------------- 1 file changed, 56 deletions(-) delete mode 100644 episodes/figures/ResearchDataManagment.md diff --git a/episodes/figures/ResearchDataManagment.md b/episodes/figures/ResearchDataManagment.md deleted file mode 100644 index ce4703b..0000000 --- a/episodes/figures/ResearchDataManagment.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Research Data Managment" -teaching: 10 -exercises: 1 ---- - -:::::::::::::::::::::::::::::::::::::: questions - -- What licenses are required for datasets or data products that are used? -- What licenses should we apply to created datasets? - -:::::::::::::::::::::::::::::::::::::::::::::::: - -::::::::::::::::::::::::::::::::::::: objectives - -- Understand how to classify source code and data (input, intermediate assessment, final assessment) -- Understand recommended licenses for each data type and code - -:::::::::::::::::::::::::::::::::::::::::::::::: - - -## Introduction - - -::::::::::::::::::::::::::::::::::::: callout - - -:::::::::::::::::::::::::::::::::::::::::::::::: - - - -::::::::::::::::::::::::::::::::::::: challenge - -## Challenge 1: Can you classify the following data types? - -1. A map used in the report -2. Output from a CMIP6 model -3. Model agreement on changes in temperature in a warming scenario - -:::::::::::::::::::::::: solution - -## Output - -1. A map used in the report: Final -2. Output from a CMIP6 model: Input -3. Model agreement on changes in temperature in a warming scenario: Intermediate - -::::::::::::::::::::::::::::::::: -:::::::::::::::::::::::::::::::::::::::::::::::: - -::::::::::::::::::::::::::::::::::::: keypoints - -- -- - -:::::::::::::::::::::::::::::::::::::::::::::::: From fa413475fdd44da541d49fbdd85b8536d5aebae9 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 16:16:43 +0100 Subject: [PATCH 07/19] Update researchdatam.md --- episodes/researchdatam.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index ce4703b..c1e3c98 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -6,22 +6,22 @@ exercises: 1 :::::::::::::::::::::::::::::::::::::: questions -- What licenses are required for datasets or data products that are used? -- What licenses should we apply to created datasets? - +- What is research data? +- Why is important to properly describe, protect and share research data? + :::::::::::::::::::::::::::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::: objectives -- Understand how to classify source code and data (input, intermediate assessment, final assessment) -- Understand recommended licenses for each data type and code +- Understand the importance of disseminating research data +- Undertand the benefits of a research data management plan :::::::::::::::::::::::::::::::::::::::::::::::: ## Introduction - +[Reproducible Research according to the Turing Way]([https://book.the-turing-way.org/reproducible-research/rdm/rdm-dmp]) ::::::::::::::::::::::::::::::::::::: callout From aef1d05c9fbaf8155a0828be462dd84f578bd84e Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 16:19:24 +0100 Subject: [PATCH 08/19] Update config.yaml --- config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/config.yaml b/config.yaml index 82ea815..5b5a619 100644 --- a/config.yaml +++ b/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 From d915cec2a399a866924c7f2ef5af4a56bf694482 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 16:33:26 +0100 Subject: [PATCH 09/19] Update researchdatam.md --- episodes/researchdatam.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index c1e3c98..0f6b7e7 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -14,16 +14,23 @@ exercises: 1 ::::::::::::::::::::::::::::::::::::: objectives - Understand the importance of disseminating research data -- Undertand the benefits of a research data management plan +- Undertand the benefits of a research data management plan (via the Turing Way) :::::::::::::::::::::::::::::::::::::::::::::::: ## Introduction -[Reproducible Research according to the Turing Way]([https://book.the-turing-way.org/reproducible-research/rdm/rdm-dmp]) +Climate science has significant public interest, as it affects people’s lives, economies, and ecosystems. Effective RDM 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 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/rdm-dmp]) + :::::::::::::::::::::::::::::::::::::::::::::::: From 4cda6f292bfb225764f8b3c62c9e41ba08ae291a Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Thu, 14 Nov 2024 16:39:57 +0100 Subject: [PATCH 10/19] Update researchdatam.md --- episodes/researchdatam.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index 0f6b7e7..b1ba316 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -29,7 +29,7 @@ Research Data Management underpins the accuracy, reproducibility, and impact of The Turing Way 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/rdm-dmp]) +[Reproducible Research according to the Turing Way](https://book.the-turing-way.org/reproducible-research/rdm/rdm-dmp) :::::::::::::::::::::::::::::::::::::::::::::::: From e767a2b7e6bfaf75b3420a588504bc1f89571857 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 15:11:37 +0100 Subject: [PATCH 11/19] Update researchdatam.md --- episodes/researchdatam.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index b1ba316..ac956dc 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -1,5 +1,5 @@ --- -title: "Research Data Managment" +title: "Research Data and Software Managment" teaching: 10 exercises: 1 --- @@ -7,33 +7,39 @@ exercises: 1 :::::::::::::::::::::::::::::::::::::: questions - What is research data? -- Why is important to properly describe, protect and share research data? +- What is research sofware? +- Why is important to properly describe, protect and share research data and software? :::::::::::::::::::::::::::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::: objectives -- Understand the importance of disseminating research data -- Undertand the benefits of a research data management plan (via the Turing Way) +- 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 benefits of Software Management Plan :::::::::::::::::::::::::::::::::::::::::::::::: -## Introduction +## Research Data Management -Climate science has significant public interest, as it affects people’s lives, economies, and ecosystems. Effective RDM 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. +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 offers a general overview on the purposes and practices that motivates RDM, illustrating guidelines and useful approaches to put that into practice. +"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/rdm-dmp) +[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 + ::::::::::::::::::::::::::::::::::::: challenge From 9b2a70142c474b4c0111d18ee2c01a0f0db97247 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 15:40:47 +0100 Subject: [PATCH 12/19] Update researchdatam.md --- episodes/researchdatam.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index ac956dc..a1f09d0 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -7,7 +7,7 @@ exercises: 1 :::::::::::::::::::::::::::::::::::::: questions - What is research data? -- What is research sofware? +- What is research software? - Why is important to properly describe, protect and share research data and software? :::::::::::::::::::::::::::::::::::::::::::::::: @@ -16,7 +16,7 @@ exercises: 1 - 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 benefits of Software Management Plan +- Understad the difference between research code and software and the benefits of a Software Management Plan :::::::::::::::::::::::::::::::::::::::::::::::: @@ -40,7 +40,27 @@ For instance some IPCC Working Groups may propose a [Data Management Plan](https ## Software Management +Before dwelving into sofware management, it is worth hlighting the differences 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 scripts 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 + +::::::::::::::::::::::::::::::::::::: callout + +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: Research code is 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. + Rapid Development: Researchers often write code quickly and iteratively to meet the immediate demands of their experiments. and shared via Open-source platforms like GitHub, GitLab. + Reproducible: In many cases, research code is shared openly to promote reproducibility and transparency. Open-source platforms like Jupyter Lab, 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. + 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. + Collaboration and sharing, such as through platforms like LaTeX or tools like SPSS, MS Excel, or Tableau for data analysis. + +:::::::::::::::::::::::::::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::: challenge From d4b10315a0268489fb8bcf95fc51179459c56d62 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 15:45:43 +0100 Subject: [PATCH 13/19] Update researchdatam.md --- episodes/researchdatam.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index a1f09d0..5c1b00c 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -48,17 +48,18 @@ Before dwelving into sofware management, it is worth hlighting the differences b ::::::::::::::::::::::::::::::::::::: callout -Key characteristics of **Research Code**: +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: Research code is 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. - Rapid Development: Researchers often write code quickly and iteratively to meet the immediate demands of their experiments. and shared via Open-source platforms like GitHub, GitLab. - Reproducible: In many cases, research code is shared openly to promote reproducibility and transparency. Open-source platforms like Jupyter Lab, 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. +- 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: Research code is 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. +- Rapid Development: Researchers often write code quickly and iteratively to meet the immediate demands of their experiments. and shared via Open-source platforms like GitHub, GitLab. +- Reproducible: In many cases, research code is shared openly to promote reproducibility and transparency. Open-source platforms like Jupyter Lab, 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. - 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. - Collaboration and sharing, such as through platforms like LaTeX or tools like SPSS, MS Excel, or Tableau for data analysis. + +- Comprehensive and integrated, supporting tasks like data management, analysis, and visualization, often with a user-friendly interface. +- 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. +- Collaboration and sharing, such as through platforms like LaTeX or tools like SPSS, MS Excel, or Tableau for data analysis. :::::::::::::::::::::::::::::::::::::::::::::::: From 3ddc82edfa34f266e9833d35875ef8a19f7c4685 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 15:52:29 +0100 Subject: [PATCH 14/19] Update researchdatam.md --- episodes/researchdatam.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index 5c1b00c..b98643f 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -51,15 +51,13 @@ Before dwelving into sofware management, it is worth hlighting the differences b 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: Research code is 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. -- Rapid Development: Researchers often write code quickly and iteratively to meet the immediate demands of their experiments. and shared via Open-source platforms like GitHub, GitLab. -- Reproducible: In many cases, research code is shared openly to promote reproducibility and transparency. Open-source platforms like Jupyter Lab, 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. +- 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. -- 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. -- Collaboration and sharing, such as through platforms like LaTeX or tools like SPSS, MS Excel, or Tableau for data analysis. +- 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. :::::::::::::::::::::::::::::::::::::::::::::::: From 352a4fda9b2b49bd1f6ef9a87faaf68593ed30b7 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 17:12:50 +0100 Subject: [PATCH 15/19] Update researchdatam.md --- episodes/researchdatam.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index b98643f..8cbe0f1 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -42,11 +42,9 @@ For instance some IPCC Working Groups may propose a [Data Management Plan](https Before dwelving into sofware management, it is worth hlighting the differences 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 scripts used to generate one of the figures in the IPCC reports. +**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 - -::::::::::::::::::::::::::::::::::::: callout +**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** @@ -59,23 +57,33 @@ 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) + +This will have the scope to define key aspects which should be taken into account by IPCC 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 [Atlas](https://interactive-atlas.ipcc.ch/). + :::::::::::::::::::::::::::::::::::::::::::::::: +## Challenge 1: Can you classify the following software types? ::::::::::::::::::::::::::::::::::::: challenge -## Challenge 1: Can you classify the following data types? -1. A map used in the report -2. Output from a CMIP6 model -3. Model agreement on changes in temperature in a warming scenario +1. +2. :::::::::::::::::::::::: solution ## Output -1. A map used in the report: Final -2. Output from a CMIP6 model: Input -3. Model agreement on changes in temperature in a warming scenario: Intermediate +1. ::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::::::::: From 68291d9198d834feb33c6174b4c5bb8b2f6c5682 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 17:25:09 +0100 Subject: [PATCH 16/19] Update researchdatam.md Draft version of an episode highlighting the motivations and relevance of curating research data and software adopting proper strategies and tools. --- episodes/researchdatam.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index 8cbe0f1..3487889 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -66,9 +66,9 @@ Some working groups may consdier to propose a Software Management Plan. This is - 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) +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 Duth insitute for eScience. -This will have the scope to define key aspects which should be taken into account by IPCC 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 [Atlas](https://interactive-atlas.ipcc.ch/). +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/). :::::::::::::::::::::::::::::::::::::::::::::::: From 52ab5eae2b8fee3c98e3ac8b3b61affe33fb2ef1 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 17:28:15 +0100 Subject: [PATCH 17/19] Update researchdatam.md --- episodes/researchdatam.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index 3487889..91c9f2d 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -66,7 +66,7 @@ Some working groups may consdier to propose a Software Management Plan. This is - 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 Duth insitute for eScience. +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/). From 7a17fee5e16cd84583dfaeb7aa9a5ba3beefc035 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 17:34:31 +0100 Subject: [PATCH 18/19] Update researchdatam.md Draft episodes about importance of Research Data and Software Management, with references to external relevant material. TBC --- episodes/researchdatam.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/episodes/researchdatam.md b/episodes/researchdatam.md index 91c9f2d..1587e8a 100644 --- a/episodes/researchdatam.md +++ b/episodes/researchdatam.md @@ -38,9 +38,9 @@ For instance some IPCC Working Groups may propose a [Data Management Plan](https :::::::::::::::::::::::::::::::::::::::::::::::: -## Software Management +## Software Management Plans -Before dwelving into sofware management, it is worth hlighting the differences between Research Code and Research Software. +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. From debf06b37592ea4bfa569e5cb2fcfbd0c9d182e2 Mon Sep 17 00:00:00 2001 From: Alessandro Spinuso Date: Fri, 15 Nov 2024 17:40:30 +0100 Subject: [PATCH 19/19] Update config.yaml --- config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.yaml b/config.yaml index 5b5a619..742c81d 100644 --- a/config.yaml +++ b/config.yaml @@ -34,7 +34,7 @@ life_cycle: 'pre-alpha' # FIXME license: 'CC-BY 4.0' # Link to the source repository for this lesson -source: 'https://github.com/aspinuso/ipcc-author-guidance' # FIXME +source: 'https://github.com/IPCC-AR7/ipcc-author-guidance' # FIXME # Default branch of your lesson branch: 'main'