Intermediate Research Software Development with Python

Online

September 24th, October 1st, October 8th, October 15th, October 22nd - 2024

Tuesday 09:00 - 13:00 CEST

Instructors: Sven van der Burg, Dani Bodor, Claire Donnelly, Sander van Rijn, Jaro Camphuijsen, Ewan Cahen

Some adblockers block the registration window. If you do not see the registration box below, please check your adblocker settings.

General Information

The eScience Center offers a range of workshops and training courses, aimed at PhD candidates and other researchers or research software engineers. We organize workshops covering digital skills needed to put reproducible research into practice. These include online collaboration, reproducible code and good programming practices. We also offer more advanced workshops such as GPU Programming, Parallel Programming, Image Processing and Deep Learning.

This course aims to teach a core set of established, intermediate-level software development skills and best practices for working as part of a team in a research environment using Python as an example programming language. The core set of skills we teach is a selective set of tried-and-tested collaborative development skills that provides a firm foundation for continuing on your learning journey..

A typical learner for this course may be someone who is working in a research environment, needing to write some code, has gained basic software development skills either by self-learning or attending, e.g., a novice Software Carpentry Python course. They have been applying those skills in their domain of work by writing code for some time, e.g. half a year or more. However, their software development-related projects are now becoming larger and are involving more researchers and other stakeholders (e.g. users), for example:

Software is becoming more complex and more collaborative development effort is needed to keep the software running
Software is going further that just the small group developing and/or using the code - there are more users and an increasing need to add new features
‘Technical debt’ is increasing with demands to add new functionality while ensuring previous development efforts remain functional and maintainable

They now need intermediate software engineering skills to help them design more robust software code that goes beyond a few thrown-together proof-of-concept scripts, taking into consideration the lifecycle of software, writing software for stakeholders, working in a team and applying a process to understanding, designing, building, releasing, and maintaining software.

Who:

This course is for you if:

You have been writing software for a while, which may be used by people other than yourself, but it is currently undocumented or unstructured
You want to learn:
- more intermediate software engineering techniques and tools
- how to collaborate with others to develop software
- how to prepare software for others to use
You are currently comfortable with:
- basic Python programming (though this may not be the main language you use) and applying it to your work on a regular basis
- basic version control using Git
- command line interface (shell)

This course is not for you if:

You have not yet started writing software (in which case have a look at the Software Carpentry course or some other Python course for novices first)
You have learned the basics of writing software but have not applied that knowledge yet (or are unsure how to apply it) to your work. In this case, we suggest you revisit the course after you have been programming for at least 6 months
You are already reasonably familiar with the learning objectives of the course and those of individual episodes
The software you write is fully documented and well architected

Prerequisites:

To attend this course you should meet the following criteria. You can also test your prerequisite knowledge by taking this short quiz.

Git
- You are familiar with the concept of version control
- You have experience configuring Git for the first time and creating a local repository
- You have experience using Git to create and clone a repository and add/commit changes to it and to push to/pull from a remote repository
- Ideally, you have experience comparing various versions of tracked files or ignoring specific files
Python
- You have a basic knowledge of programming in Python (using variables, lists, conditional statements, functions and importing external libraries)
- You have previously written Python scripts or iPython/Jupyter notebooks to accomplish tasks in your domain of work
Shell
- You have experience using a command line interface, such as Bash, to navigate a UNIX-style file system and run commands with arguments
- Ideally, you have experience redirecting inputs and outputs from a command

Instead of this workshop you could also consider: If you find the topics that are covered in this workshop slightly too advanced, you could consider joining the ‘Good Practices in Research Software Development’ workshop. That workshop has a similar focus, but is targeted to a slightly less advanced audience. For example, there is an optional introduction to git. Checkout our upcoming workshops for more information.

Where: This training will take place online. The instructors will provide you with the information you will need to connect to this meeting.

When: September 24th, October 1st, October 8th, October 15th, October 22nd - 2024, Tuesday 09:00 - 13:00 CEST.

Requirements: Participants must have access to a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. They should have a few specific software packages installed (listed below).

Accessibility: We are dedicated to providing a positive and accessible learning environment for all. Please notify the instructors in advance of the workshop if you require any accommodations or if there is anything we can do to make this workshop more accessible to you.

Workshop files: You will find all slides, notebooks, archived collaborative documents, and other relevant files in the files folder of the workshop website repository after the workshop.

Contact: Please email or training@esciencecenter.nl for more information.

Ticket discounts

Early Bird Discount

