Skip to content

Commit 3087142

Browse files
Adds links to material for documentation session, removes JOSS sign-up link
1 parent c355fe2 commit 3087142

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

course.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ programme that will teach you a whole range of skills.
1919
- **[Software lifecycle planning](#software-lifecycle-planning)**, Wednesday 19th November 2025, 2pm to 3pm, online - [slides][lifecycle_slides], [video][lifecycle_video] Passcode: aPD37!B. (includes full stop)
2020
- **[Software design](#software-design)**, <span style="color: #ff0000">Date TBC</span>
2121
- **[Testing and Continuous Integration](#testing-and-continuous-integration)**, Wednesday 18th February 2026 - [content][testing_lesson], [files][testing_files]
22-
- **[Documentation](#documentation)**, <span style="color: #ff0000">Wednesday 22nd April 2026, 1pm to 4pm</span>, in-person - [sign up form][session8form] (UoY accounts only)
22+
- **[Documentation](#documentation)**, <span style="color: #ff0000">Wednesday 22nd April 2026, 1pm to 4pm</span>, in-person - [sign up form][session8form] (UoY accounts only) - [lesson][docs_lesson]
2323
- **[Reproducible computational environments](#reproducible-computational-environments)**, Wednesday 18th March 2026, 1pm to 3pm, hybrid - [slides][rep_env_slides], [video][rep_env_video] Passcode: =5CSQ.@N
2424
- **[Packaging](#packaging)**, <span style="color: #ff0000">Wednesday 6th May 2026, 1pm to 3pm</span>, in-person - [sign up form][session9form] (UoY accounts only)
25-
- **[Publishing a software paper in JOSS](#publishing-a-software-paper-in-joss)**, <span style="color: #ff0000">Wednesday 15th April 2026, 1pm to 2pm</span>, hybrid - [Eventbrite sign up form][session7form] (open to students and staff at all N8 universities)
25+
- **[Publishing a software paper in JOSS](#publishing-a-software-paper-in-joss)**, Wednesday 15th April 2026, 1pm to 2pm, hybrid - materials coming soon
2626

2727
### Target Audience and Prerequisites
2828
We welcome everyone working with research software, from undergraduates to professors, from beginners to experts, and from people who create analysis scripts on their laptops to those who run first principles modelling on supercomputers. Each session will have some individual prerequisites. Some experience with
@@ -99,6 +99,8 @@ teaches researchers how to document their software effectively, making it
9999
accessible and understandable to others. It covers topics such as writing
100100
readable code and usage instructions.
101101

102+
**Course materials:** [lesson][docs_lesson]
103+
102104
### Reproducible computational environments
103105
**Wednesday 18th March 2026, 1pm to 3pm, hybrid - follow-along.**
104106

@@ -122,7 +124,7 @@ exist to package Python and R projects and take you through each step of the
122124
packaging process.
123125

124126
### Publishing a software paper in JOSS
125-
**<span style="color: #ff0000">Wednesday 15th April 2026, 1pm to 2pm</span>, hybrid. [Eventbrite sign up form][session7form] (open to students and staff at all N8 universities)**
127+
**Wednesday 15th April 2026, 1pm to 2pm, hybrid.**
126128

127129
Did you know that you can actually publish a paper about your software? This is
128130
an ideal way to get recognition (and citation) for the software you have spent
@@ -132,6 +134,8 @@ software submission to the journal, and thanks to the collaboration of the
132134
Editor in Chief of JOSS (Arfon Smith), we will look at how the review process is
133135
done.
134136

137+
**Materials coming soon**
138+
135139
## Learning outcomes
136140
After completing this modular programme, participants should be able to:
137141

@@ -194,4 +198,6 @@ We'd love to hear your (anonymous) feedback: please fill in our [feedback form][
194198
[testing_files]: https://github.com/ResearchCodingClub/python-testing-for-research/tree/main/learners/files
195199

196200
[rep_env_slides]: https://docs.google.com/presentation/d/144TqQoYIj1OgbIpQ4JDZmLnx4FtMsg3WL7cvf6N914A/edit?usp=sharing
197-
[rep_env_video]: https://york-ac-uk.zoom.us/rec/share/tbZdpdrLcr1JXg-bYcLTB7EHXe8gurgkw1VDL0mAOnCSez61DLKJhMlWYro73H5V.0QibsuCK4VIvDNVZ
201+
[rep_env_video]: https://york-ac-uk.zoom.us/rec/share/tbZdpdrLcr1JXg-bYcLTB7EHXe8gurgkw1VDL0mAOnCSez61DLKJhMlWYro73H5V.0QibsuCK4VIvDNVZ
202+
203+
[docs_lesson]: https://researchcodingclub.github.io/documentation/

0 commit comments

Comments
 (0)