Software Carpentry: University of Nebraska-Lincoln

University of Nebraska-Lincoln

Jan 8-9, 2015

8:30 am - 4:30 pm

Instructors: Sheldon McKay, Daniel Smith

Helpers: Derek Weitzel, Emelie Harstad, Jingchao Zhang, Adam Caprez, Natasha Pavlovijk, O. William McClung

General Information

Software Carpentry's mission is to help scientists and engineers get more research done in less time and with less pain by teaching them basic lab skills for scientific computing. 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.

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

Where: Avery Hall, room 119. Get directions with OpenStreetMap or Google Maps.

Parking: For those with UNL parking permits, A and C lots are located near Avery Hall (parking map). If you do not have a UNL parking permit, the Stadium Drive Garage is available.

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 sheldon.mckay@gmail.com for more information.

Workshop Materials

The workshop materials are in a github repository at https://github.com/mckays630/2015-01-08-unl, which contains a lot of resources and lessons.

To get the workshop materials:

git clone https://github.com/mckays630/2015-01-08-unl.git

If you can not get the above to work: download link

Etherpad

We use Etherpad as a backchannel chat to take and share notes during the workshop. Please also use Etherpad to ask and answer any questions that come up while an instructor is teaching.

The workshop Etherpad can be found at: https://etherpad.mozilla.org/2015-01-08-unl.

Schedule

Day 1

8:30 - 9:00	Setup Help
9:00 - 9:15	Introduction
9:15 - 10:30	Introduction to the Shell
10:30 - 10:45	Break
10:45 - 12:00	Automating workflows (Shell)
12:00 - 1:00	Lunch
1:00 - 2:30	Git Version Control I
2:30 - 2:45	Break
2:45 - 4:15	Git Version Control II
4:15 - 4:30	Wrap up and Questions

Day 2


9:00 - 9:30	Review / Questions
9:30 - 10:30	Programming with Python
10:30 - 10:45	Break
10:50 - 12:00	Numerical Python (NumPy)
12:00 - 1:00	Lunch
1:00 - 2:30	Python Data Analysis Library (Pandas)
2:30 - 2:40	Break
2:40 - 4:15	Defensive programming with python
4:15 - 4:30	Wrap up and Questions

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

This page has instructions on testing that you have the right software installed.

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

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

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

Linux

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

The Bash Shell

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

Windows

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.

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

Windows

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

Mac OS X

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.

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.

Python

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

Windows

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

Mac OS X

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

Linux

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

Download the installer that matches your operating system and save it in your home folder.
Open a terminal window.
Type
```
bash Anaconda-
```
and then press tab. The name of the file you just downloaded should appear.
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).