_config.yml
file (current value in _config.yml
: "FIXME", possible values: swc-inflammation
, or swc-gapminder
). After editing this file, you need to run make serve
again to see the changes reflected.
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.
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. The workshop organizers have checked that:
- The room is wheelchair / scooter accessible.
- Accessible restrooms are available.
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 to-be-announced 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.
Schedule
Day 1
Before | Pre-workshop survey |
09:00 | Automating Tasks with the Unix Shell |
10:30 | Morning break |
11:00 | Automating Tasks with the Unix Shell (Continued) |
12:00 | Lunch break |
13:00 | Building Programs with Python |
14:30 | Afternoon break |
15:00 | Building Programs with Python (Continued) |
16:00 | Wrap-up |
16:30 | END |
Day 2
09:00 | Version Control with Git |
10:30 | Morning break |
11:00 | Version Control with Git (Continued) |
12:00 | Lunch break |
13:00 | Managing Data with SQL |
14:30 | Afternoon break |
15:00 | Managing Data with SQL (Continued) |
16:00 | Wrap-up |
16:30 | Post-workshop Survey |
16:40 | END |
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...
Managing Data with SQL
- Reading and Sorting Data
- Filtering with
where
- Calculating New Values on the Fly
- Handling Missing Values
- Combining Values Using Aggregation
- Combining Information From Multiple Tables Using
join
- Creating, Modifying, and Deleting Data
- Programming with Databases
- 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.
curriculum
set in
_config.yml
. Currently the variable is set to:
FIXME
. Check the values of
carpentry
and curriculum
in the
_config.yml
file.
The Bash Shell
Bash is a commonly-used shell that gives you the power to do tasks more quickly.
- Download the Git for Windows installer.
- Run the installer and follow the steps below:
- 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.
- From the dropdown menu select "Use the nano editor by default" and click on "Next".
- 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.)
- Ensure that "Use the native Windows Secure Channel library" is selected and click on "Next".
- Ensure that "Checkout Windows-style, commit Unix-style line endings" is selected and click on "Next".
- Ensure that "Use Windows' default console window" is selected and click on "Next".
- Ensure that "Default (fast-forward or merge) is selected and click "Next"
- Ensure that "Enable file system caching" and "Enable Git Credential Manager" are selected and click on "Next".
- Click on "Install".
- Click on "Finish" or "Next".
-
If your "HOME" environment variable is not set (or you don't know what this is):
- Open command prompt (Open Start Menu then type
cmd
and press Enter) -
Type the following line into the command prompt window exactly as shown:
setx HOME "%USERPROFILE%"
- Press Enter, you should see
SUCCESS: Specified value was saved.
- Quit command prompt by typing
exit
then pressing Enter
- Open command prompt (Open Start Menu then type
This will provide you with both Git and Bash in the Git Bash program.
The default shell in some versions of macOS is Bash, and
Bash is available in all versions, 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.
To see if your default shell is Bash type echo $SHELL
in Terminal and press the Return key. If the message
printed does not end with '/bash' then your default is something
else and you can run Bash by typing bash
If you want to change your default shell, see this Apple Support article and follow the instructions on "How to change your default shell".
The default shell is usually Bash and there is usually no need to install anything.
To see if your default shell is Bash type echo $SHELL
in
a terminal and press the Enter key. If the message printed
does not end with '/bash' then your default is something else and you
can run Bash by typing bash
.
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.
Git should be installed on your computer as part of your Bash install (see the Shell installation instructions).
For macOS, install Git for Mac
by downloading and running the most recent "mavericks" installer from
this list.
Because this installer is not signed by the developer, you may have to
right click (control click) on the .pkg file, click Open, and click
Open on the pop up window.
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.
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, 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.
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.
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 BBEdit or Sublime Text.
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.
Unrecognized value for variable flavor
set in
_config.yml
. Valid values are "r"
and
"python"
, currently set to FIXME
.