generated from neuroinformatics-unit/quarto-presentation-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.qmd
145 lines (110 loc) · 4.05 KB
/
index.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
---
title: Beyond your script
title-slide-attributes:
data-background-image: img/jukan-tateisi-bJhT_8nbUA0-unsplash.jpg
data-background-opacity: "0.5"
subtitle: An introduction to collaborative coding and software engineering good practice
author: Alessandro Felder, Laura Porta, Chang Huan Lo
execute:
enabled: true
format:
revealjs:
theme: [default, niu-dark.scss]
logo: img/logo_niu_dark.png
footer: "Collaborative coding and software engineering good practice | 2024-10-02"
slide-number: c
menu:
numbers: true
chalkboard: true
scrollable: true
preview-links: false
view-distance: 10
mobile-view-distance: 10
auto-animate: true
auto-play-media: true
code-overflow: wrap
highlight-style: atom-one
mermaid:
theme: neutral
fontFamily: arial
curve: linear
html:
theme: [default, niu-dark.scss]
logo: img/logo_niu_dark.png
date: "2024-10-02"
toc: true
code-overflow: scroll
highlight-style: atom-one
mermaid:
theme: neutral
fontFamily: arial
curve: linear
margin-left: 0
embed-resources: true
page-layout: full
default-image-extension: png
exercises:
org-repo: "rse-best-practices-course/2024-course"
---
## Get ready! {.smaller}
:::: {.columns}
::: {.column width="50%" style="font-size: 0.5em;"}
:::
::: {.column width="50%"}
* open these slides on your laptop: [https://neuroinformatics.dev/course-software-good-practice/](https://neuroinformatics.dev/course-software-good-practice/)
:::
::::
## What makes (research) code good?
{{< include slides/mentimeter.qmd >}}
## The next steps
:::: {.columns}
::: {.column width="50%" style="font-size: 0.5em;"}
:::
::: {.column width="50%"}
```{.python}
import pandas
import numpy
def do_something_awesome(input):
p = process(input)
a = analyze(p)
g = plot(a)
output = g, a
return output
if __name__ == "__main__":
print(do_something_awesome(42))
```
:::
::::
## The next steps
:::: {.columns}
::: {.column width="50%" style="font-size: 0.5em;"}
:::
::: {.column width="50%"}
```{.bash}
pip install my_awesome_package
```
:::
::::
## The journey of a developer and its Python package
* Clean up and organize your scripts 🧹
* Package your project 📦
* Share your project 🌍
{{< include slides/refactoring.qmd >}}
{{< include slides/packaging.qmd >}}
# Conclusion
## What we have learned today
* Clean up and organize your scripts 🧹
* Package your project 📦
* Share your project 🌍
## Other areas of good practice
* testing
* writing documentation
* asynchronous collaboration (issues and pull requests)
## Extra resources
If you want to practice refactoring, testing and documenting we have prepared [some exercises](https://github.com/{{< meta exercises.org-repo >}}/issues/)
## Retrospective
* Anonymously tell us what you thought [on this ideaboardz](https://ideaboardz.com/for/Collaborative%20coding%20retrospective/5104750)...
* ... and get in touch anytime!