Albert Einstein Science Park, Potsdam

May 15-16 2017

09:00 am - 18:00 pm

Instructors: Martin Hammitzsch (GFZ), Peter Evans (GFZ), Frank Hellmann (PIK), Tim Kittel (PIK), Robert Gieseke (PIK), Benoit Bovy (GFZ), Stefan Lüdtke (GFZ), Marvin Reich (GFZ), Knut Günther (GFZ)

Helpers: Joachim Krois, and instructors

General Information

This workshop is an Python-Novice Workshop with a focus on its scientific use. Everyone who already has some experience (even if minimal) in programming is invited to join for learning the basics of Python, and the tools and structures that help you write high-quality and well documented scientific code, and get reproducible results. If you wonder whether this workshop is appropriate for you, don't hesitate to get in touch.

Software Carpentry aims to help researchers get their work done in less time and with less pain by teaching them basic research computing skills. This hands-on workshop will cover basic concepts and tools, including program design, version control, data management, and task automation. Participants will be encouraged to help one another and to apply what they have learned to their own research problems.

For more information on what we teach and why, please see our paper "Best Practices for Scientific Computing".

Who: The course is aimed at scientists and researchers who are interested in extending their skills in data processing and some basis to advanced techniques in "how to write good scientific code" and how to deal with this in abroader context. You need to have some previous knowledge of Python or another programming language, even if minimal, to benefit from the workshop and follow its course.

Where: GeoLab, A27 (Großer Refraktor), Albert-Einstein Wissenschaftspark, Telegrafenberg, 14473 Potsdam. Get directions with OpenStreetMap or Google Maps.

When: May 15-16 2017. Add to your Google Calendar.

Requirements: Participants are highly encouraged to use the provided IT-infrastructure (computer). This is a Linux system. Please note that the content taught can be used and easiliy be transfered later on to other operating systems. If you absolutely want to use your own laptop, we cannot garantee you full support during the workshop. An installation routine (also only for Linux) will be provided in advance, so you can install the required software. Specific software packages required are listed below. You are also required to abide by Software Carpentry's Code of Conduct.

Accessibility: We are committed to making this workshop accessible to everybody. Please contact the organisers if you have any requirements and/or need assistance to access the workshop rooms.

Materials will be provided in advance of the workshop and large-print handouts are available if needed by notifying the organizers in advance. If we can help making learning easier for you (e.g. sign-language interpreters, lactation facilities) please get in touch and we will attempt to provide them.

Contact: Please email martin.hammitzsch@gfz-potsdam.de or hellmann@pik-potsdam.de for more information.

Organization: We're happy to announce that these workshops are jointly organised by the GFZ German Research Centre for Geosciences, the Potsdam Institute for Climate Impact Research (PIK), and the University of Potsdam (UP), and others.


Schedule

Surveys

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

Pre-workshop Survey

Post-workshop Survey

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
15:30 Coffee
16:00 Basic Python Concepts I
17:30 Wrap-up

Day 2

09:00 Arrival & coffee
09:30 Basic Python Concepts II
11:00 Coffee
11:30 Defensive Programming, Debugging, Command Line Usage
13:00 Lunch
14:00 Final Project
15:30 Coffee (flexible break)
16:00 Final Project / Outlook & wrap-up / Post-workshop survey
16:30 Closing

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...

Programming in Python

  • Using libraries
  • Working with arrays
  • Reading and plotting data
  • Creating and using functions
  • Loops and conditionals
  • Defensive programming
  • Using Python from the command line
  • 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...

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'll have computers ready for you. However, you may bring your own notebook but you have to make sure that it is prepared properly.

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.

Windows

Video Tutorial
  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps bellow:
    1. Click on "Next".
    2. Click on "Next".
    3. Keep "Use Git from the Windows Command Prompt" 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. Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
    6. Keep "Use Windows' default console window" selected and click on "Next".
    7. Click on "Install".
    8. 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.

Mac OS X

The default shell in all versions of Mac OS X 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.

Linux

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 (current versions of Chrome, Firefox or Safari, or Internet Explorer version 9 or above).

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.

Windows

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

Mac OS X

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. 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.

Linux

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 yum 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 Mac OS X and Linux is usually set to Vim, which is not famous for being intuitive. if you accidentally find yourself stuck in it, try typing the escape key, followed by :q! (colon, lower-case 'q', exclamation mark), then hitting Return to return to the shell.

Windows

Video Tutorial

nano is a basic editor and the default that instructors use in the workshop. To install it, download the Software Carpentry Windows installer and double click on the file to run it. This installer requires an active internet connection.

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.

Mac OS X

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 Text Wrangler or Sublime Text.

Linux

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.

Python

Python is a popular language for research computing, and great for general-purpose programming as well. Installing all of its research packages individually can be a bit difficult, so we recommend Anaconda, an all-in-one installer.

Regardless of how you choose to install it, please make sure you install Python version 3.x (e.g., 3.4 is fine).

We will teach Python using the IPython notebook, a programming environment that runs in a web browser. For this to work you will need a reasonably up-to-date browser. The current versions of the Chrome, Safari and Firefox browsers are all supported (some older browsers, including Internet Explorer version 9 and below, are not).

Windows

Video Tutorial
  1. Open http://continuum.io/downloads with your web browser.
  2. Download the Python 3 installer for Windows.
  3. Install Python 3 using all of the defaults for installation except make sure to check Make Anaconda the default Python.

Mac OS X

Video Tutorial
  1. Open http://continuum.io/downloads with your web browser.
  2. Download the Python 3 installer for OS X.
  3. Install Python 3 using all of the defaults for installation.

Linux

  1. Open http://continuum.io/downloads with your web browser.
  2. Download the Python 3 installer for Linux.
    (Installation requires using the shell. If you aren't comfortable doing the installation yourself stop here and request help at the workshop.)
  3. Open a terminal window.
  4. Type
    bash Anaconda3-
    and then press tab. The name of the file you just downloaded should appear. If it does not, navigate to the folder where you downloaded the file, for example with:
    cd Downloads
    Then, try again.
  5. Press enter. You will follow the text-only prompts. To move through the text, press the space key. Type yes and press enter to approve the license. Press enter to approve the default location for the files. Type yes and press enter to prepend Anaconda to your PATH (this makes the Anaconda distribution the default Python).
  6. Close the terminal window.

Once you are done installing the software listed above, please go to this page, which has instructions on how to test that everything was installed correctly.