Albert Einstein Science Park, Potsdam, Germany

Nov 26-27, 2019

09:00 am - 18:00 pm

Instructors: Katrin Leinweber, Tobias Weiß, Marc Hanisch, Maximilian Dolling, Peter Evans, Bezaye Tesfaye, Stefan Lüdtke, Jannes Breier, Berry Boessenkool, Michael Dietze

Helpers: Knut Günther, Matthias Rüster, Nils Brinckmann, Norman Ziegner, Vivien Stender, Gesa Petersen, Tabea Rettelbach, Heidrun Matthes, Phillip Tiburtius, and instructors

General Information

Together with the advancement of new tools and techniques, and the availability of large datasets in different research domains, a solid understanding of common scripting languages and version control systems is becoming more and more important for many researchers. Having the knowledge and skills on how to use tools and techniques to analyze data efficiently, to preserve research output and to collaborate with peers benefit every research domain. So its important to close the gap between researchers and the know-how for new tools and techniques. Software Carpentry aims to provided this support. It is an interactive workshop including sessions from concepts to practice on topics that can be used in many research domain. The sessions are organized in a friendly environment, where people can learn from each other and share experience. Participants also get support throughout the whole sessions.

Who: The workshop targets audience from graduate students to advanced researchers, and doesn't require previous knowledge of topics that will be covered.

Where: Albert Einstein Science Park, House H, Room V2+3, Telegrafenberg, 14473 Potsdam. Get directions with OpenStreetMap or Google Maps.

When: Nov 26-27, 2019. Add to your Google Calendar.

Requirements: Each participant must bring a laptop (not a tablet, Chromebook, etc.) pre-installed with preferred operating system of his/her own and software packages listed HERE. And should have administrative right for it.

Code of Conduct: Everyone who participates in Carpentries activities is required to conform to the Code of Conduct. This document also outlines how to report an incident if needed.

Accessibility: We are committed to making this workshop accessible to everybody. The workshop organizers have checked that:

Contact: Please email swc-workshop-org@gfz-potsdam.de for more information.


Surveys

Please be sure to complete these surveys before and after the workshop.

Pre-workshop Survey

Post-workshop Survey


Schedule

Day 1

09:00 Arrival & coffee
09:30 Welcome & introduction
09:45 Lightning talks by participants
10:30 Software set-up
11:00 Coffee
11:30 The Unix Shell
13:00 Lunch
14:00 Version Control with Git (and Gitlab) 1
15:30 Coffee
16:00 Version Control with Git (and Gitlab) 2
17:30 Wrap-up

Day 2

09:00 Arrival & coffee
09:30 R 1
11:00 Coffee
11:30 R 2
13:00 Lunch
14:00 R 3
15:30 Coffee
16:00 R 4
17:30 Wrap-up

We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.


Syllabus

The Unix Shell

  • Files and Directories
  • History and Tab Completion
  • Pipes and Redirection
  • Looping Over Files
  • Creating and Running Shell Scripts
  • Finding Things
  • Reference...

Version Control with Git

  • Creating a Repository
  • Recording Changes to Files: add, commit, ...
  • Viewing Changes: status, diff, ...
  • Ignoring Files
  • Working on the Web: clone, pull, push, ...
  • Resolving Conflicts
  • Open Licenses
  • Where to Host Work, and Why
  • Reference...

Programming in R

  • Working with Vectors and Data Frames
  • Reading and Plotting Data
  • Creating and Using Functions
  • Loops and Conditionals
  • Using R from the Command Line
  • Reference...

WiFi

There will be an eduroam wlan during the workshop. We will provide WiFi guest tickets as a backup as well.

Setup

To participate in a Software Carpentry workshop, you will need access to the software 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.

The Bash Shell

Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.

