CarpentryConnect Johannesburg 2018 - Software Carpentry

September 3 - 5, 2018

8:30 - 17:00

Instructors: Allegra Via, Shunmuga Pillay, Samar Elsheikh, San Emmanuel James

Helpers: Anelda van der Walt

General Information

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

This Software Carpentry workshop forms part of a 5-day CarpentryConnect event that will also include two other 3-day Carpentry workshops: Library Carpentry and Data Carpentry for Social Scientists. Day 4 & 5 is reserved for Carpentries instructor training.

CarpentryConnect Johannesburg 2018 is co-funded by the Rural Campuses Connection Project II (RCCPII) and the South African Centre for Digital Language Resources (SADiLAR).

Who: The course is aimed at graduate students and other researchers. You don't need to have any previous knowledge of the tools that will be presented at the workshop.

Where: Birchwood Hotel and Conference Centre, Johannesburg. Get directions with OpenStreetMap or Google Maps.

When: September 3 - 5, 2018. 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.

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

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 (using contact details below) and we will attempt to provide them.

Contact: Please email carpentryconnect-jhb-2018@googlegroups.com 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

Before Pre-workshop survey
08:30 - 09:00 Coffee/Tea & Help with software installation
09:00 - 09:30 Getting started with The Carpentries
09:30 - 10:00 Jargon Busting
10:00 - 10:30 Automating tasks with the Unix shell
10:30 - 11:00 Refreshment Break
11:00 - 12:30 Automating tasks with the Unix shell
12:30 - 13:30 Lunch
13:30 - 15:00 Automating tasks with the Unix shell
15:00 - 15:30 Refreshment Break
15:30 - 16:30 Automating tasks with the Unix shell
16:30 END

Day 2

08:30 - 09:00 Coffee/Tea & Help with software installation
09:00 - 10:30 R for Data Analysis and Visualisation
10:30 - 11:00 Refreshment Break
11:00 - 12:30 R for Data Analysis and Visualisation
12:30 - 13:30 Lunch
13:30 - 15:00 R for Data Analysis and Visualisation
15:00 - 15:30 Refreshment Break
15:30 - 16:30 R for Data Analysis and Visualisation
16:30 END

Day 3

08:30 - 09:00 Coffee/Tea & Help with software installation
09:00 - 10:30 Git & Github for Version Control & Collaboration
10:30 - 11:00 Refreshment Break
11:00 - 12:30 Git & Github for Version Control & Collaboration
12:30 - 13:30 Lunch
13:30 - 15:00 The Carpentries at my Institution
15:00 - 15:30 Refreshment Break
15:30 - 16:30 Bring Your Data & Questions - Open Session
16:30 END

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

R for Data Analysis and Visualisation

  • Introduction to R
  • Starting with Data
  • Aggregating and Analysing Data with dplyr
  • Data Visualisation with ggplot2
  • Reference...

Collaboration & Version Control with Git

  • Creating a repository
  • Recording changes to files
  • Viewing changes
  • Ignoring files
  • Working on the web
  • 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 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.

macOS

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.

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

macOS

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

macOS

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.

R

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

Windows

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.

macOS

Video Tutorial

Install R by downloading and running this .pkg file from CRAN. Also, please install the RStudio IDE.

Linux

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.