Skip to content

Commit

Permalink
Merge pull request #99 from esciencecenter-digital-skills/98-luisafor…
Browse files Browse the repository at this point in the history
…ozco-software_examples

Update the list of software that can be used for the exercise in the SMP
  • Loading branch information
JaroCamphuijsen authored Sep 3, 2024
2 parents f0eddad + 5ad40b4 commit 2455ff1
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 22 deletions.
4 changes: 3 additions & 1 deletion modules/documentation/ex_suitability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions modules/publication/JOSS_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 0 additions & 11 deletions modules/publication/discussion.md

This file was deleted.

4 changes: 2 additions & 2 deletions modules/publication/ex_registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 12 additions & 0 deletions modules/publication/slides-publication.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ order: 2

<!-- .slide: data-state="standard" -->

## 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.

===

<!-- .slide: data-state="standard" -->

## What do we mean by publishing?

* Publishing the *software itself* (not just publishing an article *about* it)
Expand Down
4 changes: 2 additions & 2 deletions modules/researchsoftware/exercise-research-life-cycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
9 changes: 5 additions & 4 deletions modules/softwaremanagementplans/softwareassessment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)):
Expand All @@ -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.
Copy a template, and fill it in for your software project.

0 comments on commit 2455ff1

Please sign in to comment.