Video Tutorial
  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps below:
    1. Click on "Next" four times (two times if you've previously installed Git). You don't need to change anything in the Information, location, components, and start menu screens.
    2. Select "Use the nano editor by default" and click on "Next".
    3. Keep "Git from the command line and also from 3rd-party software" selected and click on "Next". If you forgot to do this programs that you need for the workshop will not work properly. If this happens rerun the installer and select the appropriate option.
    4. Click on "Next".
    5. Select "Use the native Windows Secure Channel library", and click "Next".
    6. Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
    7. Select "Use Windows' default console window" and click on "Next".
    8. Leave all three items selected, and click on "Next".
    9. Do not select the experimental option. Click "Install".
    10. Click on "Finish".
  3. If your "HOME" environment variable is not set (or you don't know what this is):
    1. Open command prompt (Open Start Menu then type cmd and press Enter)
    2. Type the following line into the command prompt window exactly as shown:

      setx HOME "%USERPROFILE%"

    3. Press Enter, you should see SUCCESS: Specified value was saved.
    4. Quit command prompt by typing exit then pressing Enter

This will provide you with both Git and Bash in the Git Bash program.

The default shell in all versions of macOS is Bash, so no need to install anything. You access Bash from the Terminal (found in /Applications/Utilities). See the Git installation video tutorial for an example on how to open the Terminal. You may want to keep Terminal in your dock for this workshop.

The default shell is usually Bash, but if your machine is set up differently you can run it by opening a terminal and typing bash. There is no need to install anything.

Git

Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on github.com. You will need a supported web browser.

You will need an account at github.com for parts of the Git lesson. Basic GitHub accounts are free. We encourage you to create a GitHub account if you don't have one already. Please consider what personal information you'd like to reveal. For example, you may want to review these instructions for keeping your email address private provided at GitHub.

Git should be installed on your computer as part of your Bash install (described above).

Video Tutorial

For OS X 10.9 and higher, install Git for Mac by downloading and running the most recent "mavericks" installer from this list. Because this installer is not signed by the developer, you may have to right click (control click) on the .pkg file, click Open, and click Open on the pop up window. After installing Git, there will not be anything in your /Applications folder, as Git is a command line program. For older versions of OS X (10.5-10.8) use the most recent available installer labelled "snow-leopard" available here.

If Git is not already available on your machine you can try to install it via your distro's package manager. For Debian/Ubuntu run sudo apt-get install git and for Fedora run sudo dnf install git.

Text Editor

When you're writing code, it's nice to have a text editor that is optimized for writing code, with features like automatic color-coding of key words. The default text editor on macOS and Linux is usually set to Vim, which is not famous for being intuitive. If you accidentally find yourself stuck in it, hit the Esc key, followed by :+Q+! (colon, lower-case 'q', exclamation mark), then hitting Return to return to the shell.

nano is a basic editor and the default that instructors use in the workshop. It is installed along with Git.

Others editors that you can use are Notepad++ or Sublime Text. Be aware that you must add its installation directory to your system path. Please ask your instructor to help you do this.

nano is a basic editor and the default that instructors use in the workshop. See the Git installation video tutorial for an example on how to open nano. It should be pre-installed.

Others editors that you can use are BBEdit or Sublime Text.

nano is a basic editor and the default that instructors use in the workshop. It should be pre-installed.

Others editors that you can use are Gedit, Kate or Sublime Text.

R

R is a programming language that is especially powerful for data exploration, visualization, and statistical analysis. To interact with R, we use RStudio.

Video Tutorial

Install R by downloading and running this .exe file from CRAN. Also, please install the RStudio IDE. Note that if you have separate user and admin accounts, you should run the installers as administrator (right-click on .exe file and select "Run as administrator" instead of double-clicking). Otherwise problems may occur later, for example when installing R packages.

You can download the binary files for your distribution from CRAN. Or you can use your package manager (e.g. for Debian/Ubuntu run sudo apt-get install r-base and for Fedora run sudo dnf install R). Also, please install the RStudio IDE.