diff --git a/modules/documentation/ex_suitability.md b/modules/documentation/ex_suitability.md index 0909ce8d..651c15a9 100644 --- a/modules/documentation/ex_suitability.md +++ b/modules/documentation/ex_suitability.md @@ -11,10 +11,12 @@ order: 4 Choose a software project for this exercise, preferably one you are familiar with. If you don't have a project in mind, you can use one of the following: -- [Democracy Topic Modelling](https://research-software-directory.org/software/democracy-topic-modelling) + - [ESMValTool](https://research-software-directory.org/software/esmvaltool) +- [LitStudy](https://research-software-directory.org/software/litstudy) - [Haddock](https://research-software-directory.org/software/haddock3) - [worcs](https://cjvanlissa.github.io/worcs/index.html) +- [democracy-topic-modelling](https://research-software-directory.org/software/democracy-topic-modelling) ## Step 2: Discuss type(s) of documentation diff --git a/modules/publication/JOSS_checklist.md b/modules/publication/JOSS_checklist.md index 474eb39e..7b5b9862 100644 --- a/modules/publication/JOSS_checklist.md +++ b/modules/publication/JOSS_checklist.md @@ -17,11 +17,11 @@ Choose a software project for this exercise, preferably one you are familiar wit If you don't have a software in mind, you can use one of the following: - [ESMValTool](https://research-software-directory.org/software/esmvaltool) -- [Cross-Perspective Topic Modeling](https://research-software-directory.org/software/cptm) - [LitStudy](https://research-software-directory.org/software/litstudy) - [Haddock](https://research-software-directory.org/software/haddock3) - [worcs](https://cjvanlissa.github.io/worcs/index.html) -- [Xenon](https://research-software-directory.org/software/xenon) +- [democracy-topic-modelling](https://research-software-directory.org/software/democracy-topic-modelling) + ## Step 2: Fill the JOSS review checklist diff --git a/modules/publication/discussion.md b/modules/publication/discussion.md deleted file mode 100644 index 27a6b93e..00000000 --- a/modules/publication/discussion.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Before we dive in... -type: exercise -order: 1 ---- - -## Discussion: Before we dive in... - -What do you already know about software publication? - -Discuss how you would publish a piece of software. \ No newline at end of file diff --git a/modules/publication/ex_registries.md b/modules/publication/ex_registries.md index 1b41bcc2..e114da52 100644 --- a/modules/publication/ex_registries.md +++ b/modules/publication/ex_registries.md @@ -11,11 +11,11 @@ A collection of software registries can be found here: [Research Software Regist Choose a piece of research software that you know, or pick one of the packages in this list: -- [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) +- [LitStudy](https://research-software-directory.org/software/litstudy) - [Haddock](https://research-software-directory.org/software/haddock3) - [worcs](https://cjvanlissa.github.io/worcs/index.html) +- [democracy-topic-modelling](https://research-software-directory.org/software/democracy-topic-modelling) In teams: 1. Find out what the software is about if you don't already know. diff --git a/modules/publication/slides-publication.md b/modules/publication/slides-publication.md index 18291e69..f070b94c 100644 --- a/modules/publication/slides-publication.md +++ b/modules/publication/slides-publication.md @@ -12,6 +12,18 @@ order: 2 +## Before we dive in... + +What do you already know about software publication? + +Note: Let participants discuss how they would publish a piece of software. + +Answers can potentially be collected in a collaborative document. + +=== + + + ## What do we mean by publishing? * Publishing the *software itself* (not just publishing an article *about* it) diff --git a/modules/researchsoftware/exercise-research-life-cycle.md b/modules/researchsoftware/exercise-research-life-cycle.md index c8dda175..a108530f 100644 --- a/modules/researchsoftware/exercise-research-life-cycle.md +++ b/modules/researchsoftware/exercise-research-life-cycle.md @@ -18,8 +18,8 @@ Where does it fit in the research life cycle? 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) +- [LitStudy](https://research-software-directory.org/software/litstudy) - [Haddock](https://research-software-directory.org/software/haddock3) - [worcs](https://cjvanlissa.github.io/worcs/index.html) +- [democracy-topic-modelling](https://research-software-directory.org/software/democracy-topic-modelling) diff --git a/modules/softwaremanagementplans/softwareassessment.md b/modules/softwaremanagementplans/softwareassessment.md index 0c8ec91b..20bb43a7 100644 --- a/modules/softwaremanagementplans/softwareassessment.md +++ b/modules/softwaremanagementplans/softwareassessment.md @@ -15,17 +15,18 @@ The group will then create an SMP for this project.* Choose a software project for this exercise, preferably one you are familiar with. If you don't have a project in mind, you can use one of the following: -- [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) +- [LitStudy](https://research-software-directory.org/software/litstudy) - [Haddock](https://research-software-directory.org/software/haddock3) - [worcs](https://cjvanlissa.github.io/worcs/index.html) +- [democracy-topic-modelling](https://research-software-directory.org/software/democracy-topic-modelling) Find the Practical Guide at [tinyurl.com/SMP-guide](https://doi.org/10.5281/zenodo.7589725). ## Step 2: Assess the management level needed -- Look at the software repository or page in the Research Software Directory +- Look at the software repository or page in the Research Software Directory. - Assess what level of management the software needs: low, medium, or high. For this, use the following considerations (section 5 in [the guide](https://doi.org/10.5281/zenodo.7589725)): @@ -45,4 +46,4 @@ Discuss with your group and come to a consensus. From the assessment made in Step 1, get the requirements that match the level of management needed. -Copy a template, and fill it in for your software project. \ No newline at end of file +Copy a template, and fill it in for your software project.