This is the workshop template. Delete these lines and use it to
customize
your own website. If you are running a self-organized workshop or have not put
in a workshop request yet, please also fill in
this workshop request form
to let us know about your workshop and our administrator may contact you if we
need any extra information.
If this is a pilot workshop for a new lesson,
set the `pilot` field to `true` in `_config.yml`.
For workshops teaching a lesson in The Carpentries Incubator,
remember to uncomment the `incubator_lesson_site`, `incubator_pre_survey`, and `incubator_post_survey`
fields in `_config.yml`
It looks like you are setting up a website for a Software Carpentry curriculum but you haven't specified the curriculum type in the _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
The Carpentries project comprises the Software Carpentry, Data Carpentry, and
Library Carpentry communities of Instructors, Trainers, Maintainers,
helpers, and supporters who share a mission to teach foundational computational and data science
skills to researchers.
Want to learn more and stay engaged with The Carpentries? Carpentries Clippings is The Carpentries' biweekly newsletter, where we share community news, community job postings, and more.
Sign up to receive future editions and read our full archive: https://carpentries.org/newsletter/
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.
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.
We are dedicated to providing a positive and accessible learning environment for all.
We do not require participants to provide documentation of disabilities or disclose any unnecessary personal information.
However, we do want to help create an inclusive, accessible experience for all participants.
We encourage you to share any information that would be helpful to make your Carpentries experience accessible.
To request an accommodation for this workshop, please fill out the
accommodation request form.
If you have questions or need assistance with the accommodation form please email us.
Glosario is a multilingual glossary
for computing and data science terms. The glossary helps
learners attend workshops and use our lessons to make sense of computational and programming jargon written in English by offering it
in their native language. Translating data science terms also provides a teaching tool for Carpentries Instructors to reduce barriers
for their learners.
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.
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.
Unrecognized value for variable 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.
To install WSL 2, you will need Administrator (“admin”) privileges on your laptop/PC.
If you have a device provided by an institution that does not give you admin rights, please either request that they:
Give you admin rights (temporarily or otherwise) to install WSL 2 yourself OR
Install WSL 2 for you
If neither of these options is available, please install Git for Windows using the instructions below.
Click on the Windows Start Menu button in the bottom left corner of your screen, or tap the Windows button on your keyboard, and type “System” in the search bar.
Click the “System (Control Panel)” option.
In the window that opens, there will be information about your current Windows system, including the version. Here is an example from Windows 11:
Depending on your version, please go to the relevant instructions below.
Windows XP/Vista/7/8
These versions of Windows are considered End Of Life, and are not recommended for use in modern data science.
Software may experience issues, and security updates are also not available which puts your machine at risk.
Please consider upgrading your Windows version if you are able to do this yourself, or speak with your local IT administrator to discuss options available to you to upgrade.
If you are running any of these Windows versions, please install Git for Windows using the installation instructions below.
Windows 10 (earlier than version #1903)
For older versions of Windows 10 (version 1903/OS build 18362 and below), please follow the Git for Windows installation instructions below.
Windows 10 (version #1903 and later) and Windows 11
WSL 2 is recommended for more modern versions of Windows as it provides an accurate and representative experience of Linux, but provided from within your Windows environment.
We will install Ubuntu via the Microsoft Store.
It is possible to install WSL within the Windows Powershell command prompt, and full instructions are on the Microsoft website.
Note: You will need to restart your computer after installing WSL 2, so make sure you have saved any work.
Why Ubuntu?
Linux comes in many flavours, called “distributions”, and each has its own benefits, features and quirks!
WSL 2 is a fully fledged Linux environment that runs completely within your Windows 10 or 11 operating system.
While there are many Linux distributions available to install (e.g. Ubuntu, Debian, Fedora, Mint, Arch, Gentoo, and hundreds more!), WSL 2 only supports a handful of distributions listed above due to the way it needs to be integrated with Windows itself.
So, we will use the default that WSL 2 recommends, Ubuntu.
Via the Microsoft Store:
Open the Windows Start Menu button in the bottom left corner of your screen (four blue squares), or tap the Windows button on your keyboard (between the bottom left CTRL and ALT keys) and search “store”. Open the Microsoft Store.
In the Microsoft Store search bar, type “wsl ubuntu”, and select the Ubuntu 22.04 or 24.04 option (at the time of writing, Ubuntu 22.04.06 LTS, or Ubuntu 24.04.01 LTS):
If a pop-up window appears asking if you want to make changes to your device, select “Yes”
The install should proceed, and this can take a few minutes depending on your PC performance and internet download speed.
Once installed, restart the computer.
Once restarted, reopen the Windows Start Menu button in the bottom left corner of your screen, or tap the Windows button on your keyboard. In the search bar, type either:
Ubuntu: this will open the bash prompt directly
Terminal: this will open a new Windows Terminal window, which will look like a blank black window with a blinking cursor waiting for input. Note: This terminal might default to Powershell, and not Ubuntu. If this is the case, click the down arrow in the Terminal window menu bar at the top, and then click Ubuntu 22.04 or 24.04, depending on the version you installed. It will also show keyboard shortcuts (e.g. Ctrl+Shift+1) to open the various prompts available within the Terminal application.
Once you have installed WSL 2, you will need to install some software within the Ubuntu operating system in order to use it effectively. Make sure you are using Ubuntu by checking you see the bash prompt:
The first thing to do is to update the list of available Ubuntu software packages, using a tool called apt.
Type the following command into the bash prompt:
sudo apt update
Note: You will be prompted to enter your password. This is the password you set when installing Ubuntu, and will not show up on the screen as you type it in.
This is a security feature of the terminal, and is normal behaviour.
Install updated versions of the base packages required across all our lessons, by typing:
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, "Choosing the default editor used by Git", select "Use the Nano editor by default" (NOTE: you will need to scroll up to find it) and click on "Next".
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.
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.)
Select "Use bundled OpenSSH".
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 "Git Credential Manager" is selected and click on "Next".
Ensure that "Enable file system caching" is 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
This will provide you with both Git and Bash in the Git Bash program.
Video Tutorial
The default shell in Mac OS X Ventura and newer versions is Zsh, but
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, you can change your current shell to Bash by typing
bash and then pressing Return. To check
your current shell type echo $0 and press Return.
To change your default shell to Bash type chsh -s /bin/bash and
press the Return key, then reboot for the change to take effect. To
change your default back to Zsh, type chsh -s /bin/zsh, press the
Return key and reboot. To check available shells, type
cat /etc/shells.
Video Tutorial
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 Terminal and press the Return key. If the message
printed does not end with '/bash' then your default is something
else, you can change your current shell to Bash by typing
bash and then pressing Return. To check
your current shell type echo $0 and press Return.
To change your default shell to Bash type chsh -s /bin/bash and
press the Return key, then reboot for the change to take effect. To
change your default back to Zsh, type chsh -s /bin/zsh, press the
Return key and reboot. To check available shells, type
cat /etc/shells.
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.
Please open the Terminal app, type git --version and press
Enter/Return. If it's not installed already,
follow the instructions to Install the "command line
developer tools". Do not click "Get Xcode", because that will
take too long and is not necessary for our Git lesson.
After installing these tools, there won't be anything in your /Applications
folder, as they and Git are command line programs.
For older versions of OS X (10.5-10.8) use the
most recent available installer labelled "snow-leopard"
available here.
(Note: this project is no longer maintained.)
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 in the pop-up dialog. You can watch
a video tutorial about this case.
Video Tutorial
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.
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.
Video Tutorial
nano is a basic editor and the default that instructors use in the workshop.
It should be pre-installed.
R
R is a programming language
that is especially powerful for data exploration, visualization, and
statistical analysis. To interact with R, we use
RStudio.
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.
Instructions for R installation on various Linux platforms (debian,
fedora, redhat, and ubuntu) can be found at
<https://cran.r-project.org/bin/linux/>. These will instruct you to
use your package manager (e.g. for Fedora run
sudo dnf install R and for Debian/Ubuntu, add a ppa
repository and then run sudo apt-get install r-base).
Also, please install the
RStudio IDE.
Python
Python is a popular language for
research computing, and great for general-purpose programming as
well. Installing all of its research packages individually can be
a bit difficult, so we recommend
Conda-forge,
an all-in-one installer.
Regardless of how you choose to install it,
please make sure you install a Python version >= 3.9
(e.g. 3.11 is fine, 3.6 is not).
We will teach Python using the Jupyter Notebook,
a programming environment that runs in a web browser (Jupyter Notebook will be installed by Miniforge). 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).
Double click on the downloaded file (Something like, Minforge3-Windows-x86_64.exe)
If you get a "Windows protected your PC" pop-up from Microsoft Defender SmartScreen, click on "More info" and select "Run anyway"
Follow through the installer using all of the defaults for installation except make sure to check Add Miniforge3 to my PATH environment variable.
Download the environment file. Save the file to your Downloads folder.
(The following steps requires using the shell. If you aren't
comfortable doing the installation yourself
stop here and request help at the workshop.)
Search for the application "Miniforge Prompt", open it and run: conda env create -f .\Downloads\carpentries_environment.yml
Download the appropriate Miniforge installer for macOS
(The following steps requires using the shell. If you aren't
comfortable doing the installation yourself
stop here and request help at the workshop.)
Open a terminal window and navigate to the directory where
the executable is downloaded (e.g., cd ~/Downloads).
Type
bash Miniforge3-
and then press
Tab to autocomplete the full file name. The name of
file you just downloaded should appear.
Press Enter
(or Return depending on your keyboard).
You will follow the text-only prompts.
To move through the text, press Spacebar.
Type yes and press enter to approve the license.
Press Enter (or Return)
to approve the default location
for the files.
Type yes and press
Enter (or Return)
to prepend Miniforge to your PATH
(this makes the Miniforge distribution the default Python).
Download the environment file. Save the file to your Downloads folder.
On the terminal run: conda env create -f ~/Downloads/carpentries_environment.yml
Download the appropriate Miniforge installer for Linux
(The following steps requires using the shell. If you aren't
comfortable doing the installation yourself
stop here and request help at the workshop.)
Open a terminal window and navigate to the directory where
the executable is downloaded (e.g., `cd ~/Downloads`).
Type
bash Miniforge3-
and then press
Tab to autocomplete the full file name. The name of
file you just downloaded should appear.
Press Enter
(or Return depending on your keyboard).
You will follow the text-only prompts.
To move through the text, press Spacebar.
Type yes and press enter to approve the license.
Press Enter (or Return)
to approve the default location
for the files.
Type yes and press
Enter (or Return)
to prepend Miniforge to your PATH
(this makes the Miniforge distribution the default Python).
Download the environment file. Save the file to your Downloads folder.
Search for the application "Miniforge Prompt", open it and run: conda env create -f ~/Downloads/carpentries_environment.yml