Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

| Software | Install | Manual | Available for | Description |
|------------|------------|------------|------------|-------------------------|
| [R](https://www.r-project.org) | [Link](https://cloud.r-project.org) | [Link](https://cloud.r-project.org) | Linux, MacOS | Software environment for statistical and scientific computing |

Check warning on line 23 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[uninformative link text]: [Link](https://cloud.r-project.org)

Check warning on line 23 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[uninformative link text]: [Link](https://cloud.r-project.org)

Check warning on line 23 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[link text too short]: [R](https://www.r-project.org)
| [RStudio](https://www.rstudio.com) | [Link](https://www.rstudio.com/products/rstudio/download/#download) | | Linux, MacOS | GUI for R |

Check warning on line 24 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[uninformative link text]: [Link](https://www.rstudio.com/products/rstudio/download/#download)

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.

Expand All @@ -32,23 +32,33 @@
:::

::: spoiler
## macOS - Install with Packages (Beginner)
## macOS - Prefer binary packages (recommended)

The simplest way to install these geospatial libraries is to install the latest version of [Kyng Chaos's pre-built package](https://www.kyngchaos.com/software/frameworks) for GDAL Complete. Be aware that several other libraries are also installed, including the UnixImageIO, SQLite3, and `NumPy`.
On macOS, install the `R` geospatial packages from CRAN as **binary** packages. The binaries already include the needed GDAL/PROJ/GEOS libraries, so most participants do not need to install system libraries separately:

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 installation by following [these instructions](https://kb.wisc.edu/page.php?id=25443) for installing programs from unidentified developers.
```r
install.packages(c("sf", "terra"), type = "binary")
```

Use the source / Homebrew path below only if you need a source install or custom library versions.
:::

::: spoiler
## macOS - Install with Homebrew (Advanced)
## macOS - Install with Homebrew (advanced / source builds)

Alternatively, participants who are comfortable with the command line can install the geospatial libraries individually using [homebrew](https://brew.sh):
Participants who are comfortable with the command line and need a **source** install can install GDAL with [Homebrew](https://brew.sh) (recent Homebrew `gdal` pulls in PROJ and GEOS):

```bash
$ brew install proj
$ brew install geos
$ brew install pkg-config
$ brew install gdal
```

Then install `sf` from source, pointing at the Homebrew library path:

```r
install.packages("sf", type = "source",
configure.args = "--with-proj-lib=$(brew --prefix)/lib/")
```
:::

::: spoiler
Expand Down Expand Up @@ -76,7 +86,7 @@
$ pacman -S gdal proj geos
```

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.

Check warning on line 89 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

:::

### UDUNITS
Expand Down Expand Up @@ -120,13 +130,13 @@
::: spoiler
## Windows

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".
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 4.x.x for Windows".
:::

::: spoiler
## macOS

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`.
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-4.x.x.pkg`.
:::

::: spoiler
Expand All @@ -137,7 +147,7 @@

### RStudio

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).*

Check warning on line 150 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[uninformative link text]: [here](https://www.rstudio.com/products/rstudio/download/)

### R Packages

Expand Down Expand Up @@ -272,23 +282,25 @@

#### Download and Install Kitematic

[Kitematic](https://github.com/docker/kitematic) is the GUI, currently in beta, that Docker has built for accessing images and containers on Windows, macOS, and Ubuntu. You can download the appropriate installer files from Kitematic's [GitHub release page](https://github.com/docker/kitematic/releases/tag/v0.17.3). You need to have already installed Docker Community Edition (see instructions above) before installing Kitematic!
> **Note:** The [Kitematic](https://github.com/docker/kitematic) project is **archived** and no longer maintained. Prefer the command-line Docker instructions above. The steps below remain only for historical reference if you already have Kitematic installed.

Kitematic was a GUI for Docker images and containers on Windows, macOS, and Ubuntu. Older installers may still be available from its [GitHub release page](https://github.com/docker/kitematic/releases/tag/v0.17.3). You need Docker Community Edition installed before using Kitematic.

#### Opening a Container with Kitematic

Once you have installed Kitematic, make sure the Docker application is running and then open Kitematic. You should not need to create a login to use Kitematic. If prompted for login credentials, there is an option to skip that step. Use the search bar in the main window to find `rocker/geospatial` (pictured below) and click `Create` under that Docker repository.

![](fig/kitematicSearch.png)

Check warning on line 293 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[image missing alt-text]: fig/kitematicSearch.png

After downloading and installing the image, your container should start automatically. Before opening your browser, connect your Docker image to a local folder where you have your workshop resources stored by clicking on the `Settings` tab and then choosing `Volumes`. Click `Change` and then select the directory you would like to connect to.

![](fig/kitematicLocal.png)

Check warning on line 297 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[image missing alt-text]: fig/kitematicLocal.png

When you open RStudio instance below, you will see the contents of the connected folder inside the `kitematic` directory in the file tab located in the lower righthand corner of the screen.

When you are ready, copy the `Access URL` from the `Home` tab:

![](fig/kitematicURL.png)

Check warning on line 303 in learners/setup.md

View workflow job for this annotation

GitHub Actions / Build markdown source files if valid

[image missing alt-text]: fig/kitematicURL.png

Paste that url into your browser and, if prompted, enter `rstudio` for both the username and the password.

Expand Down
Loading