Skip to content

Commit b2c7f50

Browse files
Adds JOSS materials and other course info updates
1 parent 3087142 commit b2c7f50

2 files changed

Lines changed: 15 additions & 12 deletions

File tree

course.md

Lines changed: 15 additions & 12 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) - [lesson][docs_lesson]
22+
- **[Documentation](#documentation)**, Wednesday 22nd April 2026, 1pm to 4pm, in-person - [lesson materials][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
24-
- **[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)**, Wednesday 15th April 2026, 1pm to 2pm, hybrid - materials coming soon
24+
- **[Packaging](#packaging)**, <span style="color: #ff0000">Wednesday 6th May 2026, 1pm to 4pm</span>, in-person - [sign up form][session9form] (UoY accounts only)
25+
- **[Publishing a software paper in JOSS](#publishing-a-software-paper-in-joss)**, Wednesday 15th April 2026, 1pm to 2pm, hybrid - [slides][joss_slides], [video][joss_video] Passcode: T0iAmU=z
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
@@ -91,7 +91,7 @@ bugs early and saving you time.
9191
**Course materials:** [lesson][testing_lesson], [files][testing_files]
9292

9393
### Documentation
94-
**<span style="color: #ff0000">Wednesday 22nd April 2026, 1pm to 4pm</span>, in person. [sign up form][session8form] (UoY accounts only)**
94+
**Wednesday 22nd April 2026, 1pm to 4pm, in person.**
9595

9696
Well-documented software promotes reproducibility, maintainability, and
9797
increased research impact through wider adoption and citation. This course
@@ -115,13 +115,13 @@ language agnostic solutions.
115115
**Course materials:** [slides][rep_env_slides], [video][rep_env_video] Passcode: =5CSQ.@N
116116

117117
### Packaging
118-
**<span style="color: #ff0000">Wednesday 6th May 2026, 1pm to 3pm</span>, in person. [sign up form][session9form] (UoY accounts only)**
118+
**<span style="color: #ff0000">Wednesday 6th May 2026, 1pm to 4pm</span>, in person. [sign up form][session9form] (UoY accounts only)**
119119

120-
Packaging your software is one of the important steps in a software project to
121-
make it both findable and accessible. This course will provide you with an
122-
understanding of why and when packaging is useful, what different standards
123-
exist to package Python and R projects and take you through each step of the
124-
packaging process.
120+
Packaging your software is one of the important steps in a software project to make it both findable and accessible. This session will provide you with an understanding of why and when packaging is useful, what different standards exist to package Python and R projects and take you through each step of the packaging process through follow-along demonstrations for both Python and R (delivered by Emma Rand).
121+
122+
**Prerequisites:** There are a number of prerequisites if you'd like to follow-along. R users should ensure they have a GitHub account, git, R, and RStudio installed, and Windows users in particular will need to install the package development toolchain as detailed in [Emma's talk repository](https://github.com/3mmaRand/make-an-r-pkg/blob/main/prerequisite-guides/install-pkg-dev-tools.md).
123+
124+
Python users will want to register for an account on [TestPyPi](https://test.pypi.org/) and install [uv](https://docs.astral.sh/uv/getting-started/installation/).
125125

126126
### Publishing a software paper in JOSS
127127
**Wednesday 15th April 2026, 1pm to 2pm, hybrid.**
@@ -134,7 +134,7 @@ software submission to the journal, and thanks to the collaboration of the
134134
Editor in Chief of JOSS (Arfon Smith), we will look at how the review process is
135135
done.
136136

137-
**Materials coming soon**
137+
**Course materials:** [slides][joss_slides], [video][joss_video] Passcode: T0iAmU=z
138138

139139
## Learning outcomes
140140
After completing this modular programme, participants should be able to:
@@ -200,4 +200,7 @@ We'd love to hear your (anonymous) feedback: please fill in our [feedback form][
200200
[rep_env_slides]: https://docs.google.com/presentation/d/144TqQoYIj1OgbIpQ4JDZmLnx4FtMsg3WL7cvf6N914A/edit?usp=sharing
201201
[rep_env_video]: https://york-ac-uk.zoom.us/rec/share/tbZdpdrLcr1JXg-bYcLTB7EHXe8gurgkw1VDL0mAOnCSez61DLKJhMlWYro73H5V.0QibsuCK4VIvDNVZ
202202

203-
[docs_lesson]: https://researchcodingclub.github.io/documentation/
203+
[docs_lesson]: https://researchcodingclub.github.io/documentation/
204+
205+
[joss_slides]: https://researchcodingclub.github.io/slides/2026-04-15-publishing-in-joss.pdf
206+
[joss_video]: https://york-ac-uk.zoom.us/rec/share/KQsK3YR4RGTitZrsuGJMXhCIqzd1GeGcjsmMtXOFtEO7nkEcRXBFVEcX7WkDjeia.Bzf74IFgSmsw_W2I
22.4 MB
Binary file not shown.

0 commit comments

Comments
 (0)