diff --git a/_config.yml b/_config.yml index 22fd1c6..b25b206 100644 --- a/_config.yml +++ b/_config.yml @@ -41,7 +41,7 @@ curriculum: "swc-gapminder" # value of the variable below ("flavor") to get the schedule and installation # instructions updated accordingly (valid values are 'r' or 'python'). # Note: this is only for Data Carpentry and SWC at this time. -flavor: "r" +flavor: "python" # If the workshop will be a lesson pilot (for a new official lesson or # a lesson in The Carpentries Incubator), set pilot to "true" @@ -53,14 +53,14 @@ pilot: true # Most workshops don't use extra pages. More information about extra # pages are included in the README: # https://github.com/carpentries/workshop-template#creating-extra-pages -title: "UM Software Carpentry Workshop" +title: "UM Software Carpentry Workshop - Python pilot" #------------------------------------------------------------ # Incubator workshop settings (only relevant for workshops teaching a lesson # in The Carpentries Incubator). # # For an Incubator workshop, uncomment the line below and add the URL of the lesson site. -incubator_lesson_site: "https://umcarpentries.org/intro-curriculum-r/" +incubator_lesson_site: "https://umcarpentries.org/intro-curriculum-python/" # # For an Incubator workshop, uncomment the line below and add the URL of your pre-workshop survey # incubator_pre_survey: "put the URL of your pre-workshop survey here" diff --git a/_includes/install_instructions/git.html b/_includes/install_instructions/git.html index c9aa469..066537f 100644 --- a/_includes/install_instructions/git.html +++ b/_includes/install_instructions/git.html @@ -17,7 +17,8 @@

Git

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 + Before signing up, you may want to review this short list of GitHub username advice. + Please also 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. @@ -33,7 +34,7 @@

Git

- Git should be installed on your computer as part of your Bash + Git should be installed on your computer as part of your Git for Windows install (see the Shell installation instructions).

diff --git a/_includes/install_instructions/python.html b/_includes/install_instructions/python.html index cf80ab8..19fc308 100644 --- a/_includes/install_instructions/python.html +++ b/_includes/install_instructions/python.html @@ -1,41 +1,38 @@ {% comment %} Remove the third paragraph if the workshop will teach Python -using something other than the Jupyter Notebook. Details at +using something other than the JupyterLab. Details at -https://jupyter-notebook.readthedocs.io/en/stable/notebook.html#browser-compatibility +https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html#supported-browsers {% 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). + Python is a popular general-purpose programming language. + Installing Python and its scientific packages individually can be a bit difficult, so we recommend + Anaconda, + a Python distribution bundled with common scientific packages and other popular tools.

{% comment %} Please remove or comment out this paragraph using or {% comment %} and {% endcomment %} - if you do not plan to use Jupyter Notebook environment. + if you do not plan to use JupyterLab environment. {% endcomment %}

- We will teach Python using the Jupyter Notebook, - a programming environment that runs in a web browser (Jupyter Notebook will be installed by Anaconda). 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). + We will teach Python using JupyterLab, + a programming environment that runs in a web browser. For this to work you will need a reasonably + up-to-date web browser. The latest versions of the Chrome, Safari and Firefox browsers are all + supported. + Note you do not need to install JupyterLab separately as it comes pre-installed with Anaconda. +

+ +

+ Note if you have already installed Anaconda previously, you don't need to install it again for this workshop. + However, you do need to make sure your Python libraries meet the version requirements for this workshop by running the provided check_setup.ipynb file. + If a library does not meet a version requirement, + you can run pip install library_name --upgrade in your command window (i.e., Anaconda Prompt for windows and Terminal for MacOS/Linux) to upgrade the library.

@@ -48,34 +45,41 @@

Python

    -
  1. Open https://www.anaconda.com/products/individual#download-section with your web browser.
    2. -
  2. Download the Anaconda for Windows installer with Python 3. (If you are not sure which version to choose, you probably want the 64-bit Graphical Installer Anaconda3-...-Windows-x86_64.exe)
    3. -
  3. Install Python 3 by running the Anaconda Installer, using all of the defaults for installation except make sure to check Add Anaconda to my PATH environment variable.
    4. +
  4. Open https://www.anaconda.com/download with your web browser.
    5. +
  5. Download the Anaconda for Windows installer.
    6. +
  6. Run the Anaconda Installer, using all of the defaults for installation except make sure to check Make Anaconda the default Python.
    7. +
  7. Once Anaconda is installed, launch the Anaconda Prompt by going to the Windows search bar, type in anaconda prompt, and press Enter.
    8. +
  8. In the Anaconda Prompt type jupyter lab and press Enter. This will open JupyterLab in your browser.
    9. +
-

Video Tutorial

+ Note: To keep the JupyterLab running, do not close the command line window (you can minimize it), as it works as JupterLab's "local host server". +
    -
  1. Open https://www.anaconda.com/products/individual#download-section with your web browser.
    2. -
  2. Download the Anaconda Installer with Python 3 for macOS (you can either use the Graphical or the Command Line Installer).
    3. -
  3. Install Python 3 by running the Anaconda Installer using all of the defaults for installation.
    4. +
  4. Open https://www.anaconda.com/download with your web browser.
    5. +
  5. Download the Anaconda Installer for macOS. You may need to choose an installer between an Intel-chip Mac and Apple silicon (e.g., M1/M2) Mac.
    6. +
  6. Run the Anaconda Installer, using all of the defaults for installation except make sure to check Make Anaconda the default Python.
    7. +
  7. Once Anaconda is installed, type jupyter lab in your Terminal and press Return. This will open JupyterLab in your browser.
    8. +
-

Video Tutorial

