Fork me on GitHub

iCER / HPCC / BEACON at Michigan State University,

Jan 27-29, 2015

8:30 am - 12:00 pm

Instructors: Joshua R. Herr, Luiz Irber, Jiarong Guo, Aaron Garoutte

Helpers: TBA

General Information

We will use this Mo-Pad Note Page to take shared notes for the event.

For more information and to register for this bootcamp, please see the iCER webpage for this event.

Software Carpentry's mission is to help scientists and engineers become more productive by teaching them basic lab skills for computing like program design, version control, data management, and task automation. This two-day hands-on workshop will cover basic concepts and tools; participants will be encouraged to help one another and to apply what they have learned to their own research problems.

Who: The course is aimed at graduate students and other researchers.

Where: Biomedical and Physical Sciences Building, East Lansing, Michigan, 48824. Get directions with OpenStreetMap or Google Maps.

Requirements: Participants must bring a laptop with a few specific software packages installed (listed below). They are also required to abide by Software Carpentry's Code of Conduct.

Contact: Please mail joshua.r.herr@gmail.com for more information.


Schedule

Day 1

08:30 AMIntroduction to the Unix shell
10:00 AMCoffee break
10:15 AMAutomating Tasks with the Shell
NoonLunch
12:30 PMWrap-Up

Day 2

08:30 AMPython introduction
09:00 AMVariables and string
10:00 AM Coffee break
10:15 AMList and file stream
NoonLunch
12:30 PMWrap-Up

Day 3

08:30 AMVersion control with Git
10:00 AMCoffee break
10:15 AMUsing Git with Collaborators
NoonLunch
12:30 PMWrap-Up

Syllabus

The Unix Shell

  • Files and directories: pwd, cd, ls, mkdir, ...
  • History and tab completion
  • Pipes and redirection
  • Looping over files
  • Creating and running shell scripts
  • Finding things: grep, find, ...
  • Reference Link

Programming in Python

  • Variables and strings
  • List
  • Read and write files
  • Notes...
  • Exercises...
  • Loops and conditionals: for, if, else, ...
  • Using Python from the command line
  • Using libraries
  • Reference Link

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 Link

Setup

To participate in a Software Carpentry workshop, you will need working copies of the software described below. Please make sure to install everything (or at least to download the installers) before the start of your workshop.

Overview

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.

Git

Git is a state-of-the-art version control system. It 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.

Python

Python is becoming very popular in scientific computing, and it's a great language for teaching general programming concepts due to its easy-to-read syntax. We teach with Python version 2.7, since it is still the most widely used. Installing all the scientific packages for Python individually can be a bit difficult, so we recommend an all-in-one installer.

Windows

Python

  • Download and install Anaconda.
  • Use all of the defaults for installation except make sure to check Make Anaconda the default Python.

Git Bash

Install Git for Windows by download and running the installer. This will provide you with both Git and Bash in the Git Bash program.

Software Carpentry Installer

This installer requires an active internet connection

After installing Python and Git Bash:

  • Download the installer.
  • If the file opens directly in the browser select File→Save Page As to download it to your computer.
  • Double click on the file to run it.

Editor

nano is the editor installed by the Software Carpentry Installer, it is a basic editor integrated into the lesson material.

Notepad++ is a popular free code editor for Windows. Be aware that you must add its installation directory to your system path in order to launch it from the command line (or have other tools like Git launch it for you). Please ask your instructor to help you do this.

Mac OS X

Editor

We recommend Text Wrangler or Sublime Text. In a pinch, you can use nano, which should be pre-installed.

Git

For OS X 10.8 and higher, install Git for Mac by downloading and running the installer. For older versions of OS X (10.5-10.7) use the most recent available installer for your OS available here. Use the Leopard installer for 10.5 and the Snow Leopard installer for 10.6-10.7.

Python

  • Download and install Anaconda.
  • Use all of the defaults for installation except make sure to check Make Anaconda the default Python.
  • Troubleshooting: If you get the following error message "ValueError unknown locale: UTF-8", see instructions on how to fix it here.

Linux

Git

If Git is not already available on your machine you can try to install it via your distro's package manager (e.g. apt-get or yum).

Editor

Kate is one option for Linux users. In a pinch, you can use nano, which should be pre-installed.

Python

We recommend the all-in-one scientific Python installer Anaconda. (Installation requires using the shell and if you aren't comfortable doing the installation yourself just download the installer and we'll help you at the boot camp.)

  1. Download the installer that matches your operating system and save it in your home folder.
  2. Open a terminal window.
  3. Type
    bash Anaconda-
    and then press tab. The name of the file you just downloaded should appear.
  4. Press enter. You will follow the text-only prompts. When there is a colon at the bottom of the screen press the down arrow to move down through the text. 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).

Reference


Instructors

Josh Herr
Josh Herr is a post-doctoral researcher at Michigan State University in the Department of Microbiology & Molecular Genetics. He holds a B.S. in Biochemistry, M.S. in Plant Biology, and a Ph.D. in Integrative Biology. His research interests introduced him to phylogenetics at the command line and he has transitioned from the lab bench (almost entirely) to the computational analysis of microbial genomes and metagenomes. Josh blogs about his research interests at Cyme & Cystidium and is an editor at the bioinformatics help forum Biostar.