Skip to content

Latest commit

 

History

History
622 lines (561 loc) · 26.8 KB

index.md

File metadata and controls

622 lines (561 loc) · 26.8 KB
layout carpentry venue address latlng country language humandate humantime startdate enddate instructor helper email collaborative_notes eventbrite
workshop
swc
University of Washington
via Zoom (registered participants will receive more detailed instructions how to join)
47.606209, -122.332071
us
en
May 11th - 14th, 2020
9:00 AM - noon
2020-05-11
2020-05-14
Anthony Valente
Bernease Herman
Bryna Hazelton
Scott Henderson
Meredith Rawls
Jen Sobeck
Anthony Valente
Noah Benson
Alicia Clark
Valentina Staneva
Amanda Tan

{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}

{% comment %} HEADER

Edit the values in the block above to be appropriate for your workshop. If the value is not 'true', 'false', 'null', or a number, please use double quotation marks around the value, unless specified otherwise. And run 'make workshop-check' before committing to make sure that changes are good. {% endcomment %}

{% if page.carpentry != site.carpentry %}

You specified carpentry: {{page.carpentry}} in index.md and carpentry: {{site.carpentry}} in _config.yml. Make sure you edit both files. After editing _config.yml, you need to run make serve again to see the changes take effect locally.
{% endif %}

{% comment %} EVENTBRITE

This block includes the Eventbrite registration widget if 'eventbrite' has been set in the header. You can delete it if you are not using Eventbrite, or leave it in, since it will not be displayed if the 'eventbrite' field in the header is not set. {% endcomment %} {% if page.eventbrite %}

<iframe src="https://www.eventbrite.com/tickets-external?eid={{page.eventbrite}}&ref=etckt" frameborder="0" width="100%" height="280px" scrolling="auto"> </iframe> {% endif %}

General Information

{% comment %} INTRODUCTION

Edit the general explanatory paragraph below if you want to change the pitch. {% endcomment %} {% if page.carpentry == "swc" %} {% include sc/intro.html %} {% elsif page.carpentry == "dc" %} {% include dc/intro.html %} {% elsif page.carpentry == "lc" %} {% include lc/intro.html %} {% endif %}

{% comment %} AUDIENCE