+ Note: To keep the JupyterLab running, do not close the command line window (you can minimize it), as it works as JupterLab's "local host server". +
    -
  1. Open https://www.anaconda.com/products/individual#download-section with your web browser.
    2. -
  2. Download the Anaconda Installer with Python 3 for Linux.
    +
  3. Open https://www.anaconda.com/download with your web browser.
    4. +
  4. Download the Anaconda 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.) @@ -103,11 +107,11 @@

    Video Tutorial

    to prepend Anaconda to your PATH (this makes the Anaconda distribution the default Python).
    5. -
  5. - Close the terminal window. -
    6. +
  6. Once Anaconda is installed, type jupyter lab in your Terminal and press Return. This will open JupyterLab in your browser.
    7. +
+ Note: To keep the JupyterLab running, do not close the command line window (you can minimize it), as it works as JupterLab's "local host server".
-
+
\ No newline at end of file diff --git a/_includes/install_instructions/shell.html b/_includes/install_instructions/shell.html index 93aa872..58e9580 100644 --- a/_includes/install_instructions/shell.html +++ b/_includes/install_instructions/shell.html @@ -1,7 +1,7 @@
-

The Bash Shell

+

The Unix Shell

- Bash is a commonly-used shell that gives you the power to do + The Unix shell is a command-line interface that gives you the power to do tasks more quickly.

@@ -106,23 +106,23 @@

Video Tutorial

- 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 + The default shell in newer versions of macOS is Z shell, also known as zsh, and + it comes pre-installed with your MacOS. + You access shell 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.

-

+

- If you want to change your default shell, see - this Apple Support article and follow the instructions on "How to change your default shell". + If you use an earlier version of MacOS with a different shell, see + this Apple Support article and follow the instructions on how to make zsh the default shell.

Video Tutorial

diff --git a/_includes/swc/schedule.html b/_includes/swc/schedule.html index 3f70810..54ed20d 100644 --- a/_includes/swc/schedule.html +++ b/_includes/swc/schedule.html @@ -2,11 +2,11 @@

Day 1

- + - + - + @@ -17,15 +17,15 @@

Day 1

Day 2

Before Pre-workshop survey
09:00 Welcome to the workshop
09:15 R for Plotting
09:15 Python for Plotting
10:30 Morning break
10:45 R for Plotting (Continued)
10:45 Python for Plotting (Continued)
12:00 Lunch break
13:00 The Unix Shell
14:15 Afternoon break
- + - + - + - + - +
09:00 R for Data Analysis
09:00 Python for Data Analysis
10:30 Morning break
10:45 R for Data Analysis (Continued)
10:45 Python for Data Analysis (Continued)
12:00 Lunch break
13:00 Writing Reports with R Markdown
13:00 Jupyter Notebook and Markdown
14:30 Afternoon break
14:45 Writing Reports with R Markdown (Continued)
14:45 Jupyter Notebook and Markdown (Continued)
15:30 Conclusions & Wrap-up
16:15 Post-workshop Survey
16:30 END
diff --git a/index.md b/index.md index b873616..3d57962 100644 --- a/index.md +++ b/index.md @@ -7,18 +7,18 @@ venue: "University of Michigan" # brief name of the institution that host address: "You'll find out once you send your installation materials" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online' country: "us" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop -latitude: "42.28332637651782" # decimal latitude of workshop venue (use https://www.latlong.net/) -longitude: "-83.73405181877277" # decimal longitude of the workshop venue (use https://www.latlong.net) -humandate: "December 13-14, 2023" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020") +latitude: "42.276527" # decimal latitude of workshop venue (use https://www.latlong.net/) +longitude: "-83.738180" # decimal longitude of the workshop venue (use https://www.latlong.net) +humandate: "December 1, 2023" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020") humantime: "9:00 am - 4:30 pm EST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)" -startdate: 2023-12-13 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01 -enddate: 2023-12-14 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02 -instructor: ["Jason Tallant", "Richie Hodel", "Sarah Arcos"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"] -helper: ["Lisa Levinson", "Allison Mason"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"] -email: ["pschloss@umich.edu"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["marlyn.wescoff@example.org", "fran.bilas@example.org", "ruth.lichterman@example.org"] -collaborative_notes: https://pad.carpentries.org/2023-12-13-umich # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2023-10-12-umich) -eventbrite: "757862245377" # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used) -material: "R for Plotting, The Unix Shell, Intro to git & GitHub, R for Data Analysis, Writing Reports with R Markdown" +startdate: 2023-12-01 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01 +enddate: 2023-12-01 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02 +instructor: ["Fred Feng", " Pariksheet Nanda"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"] +helper: ["Gandhimathi Padmanaban", "Rayane Moustafa"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"] +email: ["fredfeng@umich.edu"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["marlyn.wescoff@example.org", "fran.bilas@example.org", "ruth.lichterman@example.org"] +collaborative_notes: https://pad.carpentries.org/2023-12-01-umich # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2023-10-12-umich) +eventbrite: "000" # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used) +material: "Python for Plotting, The Unix Shell, Intro to git & GitHub, Python for Data Analysis, Jupyter Notebook and Markdown" --- {% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %} @@ -54,7 +54,8 @@ This block includes the Eventbrite registration widget if 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 %} + +

General Information

@@ -162,7 +163,7 @@ Modify the block below if there are any special requirements. Requirements: {% if online == "false" %} Participants must bring a laptop with a - Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. + Mac, Windows, or Linux operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. {% else %} Participants must have access to a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. @@ -313,8 +314,8 @@ in `_config.yml` or, if this workshop is teaching a lesson in the Incubator, change the value of `carpentry` to `incubator`.
{% else %} -

Pre-workshop Survey

-

Post-workshop Survey

+ {% endif %}