Skip to content

Commit 4a18147

Browse files
zkamvarCarpentries Apprentice
authored andcommitted
[custom] fix lesson contents
1 parent 3d923d4 commit 4a18147

7 files changed

Lines changed: 59 additions & 56 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ we pledge to follow the [The Carpentries Code of Conduct][coc].
88
Instances of abusive, harassing, or otherwise unacceptable behavior
99
may be reported by following our [reporting guidelines][coc-reporting].
1010

11-
12-
[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
1311
[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html
12+
[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
13+
14+
15+

CONTRIBUTING.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ mistake, some awkward wording, or a factual error. This is a good way to
2121
introduce yourself and to meet some of our community members.
2222

2323
1. If you do not have a [GitHub][github] account, you can [send us comments by
24-
email][contact]. However, we will be able to respond more quickly if you use
25-
one of the other methods described below.
24+
email][contact]. However, we will be able to respond more quickly if you use
25+
one of the other methods described below.
2626

2727
2. If you have a [GitHub][github] account, or are willing to [create
28-
one][github-join], but do not know how to use Git, you can report problems
29-
or suggest improvements by [creating an issue][repo-issues]. This allows us
30-
to assign the item to someone and to respond to it in a threaded discussion.
28+
one][github-join], but do not know how to use Git, you can report problems
29+
or suggest improvements by [creating an issue][repo-issues]. This allows us
30+
to assign the item to someone and to respond to it in a threaded discussion.
3131

3232
3. If you are comfortable with Git, and would like to add or change material,
33-
you can submit a pull request (PR). Instructions for doing this are
34-
[included below](#using-github). For inspiration about changes that need to
35-
be made, check out the [list of open issues][issues] across the Carpentries.
33+
you can submit a pull request (PR). Instructions for doing this are
34+
[included below](#using-github). For inspiration about changes that need to
35+
be made, check out the [list of open issues][issues] across the Carpentries.
3636

3737
Note: if you want to build the website locally, please refer to [The Workbench
3838
documentation][template-doc].
@@ -41,8 +41,7 @@ documentation][template-doc].
4141

4242
1. If you wish to change this lesson, add issues and pull requests here.
4343
2. If you wish to change the template used for workshop websites, please refer
44-
to [The Workbench documentation][template-doc].
45-
44+
to [The Workbench documentation][template-doc].
4645

4746
### What to Contribute
4847

@@ -80,12 +79,12 @@ Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
8079
use [GitHub flow][github-flow] to manage changes:
8180

8281
1. Create a new branch in your desktop copy of this repository for each
83-
significant change.
82+
significant change.
8483
2. Commit the change in that branch.
8584
3. Push that branch to your fork of this repository on GitHub.
8685
4. Submit a pull request from that branch to the [upstream repository][repo].
8786
5. If you receive feedback, make changes on your desktop and push to your
88-
branch on GitHub: the pull request will update automatically.
87+
branch on GitHub: the pull request will update automatically.
8988

9089
NB: The published copy of the lesson is usually in the `main` branch.
9190

@@ -98,26 +97,26 @@ final say over what gets merged into the lesson.
9897
The Carpentries is a global organisation with volunteers and learners all over
9998
the world. We share values of inclusivity and a passion for sharing knowledge,
10099
teaching and learning. There are several ways to connect with The Carpentries
101-
community listed at <https://carpentries.org/connect/> including via social
100+
community listed at [https://carpentries.org/connect/](https://carpentries.org/connect/) including via social
102101
media, slack, newsletters, and email lists. You can also [reach us by
103102
email][contact].
104103

105-
[repo]: https://example.com/FIXME
106-
[repo-issues]: https://example.com/FIXME/issues
107-
[contact]: mailto:team@carpentries.org
108104
[cp-site]: https://carpentries.org/
109-
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
110-
[dc-lessons]: https://datacarpentry.org/lessons/
105+
[swc-site]: https://software-carpentry.org/
111106
[dc-site]: https://datacarpentry.org/
112-
[discuss-list]: https://carpentries.topicbox.com/groups/discuss
107+
[lc-site]: https://librarycarpentry.org/
113108
[github]: https://github.com
114-
[github-flow]: https://guides.github.com/introduction/flow/
109+
[contact]: mailto:team@carpentries.org
115110
[github-join]: https://github.com/join
116-
[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
111+
[repo-issues]: https://github.com/datacarpentry/geospatial-workshop/issues
117112
[issues]: https://carpentries.org/help-wanted-issues/
113+
[template-doc]: https://carpentries.github.io/workbench/
114+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
118115
[lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
119116
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
120-
[swc-lessons]: https://software-carpentry.org/lessons/
121-
[swc-site]: https://software-carpentry.org/
122-
[lc-site]: https://librarycarpentry.org/
123-
[template-doc]: https://carpentries.github.io/workbench/
117+
[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
118+
[github-flow]: https://guides.github.com/introduction/flow/
119+
[repo]: https://github.com/datacarpentry/geospatial-workshop
120+
121+
122+

LICENSE.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ license][cc-by-legal].
1212

1313
You are free:
1414

15-
- to **Share**---copy and redistribute the material in any medium or format
16-
- to **Adapt**---remix, transform, and build upon the material
15+
- to **Share**\---copy and redistribute the material in any medium or format
16+
- to **Adapt**\---remix, transform, and build upon the material
1717

1818
for any purpose, even commercially.
1919

@@ -22,30 +22,30 @@ terms.
2222

2323
Under the following terms:
2424

25-
- **Attribution**---You must give appropriate credit (mentioning that your work
25+
- **Attribution**\---You must give appropriate credit (mentioning that your work
2626
is derived from work that is Copyright (c) The Carpentries and, where
27-
practical, linking to <https://carpentries.org/>), provide a [link to the
27+
practical, linking to [https://carpentries.org/](https://carpentries.org/)), provide a [link to the
2828
license][cc-by-human], and indicate if changes were made. You may do so in
2929
any reasonable manner, but not in any way that suggests the licensor endorses
3030
you or your use.
3131

32-
- **No additional restrictions**---You may not apply legal terms or
32+
- **No additional restrictions**\---You may not apply legal terms or
3333
technological measures that legally restrict others from doing anything the
3434
license permits. With the understanding that:
3535

3636
Notices:
3737

38-
* You do not have to comply with the license for elements of the material in
38+
- You do not have to comply with the license for elements of the material in
3939
the public domain or where your use is permitted by an applicable exception
4040
or limitation.
41-
* No warranties are given. The license may not give you all of the permissions
41+
- No warranties are given. The license may not give you all of the permissions
4242
necessary for your intended use. For example, other rights such as publicity,
4343
privacy, or moral rights may limit how you use the material.
4444

4545
## Software
4646

4747
Except where otherwise noted, the example programs and other software provided
48-
by The Carpentries are made available under the [OSI][osi]-approved [MIT
48+
by The Carpentries are made available under the [OSI][osi]\-approved [MIT
4949
license][mit-license].
5050

5151
Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -74,6 +74,9 @@ Initiatives][ci].
7474

7575
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
7676
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
77+
[osi]: https://opensource.org
7778
[mit-license]: https://opensource.org/licenses/mit-license.html
7879
[ci]: https://communityin.org/
79-
[osi]: https://opensource.org
80+
81+
82+

config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ carpentry: 'dc'
1414
title: 'Geospatial Workshop Overview'
1515

1616
# Date the lesson was created (YYYY-MM-DD, this is empty by default)
17-
created: ~ # FIXME
17+
created: '2018-03-06'
1818

1919
# Comma-separated list of keywords for the lesson
2020
keywords: 'software, data, lesson, The Carpentries' # FIXME

index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Similarly, learners who have prior experience with the `R` programming language
2626
To get started, follow the directions in the [Setup](learners/setup.md) tab to
2727
get access to the required software and data for this workshop.
2828

29-
3029
::::::::::::::::::::::::::::::::::::::::::::::::::
3130

3231
:::::::::::::::::::::::::::::::::::::::::: prereq
@@ -53,7 +52,7 @@ These data files represent the teaching version of the data, with sufficient com
5352
management, but with many complexities removed to allow students to focus on the core ideas and skills being taught.
5453

5554
| Dataset | File name | Description |
56-
| ---------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5756
| Site layout shapefiles | NEON-DS-Site-Layout-Files.zip | A set of shapefiles for the NEON's Harvard Forest field site and US and (some) state boundary layers. |
5857
| Meteorological data | NEON-DS-Met-Time-Series.zip | Precipitation, temperature and other variables collected from a flux tower at the NEON Harvard Forest site |
5958
| Airborne remote sensing data | NEON-DS-Airborne-RemoteSensing.zip | LiDAR data collected by the NEON Airborne Observation Platform (AOP) and processed at NEON including a canopy height model, digital elevation model and digital surface model for NEON's Harvard Forest and San Joaquin Experimental Range field sites. |
@@ -66,7 +65,7 @@ management, but with many complexities removed to allow students to focus on the
6665
# Workshop Overview
6766

6867
| Lesson | Overview |
69-
| ---------------------------- | ------------------------------------------------------------------------------------------ |
68+
| ---------------------------------------------------------- | ------------------------------------------------------------ |
7069
| [Introduction to Geospatial Concepts](https://www.datacarpentry.org/organization-geospatial/) | Understand data structures and common storage and transfer formats for spatial data. |
7170
| [Introduction to R for Geospatial Data](https://www.datacarpentry.org/r-intro-geospatial) | Import data into R, calculate summary statistics, and create publication-quality graphics. |
7271
| [Introduction to Geospatial Raster and Vector Data with R](https://www.datacarpentry.org/r-raster-vector-geospatial) | Open, work with, and plot vector and raster-format spatial data in R. |

instructors/instructor-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The following table provides the structure for the Geospatial Workshop and *esti
1010

1111
| Lesson | Length | Include if: |
1212
| ------ | ---------------------------------- | ------------------------------------------------- |
13-
| [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. |
14-
| [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. |
15-
| [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. |
13+
| [Introduction to Geospatial Concepts](https://datacarpentry.org/organization-geospatial/) ([instructor notes](https://datacarpentry.org/organization-geospatialinstructor/instructor-notes.html)) | **75 minutes** - estimated, will not be accurate | Learners have no experience with geospatial data. |
14+
| [Introduction to R for Geospatial Data](https://datacarpentry.org/r-intro-geospatial/) ([instructor notes](https://datacarpentry.org/r-intro-geospatialinstructor/instructor-notes.html)) | **4 hours** - estimated, will not be accurate | Learners have no experience with R. |
15+
| [Introduction to Geospatial Raster and Vector Data with R](https://datacarpentry.org/r-raster-vector-geospatial/) ([instructor notes](https://datacarpentry.org/r-raster-vector-geospatialinstructor/instructor-notes.html)) | **7 hours** - estimated, will not be accurate | Always. |
1616

1717
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.
1818

@@ -23,7 +23,7 @@ If the workshop audience is experienced in both R and geospatial concepts, this
2323
#### Installation
2424

2525
- 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!**
26-
- Instructions to download data and set up a machine to analyze and process geospatial data: [http://datacarpentry.org/geospatial-workshop/setup.html](https://datacarpentry.org/geospatial-workshop/setup.html)
26+
- Instructions to download data and set up a machine to analyze and process geospatial data: [http://datacarpentry.org/geospatial-workshop/setup.html](https://datacarpentry.org/geospatial-workshop/index.html#setup)
2727
- 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.
2828

2929
[Instructors: add information about supporting learners with installation here]

learners/setup.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ We provide quick instructions below for installing the various software needed f
3636

3737
The installation of the geospatial libraries GDAL, GEOS, and PROJ.4 varies significantly based on operating system. These are all dependencies for `sf`, the `R` package that we will be using for spatial data operations throughout this workshop.
3838

39-
::::::::::::::: solution
39+
:::::::::::::::: spoiler
4040

4141
## Windows
4242

4343
To install the geospatial libraries, install the latest version [RTools](https://cran.r-project.org/bin/windows/Rtools/)
4444

4545
:::::::::::::::::::::::::
4646

47-
::::::::::::::: solution
47+
:::::::::::::::: spoiler
4848

4949
## macOS - Install with Packages (Beginner)
5050

@@ -54,7 +54,7 @@ After downloading the package in the link above, you will need to double-click t
5454

5555
:::::::::::::::::::::::::
5656

57-
::::::::::::::: solution
57+
:::::::::::::::: spoiler
5858

5959
## macOS - Install with Homebrew (Advanced)
6060

@@ -69,7 +69,7 @@ $ brew install gdal2
6969

7070
:::::::::::::::::::::::::
7171

72-
::::::::::::::: solution
72+
:::::::::::::::: spoiler
7373

7474
## Linux
7575

@@ -103,7 +103,7 @@ For **Debian**: The [rocker geospatial](https://github.com/rocker-org/geospatial
103103

104104
Linux users will have to install UDUNITS separately. Like the geospatial libraries discussed above, this is a dependency for the `R` package `sf`. Due to conflicts, it does not install properly on Linux machines when installed as part of the `sf` installation process. It is therefore necessary to install it using the command line ahead of time.
105105

106-
::::::::::::::: solution
106+
:::::::::::::::: spoiler
107107

108108
## Linux
109109

@@ -139,23 +139,23 @@ $ sudo apt-get install -y libudunits2-dev
139139

140140
Participants who do not already have `R` installed should download and install it.
141141

142-
::::::::::::::: solution
142+
:::::::::::::::: spoiler
143143

144144
## Windows
145145

146146
To install `R`, Windows users should select "Download R for Windows" from RStudio and CRAN's [cloud download page](https://cloud.r-project.org), which will automatically detect a CRAN mirror for you to use. Select the `base` subdirectory after choosing the Windows download page. A `.exe` executable file containing the necessary components of base R can be downloaded by clicking on "Download R 3.x.x for Windows".
147147

148148
:::::::::::::::::::::::::
149149

150-
::::::::::::::: solution
150+
:::::::::::::::: spoiler
151151

152152
## macOS
153153

154154
To install `R`, macOS users should select "Download R for (Mac) OS X" from RStudio and CRAN's [cloud download page](https://cloud.r-project.org), which will automatically detect a CRAN mirror for you to use. A `.pkg` file containing the necessary components of base R can be downloaded by clicking on the first available link (this will be the most recent), which will read `R-3.x.x.pkg`.
155155

156156
:::::::::::::::::::::::::
157157

158-
::::::::::::::: solution
158+
:::::::::::::::: spoiler
159159

160160
## Linux
161161

@@ -226,7 +226,7 @@ Once up and running - you'll have full access to RStudio right from your browser
226226

227227
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.
228228

229-
::::::::::::::: solution
229+
:::::::::::::::: spoiler
230230

231231
## Downloading and Installing Docker Community Edition
232232

@@ -238,7 +238,7 @@ Additional installation notes are available in Docker's documentation for each o
238238

239239
:::::::::::::::::::::::::
240240

241-
::::::::::::::: solution
241+
:::::::::::::::: spoiler
242242

243243
## Using the `rocker/geospatial` Docker Image via the Command Line
244244

@@ -296,7 +296,7 @@ If you are returning to a session after stopping Docker itself, make sure Docker
296296

297297
:::::::::::::::::::::::::
298298

299-
::::::::::::::: solution
299+
:::::::::::::::: spoiler
300300

301301
## Using the `rocker/geospatial` Docker Image via Kitematic
302302

@@ -330,7 +330,7 @@ You can restart your container later by clicking the `Restart` button.
330330

331331
:::::::::::::::::::::::::
332332

333-
::::::::::::::: solution
333+
:::::::::::::::: spoiler
334334

335335
## Managing Docker Containers and Images
336336

0 commit comments

Comments
 (0)