Explain who your audience is. (In particular, tell readers if the workshop is only open to people from a particular institution. {% endcomment %} {% if page.carpentry == "swc" %} {% include sc/who.html %} {% elsif page.carpentry == "dc" %} {% include dc/who.html %} {% elsif page.carpentry == "lc" %} {% include lc/who.html %} {% endif %}

{% comment %} LOCATION

This block displays the address and links to maps showing directions if the latitude and longitude of the workshop have been set. You can use https://itouchmap.com/latlong.html to find the lat/long of an address. {% endcomment %} {% if page.latlng %}

Where: {{page.address}}. {% endif %}

{% comment %} DATE

This block displays the date and links to Google Calendar. {% endcomment %} {% if page.humandate %}

When: {{page.humandate}}. {% include workshop_calendar.html %}

{% endif %}

{% comment %} SPECIAL REQUIREMENTS

Modify the block below if there are any special requirements. {% endcomment %}

Requirements: Participants must have a laptop/desktop with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. The computers should have sound, microphone and preferably a video functionality. They should have a few specific software packages installed (listed below).

{% comment%} CODE OF CONDUCT {% endcomment %}

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.

{% comment %} ACCESSIBILITY

Modify the block below if there are any barriers to accessibility or special instructions. {% endcomment %}

Accessibility: We are committed to making this workshop accessible to everybody. This workshop will be delivered online via video conferencing, so please let us know in advance if there is anything we should provide (such as captioning, etc) in order to facilitate your learning.

{% comment %} CONTACT EMAIL ADDRESS

Display the contact email address set in the configuration file. {% endcomment %}

Contact: Please email {% if page.email %} {% for email in page.email %} {% if forloop.last and page.email.size > 1 %} or {% else %} {% unless forloop.first %} , {% endunless %} {% endif %} {{email}} {% endfor %} {% else %} to-be-announced {% endif %} for more information.


{% comment %} SURVEYS - DO NOT EDIT SURVEY LINKS {% endcomment %}

Surveys

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

{% if site.carpentry == "swc" %}

Pre-workshop Survey

Post-workshop Survey

{% elsif site.carpentry == "dc" %}

Pre-workshop Survey

Post-workshop Survey

{% elsif site.carpentry == "lc" %}

Pre-workshop Survey

Post-workshop Survey

{% endif %}

{% comment %} SCHEDULE

Show the workshop's schedule. Edit the items and times in the table to match your plans. You may also want to change 'Day 1' and 'Day 2' to be actual dates or days of the week. {% endcomment %}

Schedule

{% if page.carpentry == "swc" %} {% include sc/schedule.html %} {% elsif page.carpentry == "dc" %} {% include dc/schedule.html %} {% elsif page.carpentry == "lc" %} {% include lc/schedule.html %} {% endif %}

{% comment %} Collaborative Notes

If you want to use an Etherpad, go to

http://pad.carpentries.org/YYYY-MM-DD-site

where 'YYYY-MM-DD-site' is the identifier for your workshop, e.g., '2015-06-10-esu'. {% endcomment %} {% if page.collaborative_notes %}

We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.

{% endif %}

{% comment %} SYLLABUS

Show what topics will be covered.

  1. If your workshop is R rather than Python, remove the comment around that section and put a comment around the Python section.
  2. Some workshops will delete SQL.
  3. Please make sure the list of topics is synchronized with what you intend to teach.
  4. You may need to move the div's with class="col-md-6" around inside the div's with class="row" to balance the multi-column layout.

This is one of the places where people frequently make mistakes, so please preview your site before committing, and make sure to run 'tools/check' as well. {% endcomment %}

Syllabus

{% if page.carpentry == "swc" %} {% include sc/syllabus.html %} {% elsif page.carpentry == "dc" %} {% include dc/syllabus.html %} {% elsif page.carpentry == "lc" %} {% include lc/syllabus.html %} {% endif %}


{% comment %} SETUP

Delete irrelevant sections from the setup instructions. Each section is inside a 'div' without any classes to make the beginning and end easier to find.

This is the other place where people frequently make mistakes, so please preview your site before committing, and make sure to run 'tools/check' as well. {% endcomment %}

Setup

To participate in a {% if page.carpentry == "swc" %} Software Carpentry {% elsif page.carpentry == "dc" %} Data Carpentry {% elsif page.carpentry == "lc" %} Library Carpentry {% endif %} 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.

{% comment %} Start of 'shell' section. {% endcomment %}

The Bash Shell

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

<div class="tab-content">
  <article role="tabpanel" class="tab-pane active" id="shell-windows">
    <a href="https://www.youtube.com/watch?v=339AEqk9c-8">Video Tutorial</a>
    <ol>
      <li>Download the Git for Windows <a href="https://git-for-windows.github.io/">installer</a>.</li>
      <li>Run the installer and follow the steps below:
        <ol>
          {% comment %} Git 2.22.0 Setup {% endcomment %}
          <li>
            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.
          </li>
          <li>
            <strong>
              Select "Use the nano editor by default" and click on "Next".
            </strong>
          </li>
          {% comment %} Adjusting your PATH environment {% endcomment %}
          <li>
            Keep "Git from the command line and also from 3rd-party software" 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.
          </li>
          {% comment %} Choosing the SSH executable {% endcomment %}
          <li>Click on "Next".</li>
          {% comment %} Choosing HTTPS transport backend {% endcomment %}
          <li>Select "Use the native Windows Secure Channel library", and click "Next".</li>
          {% comment %} This should mean that people stuck behind corporate firewalls that do MITM attacks 
                             with their own root CA are still able to access remote git repos. {% endcomment %}
          {% comment %} Configuring the line ending conversions {% endcomment %}
          <li>
            Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
          </li>
          {% comment %} Configuring the terminal emulator to use with Git Bash {% endcomment %}
          <li>
            <strong>
              Select "Use Windows' default console window" and click on "Next".
            </strong>
          </li>
          {% comment %} Configuring extra options {% endcomment %}
          <li>Leave all three items selected, and click on "Next".</li>
          {% comment %} Configuring experimental options {% endcomment %}
          <li>Do not select the experimental option. Click "Install".</li>
          {% comment %} Installing {% endcomment %}
          {% comment %} Completing the Git Setup Wizard {% endcomment %}
          <li>Click on "Finish".</li>
        </ol>
      </li>
      <li>
        If your "HOME" environment variable is not set (or you don't know what this is):
        <ol>
          <li>Open command prompt (Open Start Menu then type <code>cmd</code> and press [Enter])</li>
          <li>
            Type the following line into the command prompt window exactly as shown:
            <p><code>setx HOME "%USERPROFILE%"</code></p>
          </li>
          <li>Press [Enter], you should see <code>SUCCESS: Specified value was saved.</code></li>
          <li>Quit command prompt by typing <code>exit</code> then pressing [Enter]</li>
        </ol>
      </li>
    </ol>
    <p>This will provide you with both Git and Bash in the Git Bash program.</p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="shell-macos">
    <p>
      The default shell in all versions of macOS is Bash, so no
      need to install anything.  You access Bash from the Terminal
      (found in
      <code>/Applications/Utilities</code>).
      See the Git installation <a href="https://www.youtube.com/watch?v=9LQhwETCdwY ">video tutorial</a>
      for an example on how to open the Terminal.
      You may want to keep
      Terminal in your dock for this workshop.
    </p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="shell-linux">
    <p>
      The default shell is usually Bash, but if your
      machine is set up differently you can run it by opening a
      terminal and typing <code>bash</code>.  There is no need to
      install anything.
    </p>
  </article>
</div>
{% comment %} End of 'shell' section. {% endcomment %}
{% comment %} Start of 'Git' section. GitHub browser compatibility is given at https://help.github.com/articles/supported-browsers/{% endcomment %}

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.

<div class="tab-content">
  <article role="tabpanel" class="tab-pane active" id="git-windows">
    <p>
      Git should be installed on your computer as part of your Bash
      install (described above).
    </p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="git-macos">
    <a href="https://www.youtube.com/watch?v=9LQhwETCdwY ">Video Tutorial</a>
    <p>
      <strong>For OS X 10.9 and higher</strong>, install Git for Mac
      by downloading and running the most recent "mavericks" installer from
      <a href="http://sourceforge.net/projects/git-osx-installer/files/">this list</a>.
      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 <code>/Applications</code> folder,
      as Git is a command line program.
      <strong>For older versions of OS X (10.5-10.8)</strong> use the
      most recent available installer labelled "snow-leopard"
      <a href="http://sourceforge.net/projects/git-osx-installer/files/">available here</a>.
    </p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="git-linux">
    <p>
      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
      <code>sudo apt-get install git</code> and for Fedora run
      <code>sudo dnf install git</code>.
    </p>
  </article>
</div>
{% comment %} End of 'Git' section. {% endcomment %}
{% comment %} Start of 'editor' section. {% endcomment %}

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.

<div class="tab-content">
  <article role="tabpanel" class="tab-pane active" id="editor-windows">
    <p>
      nano is a basic editor and the default that instructors use in the workshop.
      It is installed along with Git.
    </p>
    <p>
      Others editors that you can use are
      <a href="https://notepad-plus-plus.org/">Notepad++</a> or
      <a href="https://www.sublimetext.com/">Sublime Text</a>.
      <strong>Be aware that you must
        add its installation directory to your system path.</strong>
      Please ask your instructor to help you do this.
    </p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="editor-macos">
    <p>
      nano is a basic editor and the default that instructors use in the workshop.
      See the Git installation <a href="https://www.youtube.com/watch?v=9LQhwETCdwY ">video tutorial</a>
      for an example on how to open nano.
      It should be pre-installed.
    </p>
    <p>
      Others editors that you can use are
      <a href="https://www.barebones.com/products/bbedit/">BBEdit</a> or
      <a href="https://www.sublimetext.com/">Sublime Text</a>.
    </p>
  </article>
  <article role="tabpanel" class="tab-pane active" id="editor-linux">
    <p>
      nano is a basic editor and the default that instructors use in the workshop.
      It should be pre-installed.
    </p>
    <p>
      Others editors that you can use are
      <a href="https://wiki.gnome.org/Apps/Gedit">Gedit</a>,
      <a href="https://kate-editor.org/">Kate</a> or
      <a href="https://www.sublimetext.com/">Sublime Text</a>.
    </p>
  </article>
</div>
{% comment %} End of 'editor' section. {% endcomment %}
{% comment %} Start of 'Python' section. Remove the third paragraph if the workshop will teach Python using something other than the Jupyter notebook. Details at https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility {% endcomment %}

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 Anaconda, an all-in-one installer.

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

We will teach Python using Jupyter Lab, a programming IDE that runs in a web browser. For this to work you will need a reasonably up-to-date browser; the latest versions of Chrome, Firefox, and Safari ought to work. You may try Jupyter Lab by following the installation instructions in the link above, or by referencing those in the .

<div class="tab-content">
  <article role="tabpanel" class="tab-pane active" id="python-windows">
    <a href="https://www.youtube.com/watch?v=xxQ0mzZ8UvA">Video Tutorial</a>
    <ol>
      <li>Open <a href="https://www.anaconda.com/download/#windows">https://www.anaconda.com/download/#windows</a> with your web browser.</li>
      <li>Download the Python 3 installer for Windows.</li>
      <li>Install Python 3 using all of the defaults for installation <em>except</em> make sure to check <strong>Add Anaconda to my PATH environment variable</strong>.</li>
    </ol>
  </article>
  <article role="tabpanel" class="tab-pane active" id="python-macos">
    <a href="https://www.youtube.com/watch?v=TcSAln46u9U">Video Tutorial</a>
    <ol>
      <li>Open <a href="https://www.anaconda.com/download/#macos">https://www.anaconda.com/download/#macos</a> with your web browser.</li>
      <li>Download the Python 3 installer for OS X.</li>
      <li>Install Python 3 using all of the defaults for installation.</li>
    </ol>
  </article>
  <article role="tabpanel" class="tab-pane active" id="python-linux">
    <ol>
      <li>Open <a href="https://www.anaconda.com/download/#linux">https://www.anaconda.com/download/#linux</a> with your web browser.</li>
      <li>Download the Python 3 installer for Linux.<br>
        (The installation requires using the shell. If you aren't
        comfortable doing the installation yourself
        stop here and request help at the workshop.)
      </li>
      <li>
        Open a terminal window.
      </li>
      <li>
        Type <pre>bash Anaconda3-</pre> and then press
        <kbd>Tab</kbd>. The name of the file you just downloaded should
        appear. If it does not, navigate to the folder where you
        downloaded the file, for example with:
        <pre>cd Downloads</pre>
        Then, try again.
      </li>
      <li>
        Press <kbd>Return</kbd>. You will follow the text-only prompts. To move through
        the text, press <kbd>Spacebar</kbd>. Type <code>yes</code> and
        press enter to approve the license. Press enter to approve the
        default location for the files. Type <code>yes</code> and
        press enter to prepend Anaconda to your <code>PATH</code>
        (this makes the Anaconda distribution the default Python).
      </li>
      <li>
        Close the terminal window.
      </li>
    </ol>
  </article>
</div>
{% comment %}

Once you are done installing the software listed above, please go to this page, which has instructions on how to test that everything was installed correctly.

{% endcomment %}
{% comment %} End of 'Python' section. {% endcomment %}