You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This resource is intended to support researchers in embedding good software engineering practices into their workflows to make their computational research easier to manage, more reproducible, more reusable and sharable, and more robust.
@@ -66,7 +76,7 @@ Everyone learns in different styles and in different ways; everyone brings diffe
66
76
67
77
This course introduces a [reproducible project workflow](workflow.qmd) that you can take and use for any future coding project. The below provides suggested durations for each session, with a timetable provided for synchronous courses.
68
78
69
-
If you are attending a synchronous course, please revise the material between sessions.
79
+
Note that this is an intensive course that covers a lot of content. If you are attending a synchronous course, please revise the material between sessions. If sessions take longer on Day 1 of the course and not all the scheduled material is covered, **please read through the presentations ahead of the next session**. They will be put into use in the first practical so there will be a chance to review.
70
80
71
81
| Session | Approximate duration | Key objectives | Start time (taking breaks into account) |
72
82
|---|---|---|---|
@@ -78,9 +88,10 @@ If you are attending a synchronous course, please revise the material between se
78
88
| Presentation: Version control | 30 mins | Introduce version control with git | 11.15 am (followed by 5 min break) |
79
89
| Practical 3 | 30 mins | Explore drafting pseudocode, notes, and comments, while using version control | 11.50 |
80
90
| Presentation: Dependency management | 30 mins | Introduce dependency management with Conda | 12.20 pm |
81
-
| Q&A *or* headstart on Practical 4 | 10 mins | Last ten minutes of day 1 | 12.50 pm |
91
+
| Q&A or headstart on Practical 4 | 10 mins | Last ten minutes of day 1 | 12.50 pm |
92
+
|**Note:** If sessions take longer on this day, please complete outstanding practicals as homework |
82
93
| Day 2 |
83
-
| Practical 4 | 40 mins | Set up Python environment and begin drafting code | 10 am |
94
+
| Practical 4 | 40 mins |Brief review of dependencies. Set up Python environment and begin drafting code | 10 am |
84
95
| Presentation: Testing | 20 mins | Introduce testing workflows | 10.20 am (followed by 5 min break) |
85
96
| Practical 5 | 30 mins | Write a basic testing suite | 10.45 am |
86
97
| Presentation: Releasing and archiving your code | 30 mins | Discuss the importance of creating releases and minting DOIs for your code; discuss exporting record of environment alongside results | 11.15 am (followed by 10 min break) |
@@ -90,26 +101,25 @@ If you are attending a synchronous course, please revise the material between se
90
101
91
102
## Author's Note
92
103
93
-
This material is an evolution of the original [SWD3: Software development practices for Research](https://arctraining.github.io/swd3-dev/welcome.html) course run by Research Computing at the University of Leeds, but has been extensively reworked and updated.
104
+
This material is an evolution of the original [SWD3: Software development practices for Research](https://arctraining.github.io/swd3-dev/welcome.html) course, written by [Dr Patricia Ternes](https://arc.leeds.ac.uk/profiles/patricia-ternes/) and run by Research Computing at the University of Leeds, but has been extensively reworked and updated.
94
105
95
106
This material is licensed under the [Creative Commons Attribution-NonCommercial 4.0 International Public License](https://creativecommons.org/licenses/by-nc/4.0/), and is copyrighted by the University of Leeds.
96
107
97
-
### Citation
108
+
### Contribution guidelines
98
109
99
-
If you use or reference this material, please cite it.
110
+
Please feel free to open issues or suggest edits to this material via our GitHub repository (see links in the sidebar). Note that when the changes you have made have been merged with the main branch, you may not see an update to the live website until a new release is made.
111
+
112
+
Please read the [contributing guidelines](#) on the repository.
113
+
114
+
#### Contributors
100
115
101
-
**BibTeX citation:**
116
+
Below is a list of contributors (in chronological order of addition) with associated Contributor Role Taxonomy (CRediT) roles. Please see the [CRediT website](https://credit.niso.org/) for definitions of roles.
102
117
103
-
```text
104
-
@online{murphy_quinlan2025,
105
-
author = {Murphy Quinlan, Maeve},
106
-
title = {Reproducibility, {Replicability,} \& {Reusability}},
107
-
date = {2025-06-16},
108
-
url = {https://url-here},
109
-
langid = {en}
110
-
}
111
-
```
118
+
- Maeve Murphy Quinlan: conceptualization, writing (original draft), writing (review and editing), data curation, methodology.
119
+
- Creation of website, Python workflows, GitHub actions.
120
+
- Redesign of course.
112
121
113
-
**Plain text citation:**
122
+
### Citation
123
+
124
+
If you use or reference this material, please cite it.
114
125
115
-
Murphy Quinlan, Maeve. 2025. “Research Software Development in Python [Course materials]” June 16, 2025. https://url-here.
0 commit comments