Good Practices in Research Software Development

eScience Center Digital Skills Programme

‘Good Practices in Research Software Development’ workshops introduce practices, tools and skills used in research software development.

The key objective of this workshop is to grow researchers’ software skills necessary to apply good practices that enable open and reproducible research. The workshop focuses on building modular, reusable, maintainable, sustainable, reproducible, testable, and robust software. This will allow you to more easily organize, maintain and share your data. The participants should be familiar with programming and regularly write code for their research, but no extensive expertise or knowledge of specific tools are required. The main themes that are addressed are generically applicable, but please note that a lot of the exercises and demonstrations are in Python.This workshop is inspired by and based on <a href="https://coderefinery.org/lessons/" title="https://coderefinery.org/lessons/" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">CodeRefinery</a> training materials.The workshop is based on the teaching style of the Carpentries, and learners will follow along while the instructors write the code on screen. More information can be found on the <a href="https://esciencecenter-digital-skills.github.io/2024-02-26-ds-cr" title="https://esciencecenter-digital-skills.github.io/2024-02-26-ds-cr" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">workshop website</a>. Cancellation and No-Show PolicyPlease be advised that by signing up, you agree to our Cancellation and No-Show Policy, which states that cancellations made less than 2 workings days prior to the event will incur a no-show fee. Please read the full policy <a href="https://www.esciencecenter.nl/cancellation-and-no-show-policy-for-escience-center-training-events/" title="https://www.esciencecenter.nl/cancellation-and-no-show-policy-for-escience-center-training-events/" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">here</a> for more details. WhoThe workshop is aimed at PhD candidates and other researchers or research software engineers. We offer tickets for researchers who are affiliated with Dutch research institutions. We offer separate tickets for researchers working in industry. We do not accept registrations by undergraduate students. If you are affiliated to a foreign research institution or if you are not sure which ticket applies to you, please send us an email.  Ticket pricesTicket prices are as follows:<ul><li>For participants affiliated with Dutch research institutions: €175,00</li><li>For participants from industry: €525,00</li></ul> Prerequired knowledgeIt is assumed that participants already write code for their research, but no expertise is required. Some experience in navigating file trees and editing files in a terminal session, as well as basic knowledge of Python programming is recommended.If you find the topics that are covered in this workshop too basic, you could consider joining the ‘Intermediate Research Software Development’ workshop. That workshop has a similar focus, but also teaches more intermediate topics like software architecture, object-oriented &amp; functional programming, Integrated Software Development environments and is targeted to slightly more advanced research software engineers. Checkout our <a href="https://www.esciencecenter.nl/events/?f=workshops" title="https://www.esciencecenter.nl/events/?f=workshops" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">upcoming workshops</a> for more information. SyllabusIntroduction to version control with Git<ul><li>Tracking changes: git add &amp; git commit</li><li>Exploring history, checking out older versions</li><li>Ignoring things with .gitignore files</li><li>Github remotes</li></ul>Collaboration with Git and Github<ul><li>Creating pull requests</li><li>Review process</li><li>Good practices for collaboration</li><li>Contributing to repositories with forks</li></ul>Code Documentation<ul><li>In-code documentation</li><li>Readme files</li><li>Writing documentation with sphinx and ReadTheDocs or Github pages</li></ul>Modular Code Development<ul><li>How can you create blocks of code that can be reused?</li></ul>Testing<ul><li>Introduction to testing: motivation, unit testing, integration testing</li><li>Writing tests with pytest</li></ul>Continuous Integration<ul><li>Introducton to Continuous Integration</li><li>Setting up Continuous Integration with Github Workflows</li><li>Linting and automated testing</li></ul> WhereThis training will take place online. The instructors will provide you with the information you will need to connect to this meeting.

Our {communityGuidelinesLink} describe the sort of content we prohibit on Eventbrite. If you suspect an event may be in violation, you can report it to us so we can investigate.

To report other categories of prohibited or illegal content, submit {link}