Best Practices for Research Software

May 15, 2019

9:00 am - 5:00 pm

Instructors: Mateusz Kuzak, Toby Hodges

Helpers: Mateusz Kuzak, Toby Hodges

General Information

In recent years, scientific research has become more data driven and data intensive and it is no longer possible to carry out the analysis without the use of computers and research software. Unfortunately, software is not always developed following best practices that ensure its quality and sustainability. Four simple recommendations to encourage best practices in open research software is a publication that addresses this issue by providing a simple, yet robust framework of recommendations that encourage the adoption of existing best practices in research software development. These recommendations are designed around Open Science values, and provide practical suggestions that contribute to making research software and its source code more discoverable, reusable and transparent.

These recommendations recognise that not everyone can or want to make their software open from day one, but we encourage you to learn from the recommendations and adapt them to your needs. For example, you can have a private repository, you can and should still have a license, make contributions clear, and have a registry of your software.

Who: The course is aimed at graduate students and researchers, who have or will have in the near future code to share or want to collaborate with open source software. For this workshop we recomend you to be familiar with (at least) one programming language, Markdown and GitHub. This workshop will not teach you how to program, nor will you need to program during the workshop.

Where: Overwale 3, 9000 Gent. Clemenspoort: Zaal Neumann. Get directions with OpenStreetMap or Google Maps.

When: May 15, 2019. Add to your Google Calendar.

Requirements: Participants must bring a laptop 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). They are also required to abide by Software Carpentry's Code of Conduct.

Digital materials can be found linked to the schedule. If we can help making learning easier for you please get in touch (using contact details below) and we will attempt to provide them.

Contact: Please email bits@vib.be for more information.


Thanks to

This workshop is funded by ELIXIR and ELIXIR Belgium, and forms part of the ELIXIR Tools platform “Software development best practices” working group.

Schedule

Day 1 - May 15th

Before Create a GitHub account and read this paper in preparation for the workshop
Morning Make source code publicly accessible from day one
Morning Adopt a licence and comply with the licence of third-party dependencies
Break Lunch break
Afternoon Define clear and transparent contribution, governance and communication processes
Afternoon Make software easy to discover by providing software metadata via a popular community registry

Syllabus

Recommendations to make your research software open


Setup

To participate this workshop, you will need working copies of the software described below. Please make sure to install everything and try opening it to make sure it works before the start of your workshop. If you run into any problems, please feel free to email the instructor or arrive early to your workshop on the day. Participants should bring and use their own laptops to insure the proper setup of tools for an efficient workflow once you leave the workshop.

Platform-specific Notes

This workshop will be using the software outlined in the install instructions below. Please see the section for your operating system for those directions.

Windows

Please go through all the installation steps below and make sure that you not only installed them, but start them up to make sure they're working. If you have any problems, don't hesitate to email the instructors to ask for help, or arrive early on the first day of the workshop to get help.

Mac

Please go through all the installation steps below and make sure that you not only installed them, but start them up to make sure they're working. If you have any problems, don't hesitate to email the instructors to ask for help, or arrive early on the first day of the workshop to get help.

Linux

Please go through all the installation steps below and make sure that you not only installed them, but start them up to make sure they're working. If you have any problems, don't hesitate to email the instructors to ask for help, or arrive early on the first day of the workshop to get help.