Skip to content

Commit f21dc9e

Browse files
committed
Update privacy policy, cookies etc.
1 parent af8e294 commit f21dc9e

5 files changed

Lines changed: 466 additions & 42 deletions

File tree

_quarto.yml

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,63 @@ project:
33
output-dir: docs
44

55
website:
6+
announcement:
7+
icon: info-circle
8+
dismissable: true
9+
content: "**Alert** - this is a pre-release draft; please excuse errors or typos."
10+
type: primary
11+
position: below-navbar
612
title: "Research Software Development in Python"
13+
repo-url: https://murphyqm.github.io/research-software-development/
14+
repo-actions: [edit, source, issue]
15+
page-footer: "© 2025 University of Leeds <br> [Update cookie preferences]{#open_preferences_center .btn .btn-outline-primary}"
716
cookie-consent: true
817
sidebar:
918
style: "docked"
1019
collapse-level: 1
1120
contents:
12-
- section: "0. Introduction"
21+
- href: index.qmd
22+
text: Home page and course content
23+
- section: "1. Introduction"
1324
contents:
14-
- href: index.qmd
15-
text: Course content
1625
- introduction/introduction.qmd
1726
- introduction/practical_1.qmd
18-
- section: "1. First Steps"
27+
- section: "2. Organising your project"
1928
contents:
2029
- project_org/project_organisation.qmd
2130
- project_org/practical2.qmd
31+
- section: "3. Version Control"
32+
contents:
2233
- version_control/version_control.qmd
2334
- version_control/practical3.qmd
35+
- section: "4. Dependencies"
36+
contents:
2437
- dependencies/dependencies.qmd
2538
- dependencies/practical4.qmd
26-
- section: "2. Make your code robust"
39+
- section: "5. Testing"
2740
contents:
2841
- testing/testing.qmd
2942
- testing/practical5.qmd
43+
- section: "6. Releases"
44+
contents:
3045
- releases/releases.qmd
3146
- releases/practical6.qmd
47+
- href: index.qmd#citation_1
48+
text: "<b>Cite this material</b>"
49+
- href: https://www.leeds.ac.uk/about/doc/accessibility-statement
50+
text: "<b>Accessibility Statement</b>"
51+
- href: privacy_and_cookies.qmd
52+
text: "<b>Privacy and Cookies Policy</b>"
53+
54+
3255
navbar:
3356
left:
3457
- href: workflow.qmd
3558
text: "Project Workflow ↗"
3659
target: "_blank"
37-
- href: https://arctraining.github.io/glossary-swd3/
38-
text: "Glossary ↗"
39-
target: "_blank"
60+
# - href: https://arctraining.github.io/glossary-swd3/
61+
# text: "Glossary ↗"
62+
# target: "_blank"
4063

4164
format:
4265
html:

index.qmd

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
---
2-
title: "Course Content: Research Software Development"
2+
title: "Research Software Development in Python"
3+
description: |
4+
Workshop notes introducing reproducible, replicable and reusable software workflows for research coding.
5+
6+
date: 2025-06-24
7+
author:
8+
- name: Maeve Murphy Quinlan
9+
affiliation: University of Leeds
10+
affiliation-url: https://arc.leeds.ac.uk/profiles/maeve-murphy-quinlan/
11+
citation:
12+
url: https://murphyqm.github.io/research-software-development/
313
---
414

515
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
6676

6777
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.
6878

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

7181
| Session | Approximate duration | Key objectives | Start time (taking breaks into account) |
7282
|---|---|---|---|
@@ -78,9 +88,10 @@ If you are attending a synchronous course, please revise the material between se
7888
| Presentation: Version control | 30 mins | Introduce version control with git | 11.15 am (followed by 5 min break) |
7989
| Practical 3 | 30 mins | Explore drafting pseudocode, notes, and comments, while using version control | 11.50 |
8090
| 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 |
8293
| 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 |
8495
| Presentation: Testing | 20 mins | Introduce testing workflows | 10.20 am (followed by 5 min break) |
8596
| Practical 5 | 30 mins | Write a basic testing suite | 10.45 am |
8697
| 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
90101

91102
## Author's Note
92103

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

95106
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.
96107

97-
### Citation
108+
### Contribution guidelines
98109

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
100115

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

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

113-
**Plain text citation:**
122+
### Citation
123+
124+
If you use or reference this material, please cite it.
114125

115-
Murphy Quinlan, Maeve. 2025. “Research Software Development in Python [Course materials]” June 16, 2025. https://url-here.

0 commit comments

Comments
 (0)