Bring Your Own Script and Make It Ready for Publication

12 Nov 2020, 09:00 → 13 Nov 2020, 13:30 Europe/Berlin

Online

Tobias Schlauch (DLR)

Goal

In this workshop you learn about the basic steps to prepare your code for sharing with others and make it ready for citation in a research paper.

Content

We will provide you with actionable advice about how to polish your software project before publishing it or submitting it alongside a publication.
This includes:

1. Put your code under version control
2. Clean up your code
3. Provide proper documentation
4. Add a suitable Open Source license
5. Mark the stable version of your code
6. Make your code citable

We provide an overview about these topics in two theory sessions in the morning and in the afternoon. In between, you can work on your software project and improve it. The instructors are available and support you by
answering your questions and providing feedback.

Prerequisites

• Ideally, you already have a software project which you want to improve. Alternatively, we prepared tasks on which you can work during the practice sessions.
• Basic Git skills are required. A good and quick tutorial can be found in the Software Carpentry's "Git Novice" episodes 1 to 9.
• You require your laptop with your project setup, plus the Git command line or a graphical client, and a modern web browser.

Thursday 12 November

09:00 → 09:30 Welcome & Introduction

09:30 → 10:00 Theory Part I: Put your code under version control

10:00 → 10:30 Theory Part I: Make sure that your code is in a sharable state

10:30 → 11:00 Theory Part I: Add essential documentation

11:00 → 12:45 Practice Session I: Work on self-selected tasks

12:45 → 13:00 Wrap up & Feedback

Friday 13 November

09:00 → 09:30 Welcome & Introduction

09:30 → 10:00 Theory Part II: Add a license

10:00 → 10:30 Theory Part II: Mark the stable version of your code

10:30 → 11:00 Theory Part II: Make your code citable

11:00 → 12:45 Practice Session II: Work on self-selected tasks

12:45 → 13:00 Wrap up & Feedback