Merge branch 'gh-pages' of github.com:datacarpentry/geospatial-workshop into gh-pages

fmichonneau · fmichonneau · commit ee3cda45a4c2 · 2019-06-28T14:32:08.000+02:00
diff --git a/_config.yml b/_config.yml
@@ -10,7 +10,7 @@
 carpentry: "dc"
 
 # Overall title for pages.
-title: "Data Carpentry Geospatial Workshop"
+title: "Geospatial Workshop Overview"
 
 # Life cycle stage of the lesson
 # possible values: "pre-alpha", "alpha", "beta", "stable"
diff --git a/_extras/guide.md b/_extras/guide.md
@@ -2,4 +2,29 @@
 layout: page
 title: "Instructor Notes"
 ---
-FIXME
+## Instructor notes
+
+## Workshop Structure
+
+The following table provides the structure for the Geospatial Workshop and *estimated* timings for each lesson.
+
+| Lesson  | Length  | Include if: |
+|---|---|---|
+| [Introduction to Geospatial Concepts](https://datacarpentry.org/organization-geospatial/) ([instructor notes](https://datacarpentry.org/organization-geospatial/guide/index.html))   | **75 minutes** - estimated, will not be accurate  | Learners have no experience with geospatial data.  |
+| [Introduction to R for Geospatial Data](https://datacarpentry.org/r-intro-geospatial/) ([instructor notes](https://datacarpentry.org/r-intro-geospatial/guide/index.html))  | **4 hours** - estimated, will not be accurate  | Learners have no experience with R.  |
+| [Introduction to Geospatial Raster and Vector Data with R](https://datacarpentry.org/r-raster-vector-geospatial/) ([instructor notes](https://datacarpentry.org/r-raster-vector-geospatial/guide/index.html))  | **7 hours** - estimated, will not be accurate  | Always.  |
+
+If the workshop audience is experienced in both R and geospatial concepts, this workshop could theoretically be taught in one day. However, note that these timings are estimates and we are relying on feedback from pilot workshop Instructors to add accurate timing information.
+
+[Instructors: add information about timing and selecting materials as these workshops are piloted]
+
+## Technical tips and tricks
+
+#### Installation
+- For the [Introduction to Geospatial Raster and Vector Data with R](https://datacarpentry.org/r-raster-vector-geospatial/) lesson, learners MUST download the data and install the software before the workshop. The data set is large (>150 Mb) and there are numerous software packages and R libraries to install. **Remind your learners multiple times!**
+  - Instructions to download data and set up a machine to analyze and process geospatial data: http://datacarpentry.org/geospatial-workshop/setup.html
+- You may find it helpful to host an "install party" prior to your workshop where you and your co-instructors help learners install the necessary software for the workshop. If this is unfeasible, leave time at the beginning of your workshop to ensure that learners have necessary geospatial software (GDAL, GEOS, PROJ.4) installed prior to teaching the course.
+
+[Instructors: add information about supporting learners with installation here]
+
+## Common problems
diff --git a/index.md b/index.md
@@ -5,6 +5,12 @@ root: .
 
 Data Carpentry's aim is to teach researchers basic concepts, skills, and tools for working with data so that they can get more done in less time, and with less pain. 
 
+
+Interested in teaching these materials? We have an [onboarding video](https://www.youtube.com/watch?v=Qtnb_eeHt7E) available to prepare Instructors to teach these lessons. After
+watching this video, please contact [team@carpentries.org](mailto:team@carpentries.org) so that we can record your status as an onboarded
+Instructor. Instructors who have completed onboarding will be given priority status for teaching at centrally-organized Data Carpentry Geospatial workshops.
+
+
 > ## Getting Started
 >
 > Data Carpentry’s teaching is hands-on, so participants are encouraged to use 
diff --git a/setup.md b/setup.md
@@ -5,14 +5,14 @@ title: Setup
 
 # Overview
 
-This workshop is designed to be run on your local machine. First, you will need to download the data we use in the workshop. Then, you need to set up your machine to analyze and process geospatial data. We provide below instructions to either install all components manually (option A), or to use a Docker image that provides all the software and dependencies needed (option B).
+This workshop is designed to be run on your local machine. First, you will need to download the data we use in the workshop. Then, you need to set up your machine to analyze and process geospatial data. We provide instructions below to either install all components manually (option A), or to use a Docker image that provides all the software and dependencies needed (option B).
 
 ## Data
 
-You can download all of the data used in this workshop by clicking 
-[this download link](https://ndownloader.figshare.com/articles/2009586/versions/10). 
+You can download all of the data used in this workshop by clicking
+[this download link](https://ndownloader.figshare.com/articles/2009586/versions/10).
 Clicking the download link will automatically download all of the files to your default download directory as a single compressed
-(`.zip`) file. To expand this file, double click the folder icon in your file navigator application (for Macs, this is the Finder 
+(`.zip`) file. To expand this file, double click the folder icon in your file navigator application (for Macs, this is the Finder
 application).
 
 For a full description of the data used in this workshop see the [data page](data).
@@ -30,7 +30,7 @@ For a full description of the data used in this workshop see the [data page](dat
 | [RStudio](https://www.rstudio.com) | [Link](https://www.rstudio.com/products/rstudio/download/#download) | | Linux, MacOS, Windows | GUI for R |
 | [UDUNITS](https://www.unidata.ucar.edu/software/udunits/) | [Link](https://www.unidata.ucar.edu/downloads/udunits/index.jsp) | [Link](https://www.unidata.ucar.edu/software/udunits/#documentation) | Linux, MacOS, Windows | Unit conversions |
 
-We provide below quick instructions for installing the various software needed for this workshop. At points, they assume familiarity with the command line and with installation in general. As there are different operating systems and many different versions of operating systems and environments, these may not work on your computer. If an installation doesn't work for you, please refer to the installation instructions for that software, listed in the table above.
+We provide quick instructions below for installing the various software needed for this workshop. At points, they assume familiarity with the command line and with installation in general. As there are different operating systems and many different versions of operating systems and environments, these may not work on your computer. If an installation doesn't work for you, please refer to the installation instructions for that software listed in the table above.
 
 
 ### GDAL, GEOS, and PROJ.4
@@ -46,14 +46,14 @@ The installation of the geospatial libraries GDAL, GEOS, and PROJ.4 varies signi
 > ## macOS
 >
 > For participants who do not already have [homebrew](https://brew.sh) installed, and who may be less comfortable with the command line, the easiest was to obtain the geospatial libraries is to install the latest version of [Kyng Chaos's pre-built package](http://www.kyngchaos.com/software/frameworks) for GDAL Complete. Be aware that several other libraries are also installed, including the UnixImageIO, SQLite3, and `NumPy`.
-> 
-> After downloading the package in the link above, you will need to double-click the 
+>
+> After downloading the package in the link above, you will need to double-click the
 > cardbord box icon to complete the installation. Depending on your security settings,
-> you may get an error message about "unidentified developers". You can enable the 
+> you may get an error message about "unidentified developers". You can enable the
 > installation by following [these instructions](https://kb.wisc.edu/page.php?id=25443)
 > for installing programs from
-> unidentified developers. 
-> 
+> unidentified developers.
+>
 > Alternatively, participants who are comfortable with the command line can install the geospatial libraries individually using [homebrew](https://brew.sh):
 >
 >~~~
@@ -94,7 +94,7 @@ The installation of the geospatial libraries GDAL, GEOS, and PROJ.4 varies signi
 >~~~
 >{: .language-bash}
 >
-> For **Debian**: The [rocker geospatial](https://github.com/rocker-org/geospatial) Dockerfiles may be helpful. Ubuntu Dockerfiles are found [here](https://github.com/r-spatial/sf/tree/master/inst/docker).
+> For **Debian**: The [rocker geospatial](https://github.com/rocker-org/geospatial) Dockerfiles may be helpful. Ubuntu Dockerfiles are found [here](https://github.com/r-spatial/sf/tree/master/inst/docker). These may be helpful to get an idea of the commands needed to install the necessary dependencies.
 >
 {: .solution}
 
@@ -160,8 +160,7 @@ Participants who do not already have `R` installed should download and install i
 {: .solution}
 
 ### RStudio
-RStudio is an GUI for using R that is available for Windows, macOS, and various Linux operating systems. It can be downloaded [here](https://www.rstudio.com/products/rstudio/download/). You will need the **free** Desktop version for your computer.
-
+RStudio is a GUI for using `R` that is available for Windows, macOS, and various Linux operating systems. It can be downloaded [here](https://www.rstudio.com/products/rstudio/download/). You will need the **free** Desktop version for your computer. *In order to address issues with `ggplot2`, learners and instructors should run a recent version of RStudio (v1.2 or greater).*
 
 ### R Packages
 
@@ -176,7 +175,7 @@ The following `R` packages are used in the various geospatial lessons.
 * [`sf`](https://cran.r-project.org/package=sf)
 
 To install these packages in RStudio, do the following:  
-1\. Open RStudio by double-clicking the RStudio application icon. You should see 
+1\. Open RStudio by double-clicking the RStudio application icon. You should see
 something like this:
 
 ![RStudio layout](/fig/01-rstudio.png)
@@ -204,7 +203,7 @@ downloaded 3.4 MB
 ~~~
 {: .output}
 
-When the installation is complete, you will see a status message like: 
+When the installation is complete, you will see a status message like:
 
 ~~~
 The downloaded binary packages are in
@@ -218,13 +217,13 @@ You are now ready for the workshop!
 
 [Docker](https://www.docker.com) provides developers with a means for creating interactive [containers](https://docs.docker.com/glossary/?term=container) that contain pre-installed software. A selection of pre-installed software in Docker is called an [image](https://docs.docker.com/glossary/?term=image). An image can be downloaded and used to create a local container, allowing end-users to get software up and running quickly. This is particularly useful when a local installation of the software could be complex and time consuming. For `R` users, a Docker image can be used to create a virtual installation of `R` and RStudio that can be run through your web browser.
 
-Option B involves downloading an Docker image that contains an installation of `R`, RStudio Server, all of the necessary dependencies listed above, and almost all of the `R` packages used in the geospatial lessons. You will need to install the appropriate version of Docker's Community Edition software and then download and use the `rocker/geospatial` Docker image to create a container that will allow you to use `R`, RStudio, and all the required GIS tools without installing any of them locally.
+This option involves downloading an Docker image that contains an installation of `R`, RStudio Server, all of the necessary dependencies listed above, and almost all of the `R` packages used in the geospatial lessons. You will need to install the appropriate version of Docker's Community Edition software and then download and use the `rocker/geospatial` Docker image to create a container that will allow you to use `R`, RStudio, and all the required GIS tools without installing any of them locally.
 
 Once up and running - you'll have full access to RStudio right from your browser:
 
 ![](/fig/docker.png)
 
-Please be aware that the `R` package `rasterVis` is not included in the `rocker/geospatial` Docker image. If your instructor teaches with this package, this will be an `R` package you will need to install yourself. All other `R` packages will already be installed for you.
+Please be aware that the `R` package `rasterVis` is not included in the `rocker/geospatial` Docker image. If your instructor teaches with this package then you will need to install this `R` package yourself. All other `R` packages will already be installed for you.
 
 > ## Downloading and Installing Docker Community Edition
 >
@@ -253,7 +252,7 @@ Please be aware that the `R` package `rasterVis` is not included in the `rocker/
 > When `docker run` is used, you can specify a folder on your computer to become accessible inside your RStudio Server instance. The following `docker run` command exposes Jane's `GitHub` directory to RStudio Server. Enter the file path where your workshop resources and data are stored:
 >
 >~~~
->$ docker run -d -P --name gis /Users/jane/GitHub:/home/rstudio/GitHub rocker/geospatial
+>$ docker run -d -P --name gis -v /Users/jane/GitHub:/home/rstudio/GitHub -e PASSWORD=mypass rocker/geospatial
 >~~~
 >{: .language-bash}
 >
@@ -266,7 +265,7 @@ Please be aware that the `R` package `rasterVis` is not included in the `rocker/
 >~~~
 >{: .language-bash}
 >
-> An output, for example, of `8787/tcp -> 0.0.0.0:32768` would indicate that you should point your browser to `http://localhost:32768/`. If prompted, enter `rstudio` for both the username and the password.
+> An output, for example, of `8787/tcp -> 0.0.0.0:32768` would indicate that you should point your browser to `http://localhost:32768/`. If prompted, enter `rstudio` for the username and the password provided in the `docker run` command above (`mypass` in the example above).
 >
 > #### Stopping a Container
 > When you are done with a Docker session, make sure all of your files are saved locally on your computer **before closing your browser and Docker**. Once you have ensured all of your files are available (they should be saved at the file path designated in `docker run` above), you can stop your Docker container in the terminal:
