State Water Agencies

May 18-19, 2017

8:30 am - 4:30 pm

Instructors: Jaime Ashander, Jason Moore

Helpers: Ryan Peek, Tamer Mansour, Shannon Joslin, Kenny Lyons, Ben Margolis, Shamoni Maheshwari

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

Who: This course is aimed at environmental professionals working on water resources for the State of California. The course is intended to give participants an introduction to common tools used in data analysis, and to provide a foundation for further self-learning on how to carry out analyses more quickly and accurately. Email Daniel Constable for registration. You don't need to have any previous knowledge of the tools that will be presented at the workshop.

Where: Bonderson Hearing Room, Bonderson Building, 901 P St, Sacramento, CA 95814. Note: Closest entry way is on O St, between 9th and 10th streets. Door is locked, but staff will be on hand to provide access. Get directions with OpenStreetMap or Google Maps.

When: May 18-19, 2017. Add to your Google Calendar.

Requirements: The training room is not equipped with computers. 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. Delta Stewardship Council only: Staff will be provided with a laptop computer with all the necessary programs installed. Due to the limited number of laptops, we unfortunately cannot provide computers to staff of other agencies.

Accessibility: We are committed to making this workshop accessible to everybody. The workshop organisers 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 and we will attempt to provide them.

Contact: Please email ashander@ucla.edu , jasonmoore@ucdavis.edu or daniel.constable@deltacouncil.ca.gov for more information.


Schedule

Surveys

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

Pre-workshop Survey

Post-workshop Survey

Day 1

08:30 Automating tasks with the Unix shell
10:15 Coffee at workshop
11:30 Lunch break
12:30 Building blocks of R
14:30 Coffee
16:00 Wrap-up

Day 2

08:30 Version control with Git
10:15 Coffee at workshop
11:30 Lunch break
12:30 Reproducible scripts and graphics in R
14:30 Coffee
16:00 Wrap-up

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

Programming in R

  • Introduction to R and RStudio
  • Working with vectors and data frames
  • Loops and conditionals
  • Creating and using functions
  • Creating publication-qualtity graphics
  • Versatile strategies for data analysis
  • Writing reproducible analyses
  • 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 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. To check whether nano is installed, open "Git Bash" from the start menu, type nano in the new window, and press enter. If the response is nano not found or something similar the installer didn't work. Try reinstalling or follow the instructions below to use Notepad++ as an alternative text editor.

To install Notepad++ download the installer and install it by clicking on it and following the prompts. Then follow these instructions to integrate it with Git Bash:

  1. Open "Git Bash" from the start menu.
  2. Type: cd and press enter to make sure you are in your home directory.
  3. Type: notepad .bashrc and press enter. This will create .bashrc file in Notepad. Add the following two lines of text to the file:
    export PATH=$PATH:"C:\Program Files (x86)\Notepad++"
    alias npp=notepad++
  4. Save the file and exit Notepad.
  5. Open a new "Git Bash" window. You should now be able to launch Notepad++ by typing: npp and pressing enter.
If you run into trouble please come to the workshop early to get help with 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.

R and RStudio

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.

Mac OS X

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 yum install R). Also, please install the RStudio IDE.