| layout | carpentry | venue | address | country | language | latlng | humandate | humantime | startdate | enddate | instructor | helper | collaborative_notes | eventbrite | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workshop |
swc |
Software Carpentry @ UW-Madison |
Sterling Hall, room 2425 |
US |
EN |
43.074437,-89.405801 |
June 6-7, 2018 |
8:30 am - 4:30 pm |
2018-06-06 |
2018-06-07 |
|
|
45450254936 |
{% 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 %}
Registration is required and will be available here starting May 9, 2018 at 5 pm. Make sure to read all details below before registering and to choose appropriately between UW-Madison's Data Carpentry and Software Carpentry workshops.
{% 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="248px" scrolling="auto"> </iframe> {% endif %}{% 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 http://itouchmap.com/latlong.html to find the lat/long of an address. {% endcomment %} {% if page.latlng %}
Where: {{page.address}}. Get directions with OpenStreetMap or Google Maps.
{% 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 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 {% if page.carpentry == "swc" %} Software Carpentry's {% elsif page.carpentry == "dc" %} Data Carpentry's {% elsif page.carpentry == "lc" %} Library Carpentry's {% endif %} Code of Conduct.
{% 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. 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.
{% 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 %}
{% if page.carpentry == "swc" %}
Please be sure to complete these surveys before and after the workshop.
{% elsif page.carpentry == "dc" %}Please be sure to complete these surveys before and after the workshop.
{% elsif page.carpentry == "lc" %}Ask your instructor about pre- and post-workshop Survey details.
{% 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 %}
{% 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.software-carpentry.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.
- If your workshop is R rather than Python, remove the comment around that section and put a comment around the Python section.
- Some workshops will delete SQL.
- Please make sure the list of topics is synchronized with what you intend to teach.
- 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 %}
{% 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 %}
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 will use both terminal ("shell" or "command-line" interface) and GUI text editors at different times in the workshop, so pay careful attention to the text editors that are available for your system (several are listed below) and make sure that you are using at least one terminal and one GUI editor with which you are comfortable. Above all else, your GUI text editor must save documents as plain text (UTF-8 encoding).
We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the SWC Configuration Problems and Solutions wiki page.
Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.
- Download the Git for Windows installer.
- Run the installer and follow the steps. Be sure to look for the following options:
-
{% comment %} Git 2.8.2 Setup {% endcomment %}
{% comment %} Information {% endcomment %}
- Keep "Use Git from the Windows Command Prompt" selected. 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. {% comment %} Choosing the SSH executable {% endcomment %}
- Keep "Checkout Windows-style, commit Unix-style line endings" selected. {% comment %} Configuring the terminal emulator to use with Git Bash {% endcomment %}
- Keep "Use Windows' default console window" selected. {% comment %} Configuring experimental performance tweaks {% endcomment %}
- Click on "Install". {% comment %} Installing {% endcomment %} {% comment %} Completing the Git Setup Wizard {% endcomment %}
-
If your "HOME" environment variable is not set (or you don't know what this is):
- Open command prompt (Open Start Menu then type
cmdand 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
exitthen 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 all versions of macOS is Bash, 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.
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.
For OS X 10.9 and higher, install Git for Mac
by downloading and running the most recent "mavericks" installer from
this list.
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.
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. These are often GUI editors that save
documents in plain text format, with several listed below for each
platform. In the terminal window, the default text editor on macOS and
Linux is usually set to Vim ("vi"), 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. Instructors
will often use the nano editor in the terminal window, which is a little
easier to use when just starting out.
nano is a basic terminal-based text editor and the default that instructors use in the workshop. To install it, download the {% if page.carpentry == "swc" %} Software Carpentry {% elsif page.carpentry == "dc" %} Data Carpentry {% elsif page.carpentry == "lc" %} Library Carpentry {% endif %} Windows installer and double click on the file to run it. This installer requires an active internet connection.
A number of GUI editors are available for Windows including Notepad++, Komodo Edit, and 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 terminal-based text 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 in the Linux distribution that underlies the macOS.
A number of GUI editors are available for macOS including Text Wrangler (formerly BBEdit), Sublime Text, Atom, and Geany.
nano is a basic editor and the default that instructors use in the workshop. It should be pre-installed as a part of your Linux distribution.
A number of GUI editors are available for Linux including Gedit, Kate, Geany, Sublime Text, and Atom.
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.
<p>
Regardless of how you choose to install it,
<strong>please make sure you install Python version 3.x</strong>
(e.g., 3.6 is fine).
</p>
<p>
We will teach Python using the <a href="https://jupyter.org/">Jupyter notebook</a>,
a programming environment that runs in a web browser. 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
<a href="https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility">supported</a>
(some older browsers, including Internet Explorer version 9
and below, are not).
</p>
- Open https://www.anaconda.com/download/#windows with your web browser.
- Download the Python 3 installer for Windows.
- During installation for Python 3 check the box Add Anaconda to my PATH environment variable.
- Anaconda does not require administrative priviliges on your computer. A recent update to the Anaconda installer may include the option to install one or more components of Microsoft Visual Studio, which will require administrative privileges if yours is a shared computer. If you do have such access, Visual Studio offers an integrated development environment for your programming activities, but we will not be using it in the SWC workshop time.
- Open https://www.anaconda.com/download/#macos with your web browser.
- Download the Python 3 installer for OS X.
- Install Python 3 using all of the defaults for installation.
- Open https://www.anaconda.com/download/#linux with your web browser.
- Download the Python 3 installer for Linux.
(The installation 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.
-
Type
bash Anaconda3-
and then press tab. 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:cd Downloads
Then, try again. -
Press enter. You will follow the text-only prompts. To move through
the text, press the space key. Type
yesand press enter to approve the license. Press enter to approve the default location for the files. Typeyesand press enter to prepend Anaconda to yourPATH(this makes the Anaconda distribution the default Python). - Close the terminal window.
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 %}