Skip to content

Commit

Permalink
Merge pull request #143 from esciencecenter-digital-skills/day2-updates
Browse files Browse the repository at this point in the history
typos and minor changes
  • Loading branch information
JaroCamphuijsen authored Nov 6, 2024
2 parents 26a554f + 3ddc160 commit 5a58a82
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion modules/citation/slides-citation.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Note:
<!-- .slide: data-state="standard" -->
## What software to cite?

*""...the software itself should be cited on the same basis as any other research product; authors should cite the appropriate set of software products."*
*"...the software itself should be cited on the same basis as any other research product; authors should cite the appropriate set of software products."*

Which software would you cite?

Expand Down
1 change: 0 additions & 1 deletion modules/distributing/slides-distributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,3 @@ Specify the dependencies in a file and let the user build their own environment,
- If other software might depend on this software, package it
- To archive a specific software version and its environment, you could use a container

===
3 changes: 2 additions & 1 deletion modules/licenses/ex_finding_the_license.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Finding the license
title: Find the license
type: exercise
order: 3
---
Expand All @@ -23,3 +23,4 @@ A few hints:
- The researcher only gave you the name. You'll have to find the code on the Internet first.
- Licenses are not always advertised on a code's website. Try looking somewhere more technical if you can't find it in the documentation.

## Exercise 2: What advice would you give?
4 changes: 4 additions & 0 deletions modules/publication/slides-publication.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ Reusability - it's only reusable if it's available, and if people know what they
* Write a paper about those results
* Possibly not even mentioning the software at all

===

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

### Consequences

* The software itself is not citable
Expand Down
4 changes: 2 additions & 2 deletions modules/testing/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Untested software can be compared to uncalibrated experimental devices.

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

## Risks of untested research software
## Risks of poorly tested (research) software

<center>
<img src="media/testing-motivation1.png" width="30%" style="display:inline;">
Expand All @@ -59,7 +59,7 @@ There is also the case of the Ariane flight V88, an European Space Agency rocket

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

## Why testing your software ?
## Why test your software ?

- Ensure software reliability, validity, and reproducibility.
- Confirm correct installation and demonstrate use.
Expand Down

0 comments on commit 5a58a82

Please sign in to comment.