From 527f867db047508384875780d90be8568c8faa9b Mon Sep 17 00:00:00 2001 From: Jaro Camphuijsen Date: Tue, 2 Apr 2024 15:07:26 +0200 Subject: [PATCH 1/3] move slides markdown files up into module folder --- modules/researchsoftware/{media => }/slides-researchsoftware.md | 0 modules/researchsoftware/{media => }/slides-software.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename modules/researchsoftware/{media => }/slides-researchsoftware.md (100%) rename modules/researchsoftware/{media => }/slides-software.md (100%) diff --git a/modules/researchsoftware/media/slides-researchsoftware.md b/modules/researchsoftware/slides-researchsoftware.md similarity index 100% rename from modules/researchsoftware/media/slides-researchsoftware.md rename to modules/researchsoftware/slides-researchsoftware.md diff --git a/modules/researchsoftware/media/slides-software.md b/modules/researchsoftware/slides-software.md similarity index 100% rename from modules/researchsoftware/media/slides-software.md rename to modules/researchsoftware/slides-software.md From bdae7a62ad9b27c3bf381f6335a88d5f6427ec7f Mon Sep 17 00:00:00 2001 From: Jaro Camphuijsen Date: Tue, 2 Apr 2024 15:11:45 +0200 Subject: [PATCH 2/3] split up top level markdown into chapter specific md files --- modules/researchsoftware.md | 80 ------------------- .../exercise-research-life-cycle.md | 20 +++++ modules/researchsoftware/research-software.md | 14 ++++ modules/researchsoftware/software-and-data.md | 26 ++++++ 4 files changed, 60 insertions(+), 80 deletions(-) create mode 100644 modules/researchsoftware/exercise-research-life-cycle.md create mode 100644 modules/researchsoftware/research-software.md create mode 100644 modules/researchsoftware/software-and-data.md diff --git a/modules/researchsoftware.md b/modules/researchsoftware.md index 35a9407b..74ac4534 100644 --- a/modules/researchsoftware.md +++ b/modules/researchsoftware.md @@ -8,84 +8,4 @@ thumbnail: "nlesc-dummy.png" visibility: visible --- -:::Chapter{headline="Slides: Software" presentation="slides-software.md"} - -::: - -:::Chapter{headline="Software and Data" widemd=1} - -### Software is data (10 minutes, optional) -In computer science, the fact that software is data is considered one of the fundamental concepts of computing. The fact that the thing that operates the machine (software) is the same kind of thing as the thing it operates on (data) is definitely one of the strengths of current computersystems and one of the main reasons why we can do such complex and powerful things with the combination of hardware and software. - -Read the following blogpost about why this concept is so powerful: -https://www.blackliszt.com/2014/04/fundamental-concepts-of-computing-software-is-data.html - - -### Software is a special type of data () -However for most practical purposes in most domains of scientific research (except maybe the domain of computer science) it is useful to make a distinction between the data that is software and other data. From now on, when we use the word data, we mean the kind fo data which is not software and which we use to store more static information. - -- Software is executable, data is not. -- Data provides information or evidence, software provides a tool to do work on the data. -- Software is a creative work, scientific data are facts or observations. -- The lifetime of software is generally not as long as that of data. - - -https://github.com/danielskatz/software-vs-data - -https://doi.org/10.7287/peerj.preprints.2630v1 - - -### Discussion - -- -- Can you think of examples where the line between software and data becomes fuzzy? - -::: - -:::Chapter{headline="Slides: Research Software" presentation="slides-researchsoftware.md"} - -::: - -:::Chapter{headline="Research software" widemd=1} - -## The role of research software (10 minutes) - -The following piece was written after a workshop called "The Future of Research Software", held in the Netherlands in 2022. - -It explores the different roles for research software in the research life cycle, strengthening the case for sustainable software. - -[Defining the Roles of Research Software](https://upstream.force11.org/defining-the-roles-of-research-software/) - -After reading the piece, discuss the following questions: - -- What are the different roles of research software? -- What are the challenges for each of these roles? -- How can we address these challenges? - -::: - - -:::Chapter{headline="Exercise: the Research Life Cycle" widemd=1} - -## Exercise: Where does software fit in the research life cycle? - -Take a look at the research life cycle below. - -The Research Life Cycle - -Think of a piece of research software you have used or developed. - -Where does it fit in the research life cycle? - -### Existing software - -The following research software can also be used as examples: - -- [Xenon](https://research-software-directory.org/software/xenon) -- [ESMValTool](https://research-software-directory.org/software/esmvaltool) -- [RS-DAT](https://research-software-directory.org/projects/rs-dat) -- [Haddock](https://research-software-directory.org/software/haddock3) -- [worcs](https://cjvanlissa.github.io/worcs/index.html) - -::: diff --git a/modules/researchsoftware/exercise-research-life-cycle.md b/modules/researchsoftware/exercise-research-life-cycle.md new file mode 100644 index 00000000..07465931 --- /dev/null +++ b/modules/researchsoftware/exercise-research-life-cycle.md @@ -0,0 +1,20 @@ + +## Exercise: Where does software fit in the research life cycle? + +Take a look at the research life cycle below. + +The Research Life Cycle + +Think of a piece of research software you have used or developed. + +Where does it fit in the research life cycle? + +### Existing software + +The following research software can also be used as examples: + +- [Xenon](https://research-software-directory.org/software/xenon) +- [ESMValTool](https://research-software-directory.org/software/esmvaltool) +- [RS-DAT](https://research-software-directory.org/projects/rs-dat) +- [Haddock](https://research-software-directory.org/software/haddock3) +- [worcs](https://cjvanlissa.github.io/worcs/index.html) diff --git a/modules/researchsoftware/research-software.md b/modules/researchsoftware/research-software.md new file mode 100644 index 00000000..74502f38 --- /dev/null +++ b/modules/researchsoftware/research-software.md @@ -0,0 +1,14 @@ + +## The role of research software (10 minutes) + +The following piece was written after a workshop called "The Future of Research Software", held in the Netherlands in 2022. + +It explores the different roles for research software in the research life cycle, strengthening the case for sustainable software. + +[Defining the Roles of Research Software](https://upstream.force11.org/defining-the-roles-of-research-software/) + +After reading the piece, discuss the following questions: + +- What are the different roles of research software? +- What are the challenges for each of these roles? +- How can we address these challenges? diff --git a/modules/researchsoftware/software-and-data.md b/modules/researchsoftware/software-and-data.md new file mode 100644 index 00000000..8060fd5a --- /dev/null +++ b/modules/researchsoftware/software-and-data.md @@ -0,0 +1,26 @@ + +### Software is data (10 minutes, optional) +In computer science, the fact that software is data is considered one of the fundamental concepts of computing. The fact that the thing that operates the machine (software) is the same kind of thing as the thing it operates on (data) is definitely one of the strengths of current computersystems and one of the main reasons why we can do such complex and powerful things with the combination of hardware and software. + +Read the following blogpost about why this concept is so powerful: +https://www.blackliszt.com/2014/04/fundamental-concepts-of-computing-software-is-data.html + + +### Software is a special type of data () +However for most practical purposes in most domains of scientific research (except maybe the domain of computer science) it is useful to make a distinction between the data that is software and other data. From now on, when we use the word data, we mean the kind fo data which is not software and which we use to store more static information. + +- Software is executable, data is not. +- Data provides information or evidence, software provides a tool to do work on the data. +- Software is a creative work, scientific data are facts or observations. +- The lifetime of software is generally not as long as that of data. + + +https://github.com/danielskatz/software-vs-data + +https://doi.org/10.7287/peerj.preprints.2630v1 + + +### Discussion + +- +- Can you think of examples where the line between software and data becomes fuzzy? From 6fe4131d9b5b21c0cd540a1e48805c5e2b412fa9 Mon Sep 17 00:00:00 2001 From: Carlos Martinez Date: Wed, 3 Apr 2024 16:05:37 +0200 Subject: [PATCH 3/3] Adding research software exercise --- .../exercise-is-it-research-software.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 modules/researchsoftware/exercise-is-it-research-software.md diff --git a/modules/researchsoftware/exercise-is-it-research-software.md b/modules/researchsoftware/exercise-is-it-research-software.md new file mode 100644 index 00000000..213d9c66 --- /dev/null +++ b/modules/researchsoftware/exercise-is-it-research-software.md @@ -0,0 +1,24 @@ + +## Exercise: Is it research software? + +Using the definition of research software from the FAIR4RS working group, try to classify the following as "research software" or "software in research" + +### Example software tools + +#### Shape Preserving Local Histogram Modification Algorithm +[An Analysis and Implementation of the Shape Preserving Local Histogram Modification Algorithm](https://doi.org/10.5201/ipol.2018.236) is a published article on [IPOL](https://www.ipol.im/). The source code implementing the algorithm is available for download. + +Is this "research software" or "software in research"? + +#### SciPy +[SciPy](https://zbmath.org/software/6293) is open-source software for mathematics, science, and engineering. +It is also the name of a very popular conference on scientific programming with Python. The SciPy library depends on NumPy, which provides convenient and fast N-dimensional array manipulation. +The SciPy library is built to work with NumPy arrays, and provides many user-friendly and efficient numerical routines such as routines for numerical integration and optimization. +Together, they run on all popular operating systems, are quick to install, and are free of charge. +NumPy and SciPy are easy to use, but powerful enough to be depended upon by some of the world’s leading scientists and engineers. + +Is this "research software" or "software in research"? + +### Other software tools +How about other software tools you are familiar with? +Can you provide an example of software you are familiar with, and then classify it as "research software" or "software in research"?