Skip to content

Commit efd5bda

Browse files
committed
additional draft updates, almost done
1 parent f65dc17 commit efd5bda

5 files changed

Lines changed: 36 additions & 25 deletions

File tree

assets/analysis.png

83.1 KB
Loading

assets/archive.png

474 KB
Loading

assets/instrument.png

133 KB
Loading

assets/pipeline.png

116 KB
Loading

index.qmd

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -127,27 +127,34 @@ GitHub does its job very well. It just does not do this job.
127127
---
128128

129129
## What is a code archive?
130+
![](assets/archive.png){width=200 .float-left}
130131

131-
A code archive is:
132+
<br>
133+
_Persistent and referenced via PID_
134+
135+
_Findable and citable_
132136

133-
- Persistent with PID
134-
- Findable and citable
135-
- Immutable once published
136-
- Backed by long-term infrastructure
137+
_Immutable once published_
138+
139+
_Backed by long-term infrastructure_
137140

138141
::: notes
139142
Timing: 1 min
140143
:::
141144

142145
---
143146

144-
## Zenodo (for code)
147+
## <img src="https://about.zenodo.org/static/img/logos/zenodo-gradient-round.svg" width="400" style="vertical-align: middle;"/> (for code)
148+
149+
_Generalist research repository_
150+
151+
_Free and widely used_
152+
153+
_Issues DOIs via DataCite_
154+
155+
_Integrates with GitHub releases_
145156

146-
- Generalist research repository
147-
- Free and widely used
148-
- Issues DOIs via DataCite
149-
- Integrates with GitHub releases
150-
- operated by CERN
157+
_operated by CERN_
151158

152159
::: notes
153160
Timing: 1 min
@@ -158,13 +165,11 @@ CERN == European Organization for Nuclear Research, an intergovernmental organiz
158165

159166
---
160167

161-
## GitHub + Zenodo model
162-
163-
- **GitHub**: active development
164-
- **Zenodo**: frozen snapshots
168+
## <img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/github/github-original-wordmark.svg" width="225" style="vertical-align: bottom;"/> + <img src="https://about.zenodo.org/static/img/logos/zenodo-gradient-round.svg" width="400" style="vertical-align: middle;"/> model
169+
<br>
170+
_GitHub: active development | where code lives_
165171

166-
**GitHub is where code lives
167-
Zenodo is where code is cited**
172+
_Zenodo: frozen snapshots | where code is cited_
168173

169174
::: notes
170175
Timing: 1 min
@@ -174,9 +179,11 @@ Timing: 1 min
174179

175180
## Where will you use this?
176181

177-
- Instrument development
178-
- Pipeline development
179-
- Analysis iteration
182+
![](assets/instrument.png){width=100 style="vertical-align: middle;"} _Instrument development_
183+
184+
![](assets/pipeline.png){width=100 style="vertical-align: middle;"} _Pipeline development_
185+
186+
![](assets/analysis.png){width=100 style="vertical-align: middle;"} _Analysis iteration_
180187

181188
::: notes
182189
Timing: 2 min
@@ -187,9 +194,11 @@ Ask students to come up with examples
187194

188195
## Versioning and DOIs
189196

190-
- Each GitHub release creates a new Zenodo version
191-
- Each version gets its own DOI
192-
- One concept DOI always points to the latest version
197+
_Each GitHub release → new Zenodo version_
198+
199+
_Each version gets its own ![](https://upload.wikimedia.org/wikipedia/commons/1/11/DOI_logo.svg){width=60 style="vertical-align: middle;"}_
200+
201+
_One parent 'concept' ![](https://upload.wikimedia.org/wikipedia/commons/1/11/DOI_logo.svg){width=60 style="vertical-align: middle;"} always points to the latest version_
193202

194203
::: notes
195204
Timing: 2 min
@@ -200,9 +209,11 @@ This mirrors the Zenodo versioning explanation from the dataset clinic.
200209

201210
## Let's Practice
202211

203-
## Pre-work
212+
## Pre-work:
213+
214+
_did you make a_ <img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/github/github-original-wordmark.svg" width="100" style="vertical-align: middle;"/> _account?_
204215

205-
* Make a GitHub account
216+
_If not, do it <a href="https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github">here</a>_
206217

207218
::: notes
208219
Timing: 3 min

0 commit comments

Comments
 (0)