May 19th, 2019
1:00 pm - 5:00 pm
Instructors: Sarah Stevens
Helpers: Elizabeth McDaniel, Steven Goldstein, Sailendharan Sudakaran
This workshop aims to be the next step in reproducibility for computational biologists and will focus on using and developing software containers. We will review best practices for practicing reproducible research and teach participants how to use Docker, a popular software for containerization (which can also be used by Singularity, another commonly used containerization platform). Using containers can help overcome the many interoperability and dependency issues often encountered when distributing or installing software. Docker images used conjunction with continuous integration is considered to be a possible solution for the reproducibility crisis plaguing research at large. Similar to a Carpentries workshop, a majority of the proposed workshop will be hands-on live-coding. Workshop attendees are expected to have familiarity with the Unix shell and git/github, bring their own laptops, and follow along with the training.
Software Carpentry workshops, in general, aim to help researchers get their work done in less time and with less pain by teaching them basic research computing skills. This workshop is an extension of a Softare Carpentry Workshop and aims to teach researchers how to use Docker and the importance of reproducible research. This workshop will briefly review the importance of reproduciblility, and then move the the hands-on portion, learning to make containers in Docker. 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 who are attending the GLBIO 2019 conference. You will need to be comfortable using the unix command line and have familiarity with using the version control system git.
When: May 19th, 2019. 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). They are also required to abide by Software Carpentry's Code of Conduct.
Accessibility: We are committed to making this workshop accessible to everybody. 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 firstname.lastname@example.org for more information.
|13:00||The Importance of Being Reproducible|
|14:00||Intro to Docker|
|15:15||Making your Own Images with Docker|
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.
Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.
cmdand press [Enter])
setx HOME "%USERPROFILE%"
SUCCESS: Specified value was saved.
exitthen pressing [Enter]
This will provide you with both Git and Bash in the Git Bash program.
The default shell in all versions of macOS is Bash, so no
need to install anything. You access Bash from the Terminal
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.
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
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.
Git should be installed on your computer as part of your Bash install (described above).
For OS X 10.9 and higher, install Git for Mac
by downloading and running the most recent "mavericks" installer from
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
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"
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.
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, try
typing the escape 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.