Register within the first week of open registration and receive a 25% discount on your participation fee. Don’t miss out on this opportunity to secure your spot at a reduced price!

Group Discount

Bring your team along and benefit from our group discount. Groups of five or more participants are eligible for a 25% discount. For more details and to register your group, please email us at training@esciencecenter.nl.

Code of Conduct

Participants are expected to follow these guidelines:

Use welcoming and inclusive language
Be respectful of different viewpoints and experiences
Gracefully accept constructive criticism
Focus on what is best for the community
Show courtesy and respect towards other community members

Syllabus

Setting up Environment For Collaborative Code Development

Introduction to Our Software Project
Virtual Environments For Software Development
Integrated Software Development Environments
Collaborative Software Development Using Git and GitHub
Python Code Style Conventions
Verifying Code Style Using Linters

Ensuring Correctness of Software at Scale

Automatically Testing Software
Scaling Up Unit Testing
Continuous Integration for Automated Testing
Diagnosing Issues and Improving Robustness

Software Development as a Process

Software Requirements
Software Architecture and Design
Programming Paradigms
Functional Programming Intuition
Object Oriented Programming Intuition

Collaborative Software Development for Reuse

Developing Software in a Team: Code Review
Preparing Software for Reuse and Release
Packaging Code for Release and Distribution

Managing and Improving Software over Its Lifetime

Managing a Collaborative Software Project
Software Improvement Through Feedback

Schedule

Day 1

09:00	Welcome and icebreaker
09:15	Workshop introduction
09:30	Section 1: Setting up Environment For Collaborative Code Development
10:15	Coffee break
10:30	Section 1: Setting up Environment For Collaborative Code Development
11:30	Coffee break
11:45	Section 1: Setting up Environment For Collaborative Code Development
12:45	Wrap-up
13:00	END

Day 2

09:00	Welcome and icebreaker
09:15	Section 2: Ensuring Correctness of Software at Scale
10:15	Coffee break
10:30	Section 2: Ensuring Correctness of Software at Scale
11:30	Coffee break
11:45	Section 2: Ensuring Correctness of Software at Scale
12:45	Wrap-up
13:00	END

Day 3

09:00	Welcome and icebreaker
09:15	Section 3: Software Development as a Process
10:15	Coffee break
10:30	Section 3: Software Development as a Process
11:30	Coffee break
11:45	Section 3: Software Development as a Process
12:45	Wrap-up
13:00	END

Day 4

09:00	Welcome and icebreaker
09:15	Section 4: Collaborative Software Development for Reuse
10:15	Coffee break
10:30	Section 4: Collaborative Software Development for Reuse
11:30	Coffee break
11:45	Section 4: Collaborative Software Development for Reuse
12:45	Wrap-up
13:00	END

Day 5

09:00	Welcome and icebreaker
09:15	Section 5: Managing and Improving Software over Its Lifetime
10:15	Coffee break
10:30	Section 5: Managing and Improving Software over Its Lifetime
11:30	Coffee break
11:45	Section 5: Managing and Improving Software over Its Lifetime
12:30	Concluding remarks
13:00	END

Setup

To participate in this workshop, you will need access to software as described below. In addition, you will need an up-to-date web browser.

We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.

Software setup

It is important that you setup everything on your laptop before the start of the course. This includes setting up a Command Line Tool, Git, a Python environment, and Integrated Development Environment.. Please follow these setup instructions. Send us an email if you encounter any problems.

Install the videoconferencing client

If you haven't used Zoom before, go to the official website to download and install the Zoom client for your computer.

Set up your workspace

Like other Carpentries workshops, you will be learning by "coding along" with the Instructors. To do this, you will need to have both the window for the tool you will be learning about (a terminal, RStudio, your web browser, etc..) and the window for the Zoom video conference client open. In order to see both at once, we recommend using one of the following set up options:

Two monitors: If you have two monitors, plan to have the tool you are learing up on one monitor and the video conferencing software on the other.
Two devices: If you don't have two monitors, do you have another device (tablet, smartphone) with a medium to large sized screen? If so, try using the smaller device as your video conference connection and your larger device (laptop or desktop) to follow along with the tool you will be learning about.
Divide your screen: If you only have one device and one screen, practice having two windows (the video conference program and one of the tools you will be using at the workshop) open together. How can you best fit both on your screen? Will it work better for you to toggle between them using a keyboard shortcut? Try it out in advance to decide what will work best for you.

This blog post includes detailed information on how to set up your screen to follow along during the workshop.