Duke University

Aug 12-15, 2019

9:00am - 5:00pm (Mon, Wed); 9:00am - 12:30pm (Tue, Thu)

Instructors: Dan Leehr (GCB), Hilmar Lapp (GCB)

Helpers: Melyssa Minto (CBB), Lanie Happ (CBB), Zachery Mielko (UPGG), Tiffany Ho (GCB), Kimberly Roche (CBB)

UPGG Informatics Orientation Bootcamp

This workshop is inspired by the format of The Carpentries-type workshops. It combines lessons drawn from Data Carpentry, Software Carpentry, and the Reproducible Science Curriculum (in particular from the Python-based Reproducible Science using Jupyter Notebooks workshop curriculum). The total length of instruction is three days rather than the usual two, but spread out over four days (the second and fourth day are half days). As for regular Carpentries workshops, this course will be highly interactive and hands-on. Participants will use their own laptops throughout the course, and are encouraged to help one another.

The Carpentries develops and teaches workshops on the foundational coding and data skills needed to conduct research. Its target audience is researchers worldwide, including those who have little to no prior computational experience.

For more information on what The Carpentries teaches and why, please see the following paper "Good Enough Practices for Scientific Computing".

Who: The course is designed for incoming and 1st year students in Duke's University Program in Genetics and Genomics (UPGG). The course is held as part of the UPGG orientation week, and is at least currently not open to others for registration.

Where: FFSC #4233, 124 Science Drive, Durham, NC 27708. Get directions with OpenStreetMap or Google Maps.

When: Aug 12-15, 2019. 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 Data 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.

Contact: Please email gcb-help@duke.edu for more information.


Surveys

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

Pre-workshop Survey


Schedule

Day 4

Morning Version control with Git
Afternoon
WORKSHOP END

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


Syllabus

Introduction to the Unix command line

  • Files and directories
  • History and tab completion
  • Pipes and redirection
  • Looping over files
  • Creating and running shell scripts
  • Finding things
  • Materials: shell_data.zip
  • Reference...

Programming in Python

Data and project organization

  • Project structure best practices
  • File naming best practices
  • Metadata best practices
  • READMEs
  • Cardinal rules for modifying data
  • Materials: Lesson setup
  • Lesson overview

Data exploration using Jupyter Notebook

Automation using Python

  • Defensive programming
  • Don't repeat yourself
  • Constructing and invoking functions
  • Lesson overview

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 Data 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 below:
    1. Click on "Next".
    2. Click on "Next".
    3. Select "Use the Nano editor by default" and click on "Next".
    4. Select "Git from the command line and also from 3rd-party software" 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.
    5. Click on "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. Click on "Install".
    9. 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. Git Bash installs nano. To use it, open a Git Bash window and type nano.

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.

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.6 is fine).

We will teach Python using the Jupyter 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 https://www.anaconda.com/distribution/#windows 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.

macOS

Video Tutorial
  1. Open https://www.anaconda.com/distribution/#macos 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 https://www.anaconda.com/distribution/#linux with your web browser.
  2. Download the Python 3 installer for Linux.
    (The 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.