Code & Collaborate: The FAIRytale of Software Development
Location: Online
Organisers
Trainers
- Alan O'Cais (University of Barcelona)
- Lisanna Paladin (EMBL - Heidelberg)
- Sabry Razick (University of Oslo)
- Rabea Müller (ZB MED - Information Centre for Life Sciences)
BioNT - BIO Network for Training - is an international consortium of academic entities and small and medium-sized enterprises (SMEs). BioNT is dedicated to providing a comprehensive training program and fostering a community for digital skills relevant to the biotechnology industry and biomedical sector. With a curriculum tailored for both beginners and advanced professionals, BioNT aims to equip individuals with the necessary expertise in handling, processing, and visualising biological data, as well as utilising computational biology tools. Leveraging the consortium's strong background in digital literacy training and extensive network of collaborations, BioNT is poised to professionalise life sciences data management, processing, and analysis skills.
This intensive three-day workshop focuses on collaborative and FAIR software development practices critical for data scientists. Participants will engage in hands-on learning across three key domains:
- Day 1 is dedicated to collaborative distributed version control, providing practical training on collaborative technologies. Participants will explore collaboration concepts, repository management, code review practices, and software licensing.
- Day 2 begins a practical exploration of the concepts introduced for the case of a Python project. It covers the tools we can use to implement FAIR principles, how to create a reproducible environment, tips to make code readable, and how to structure your application.
- Day 3 concentrates on software testing, automated testing strategies, how to document code, how to facilitate code citation, and collaborating with others.
The workshop offers a comprehensive, hands-on approach to developing professional software engineering skills tailored to data science research.
Join this workshop if you are:
- Interested in advancing your collaborative software development skills
- Working on computational projects that require version control
- Seeking to improve your code review and contribution techniques
- Wanting to learn professional software licensing practices
- Interested in implementing robust software testing methodologies
- Committed to creating reproducible research environments
- Looking to systematically manage computational projects
- Eager to learn best practices in dependency and environment management
- A student, researcher, or professional in data science
- Aiming to enhance your software engineering capabilities
Learning Outcomes:
By the end of this workshop, you will be able to:
- Implement collaborative distributed version control techniques
- Understand and practice collaborative workflows
- Conduct effective code reviews
- Contribute to repositories owned by others
- Navigate software licensing considerations
- Design and implement local software testing
- Create automated testing strategies
- Develop reproducible research environments
- Manage software project lifecycles
- Systematically organize computational projects
- Record and manage computational dependencies and environments
Programme
First day: 4th of February - Technology needed for Collaborative work |
||||
Start |
End |
Duration |
Title |
Format |
09:00 |
09:20 |
20 min |
Welcome + Ice-breaker |
|
09:20 |
09:40 |
20 min |
Hands-on |
|
09:40 |
10:15 |
35 min |
Hands-on |
|
10:15 |
10:25 |
10 min |
Break |
|
10:30 |
11:10 |
40 min |
Hands-on |
|
11:10 |
11:50 |
40 min |
How to contribute changes to repositories that belong to others |
Hands-on |
11:50 |
12:00 |
10 min |
Break |
|
12:00 |
12:20 |
20 min |
Hands-on |
|
12:20 |
12:40 |
20 min |
Hands-on |
|
12:40 |
13:000 |
20 min |
Hands-on |
|
13:00 |
14:00 |
60 min |
Lunch |
|
14:00 |
14:15 |
15 min |
||
14:15 |
14:25 |
10 min |
||
14:25 |
14:45 |
20 min |
Hands-on |
|
14:45 |
15:00 |
15 min |
Break |
|
15:00 |
15:20 |
20 min |
||
15:20 |
15:40 |
20 min |
||
15:40 |
16:00 |
20 min |
Feedback and summary |
Second day: 5th of February - Tools and practices for FAIR research software (Day 1) |
||||
Start |
End |
Duration |
Title |
Format |
09:00 |
09:10 |
10 min |
Welcome back + summary |
|
09:10 |
10:00 |
50 min |
Hands-on |
|
10:00 |
10:10 |
10 min |
Break |
|
10:10 |
11:30 |
80 min |
Hands-on |
|
11:30 |
11:45 |
15 min |
Break |
|
11:45 |
12:30 |
45 min |
Hands-on |
|
12:30 |
13:30 |
60 min |
Lunch |
|
13:30 |
14:00 |
30 min |
Hands-on |
|
14:00 |
15:30 |
100 min |
Code readability (with 10 min break) |
Hands-on |
15:30 |
15:45 |
10 min |
Feedback and summary |
Third day: 6th of February - Tools and practices for FAIR research software (Day 2) |
||||
Start |
End |
Duration |
Title |
Format |
09:00 |
09:10 |
10 min |
Welcome back + summary |
|
09:10 |
10:30 |
80 min |
Hands-on |
|
10:30 |
10:40 |
10 min |
Break |
|
10:40 |
11:50 |
80 min |
Hands-on |
|
11:50 |
12:00 |
10 min |
Break |
|
12:00 |
12:30 |
40 min |
Hands-on |
|
12:30 |
13:30 |
60 min |
Lunch |
|
13:30 |
14:30 |
60 min |
Hands-on |
|
14:30 |
14:40 |
10 min |
Break |
|
14:40 |
15:40 |
60 min |
Hands-on |
|
15:40 |
16:00 |
20 min |
Wrap-up and feedback |
Hands-on |
Recommendations:
- To follow the workshop more efficiently, we recommend having a two-screen setup
- To actively communicate during the workshop, please familiarise yourself with Markdown formatting by reviewing the HedgeDoc features document
Interaction between participants, trainers and helpers
The workshop will be delivered in a Zoom webinar format, with participants’ visibility disabled to preserve their privacy. You, as a participant, will be able to see and learn from the trainers but a direct interaction (e.g. chat or voice) will not be possible during the sessions. Instead, a collaborative document, previously setup by the trainers, will be shared with you before the session. You will be expected to engage and interact anonymously with other participants as well as with the workshop helpers and trainers directly in this document.
Trainer Hubs
All BioNT workshops are offered at no cost, but there are a limited number of seats available. To make workshops more accessible for members of the same company we highly recommend organising what we refer to as "Training Hubs." In this arrangement, one person is formally registered for the workshop, but the knowledge sharing can be expanded to numerous colleagues within their company or SME through live-streaming the session.
How to register
The workshop is free of charge. To participate, please follow these steps:
To participate, please follow these steps:
- Click on the window “Participate” at the top of this page
- You will be redirected to the members.cecam.org page. If you already have an account on our platform, please proceed to step 5
- On the top-right corner click "Register" and complete the provided form. As indicated, completing this form does not register you to the workshop. Within 72 hours you will receive an email confirming your account has been activated. Due to this processing time, we advise you to register a few days before the registration deadline
- After receiving the account activation confirmation, visit the workshop page again and follow instructions starting from step 1
- You should now have an active account. After login in with your login details, you should be redirected to the workshop registration page
- In order to start your registration please follow the instructions of the linked pre-workshop survey until you will get your unique identifier
- To finalise your registration please use the unique identifier in the CECAM platform in the corresponding section and press “Send mail”
- Your application is now submitted for evaluation. If selected, you will be contacted later to confirm your attendance and provide instructions for installing the required software and participating in the online workshop.
References
Silvia Di Giorgio (ZB MED – Information Centre for Life Sciences) - Organiser
Spain
Alan O'Cais (University of Barcelona) - Organiser
Ignacio Pagonabarraga (University of Barcelona) - Organiser