Reclamation SWC May 2022

Bureau of Reclamation

May 31 - June 1, 2022

9:00 am - 5:00 pm MT

Instructors: Drew Allan Loney

Helpers: N/A

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: 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: Virtual. Get directions with OpenStreetMap or Google Maps.

When: May 31 - June 1, 2022. 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).

Accessibility: We are committed to making this workshop accessible to everybody. For workshops at a physical location, 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 dloney@usbr.gov for more information.

Roles: To learn more about the roles at the workshop (who will be doing what), refer to our Workshop FAQ.


Code of Conduct

Everyone who participates in Carpentries activities is required to conform to the Code of Conduct. This document also outlines how to report an incident if needed.


Surveys

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

Pre-workshop Survey

Post-workshop Survey


Schedule

The instructor will be available each day before class starting at 8 am to help with troubleshooting or to answer questions. Please take advantage of this time to help ensure the rest of the course remains on schedule.

Day 1

09:00 Programming with Python - Getting Started
10:30 Morning break
11:00 Programming with Python - Lists and Loops
12:30 Lunch
13:00 Programming with Python - Lists and Loops - Continued
14:00 Programming with Python - Files, Choices, Functions
15:00 Afternoon break
15:15 Programming with Python - Errors, Debugging, CLI
16:00 Programming with Python - Useful packages
16:30 Programming with Python - Multiprocessing
16:50 Wrap-up
16:40 END

Day 2

09:00 The Unix Shell - Navigating and Files/Directories
10:15 Morning break
10:30 The Unix Shell - Pipe and Loops
12:30 Lunch break
13:00 The Unix Shell - Scripts and Finding Things
13:30 Version Control with Git
14:30 Afternoon break
14:45 Version control with Git (continued
16:40 Wrap-up
16:50 Post-workshop Survey
17:00 END

Setup

To participate in a Software Carpentry workshop, you will need access to software as 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.

Depending on the user's privlidges, the software should be able to be installed on the machine without the need to reach out to the RESC for temporary administrative access. However, please make sure to install these early to confirm that you can install and run each component in case RESC help is needed. Users should come to the session with everything installed as we'll dive right into the lessons. If you have any questions or issues, please reach out to Drew to help get your system setup in advance.

The Bash Shell

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

  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps below:
    1. Click on "Next" four times (two times if you've previously installed Git). You don't need to change anything in the Information, location, components, and start menu screens.
    2. From the dropdown menu select "Use the Nano editor by default" (NOTE: you will need to scroll up to find it) and click on "Next".
    3. On the page that says "Adjusting the name of the initial branch in new repositories", ensure that "Let Git decide" is selected. This will ensure the highest level of compatibility for our lessons.
    4. Ensure that "Git from the command line and also from 3rd-party software" is selected and click on "Next". (If you don't do this Git Bash will not work properly, requiring you to remove the Git Bash installation, re-run the installer and to select the "Git from the command line and also from 3rd-party software" option.)
    5. Ensure that "Use the native Windows Secure Channel Library" is selected and click on "Next".
    6. Ensure that "Checkout Windows-style, commit Unix-style line endings" is selected and click on "Next".
    7. Ensure that "Use Windows' default console window" is selected and click on "Next".
    8. Ensure that "Default (fast-forward or merge) is selected and click "Next"
    9. Ensure that "Git Credential Manager Core" is selected and click on "Next".
    10. Ensure that "Enable file system caching" is selected and click on "Next".
    11. Click on "Install".
    12. Click on "Finish" or "Next".
  3. If your "HOME" environment variable is not set (or you didn't have a clean install):
    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.

Video Tutorial

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.

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.

Reclamation also has a GitLab instance. Since GitHub is more flexible and open, we will be using it for the lesson. However, the functionality of Git will be exactly the same between the systems with only the online interface changing.

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, hit the Esc key, followed by :+Q+! (colon, lower-case 'q', exclamation mark), then hitting Return to return to the shell.

nano is a basic editor and the default that instructors use in the workshop. It is installed along with Git. When given the option to select a text editor during installation, choose nano as the option.

Python

Python is a popular language for research computing, and great for general-purpose programming as well.

Regardless of how you choose to install it, please make sure you install Python version 3.x (e.g., 3.8 is fine).

We will teach Python using the Jupyter Notebook, a programming environment that runs in a web browser (Jupyter Notebook will be installed by Miniconda). 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).