You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve install instructions and remove workbench refs (#221)
* Move install instructions to overview, include Vice app use
* Remove getting started and workbench info from README
* Remove all references to workbench in tutorials
## An introduction to the use of TERRA REF data and software
7
+
In this repository is an extensive set of materials for how to use TERRA REF data and software.
8
+
The best place to start is the [TERRA REF tutorials website](https://terraref.github.io/tutorials/).
9
+
We used [bookdown](https://bookdown.org/) to create the website, and relevant files include _[bookdown.yml](https://github.com/terraref/tutorials/blob/master/_bookdown.yml), [index.Rmd](https://github.com/terraref/tutorials/blob/master/index.Rmd), and all of the [vignettes](https://github.com/terraref/tutorials/tree/master/vignettes).
7
10
8
-
This repository provides a set of tutorials that are divided by data types and use cases.
11
+
Tutorials on the website come from the more extensive tutorials in the [traits](https://github.com/terraref/tutorials/tree/master/traits), [sensors](https://github.com/terraref/tutorials/tree/master/sensors), and [plantcv](https://github.com/terraref/tutorials/tree/master/plantcv) folders.
12
+
Notes from walkthroughs of TERRA REF data use are in [videos](https://github.com/terraref/tutorials/tree/master/videos).
9
13
10
-
In the repository, you will find three folders that contain examples of how to access data:
14
+
These are intended to cover diverse use cases, and you will find information about accessing data from web interfaces but the primary focus is on accessing data using R, Python, SQL, and REST APIs. These are intended to provide quick-start introductions to access data along with computing environments required for further exploration. They are not intended to teach analyses, although some illustrative visualizations and statistical models are provided.
11
15
12
-
* traits
13
-
* sensors
14
-
* plantCV
16
+
This is a work in progress for an open source community that welcomes contributions in many forms. Please feel welcome to ask questions, provide suggestions, or share analyses that may be of interest to others.
15
17
16
-
Within each folder there are both R markdown and Jupyter notebooks. These describe different approaches to accessing data. These are intended to cover diverse use cases, and you will find information about accessing data from web interfaces but the primary focus is on accessing data using R, Python, SQL, and REST APIs. These are intended to provide quick-start introductions to access data along with computing environments required for further exploration. They are not intended to teach analyses, although some illustrative visualizations and statistical models are provided.
18
+
## How to contribute
17
19
18
-
This is a work in progress, and an open source community that welcomes contributions in many forms. Please feel welcome to ask questions, provide suggestions or share analyses that may be of interest to others.
20
+
We welcome suggestions and edits from all users.
21
+
Feel free to [create a GitHub issue](https://github.com/terraref/tutorials/issues) detailing possible improvements.
19
22
23
+
If you would like to make changes yourself, fork this repository, make changes on a branch, and submit a pull request.
24
+
We are happy to help with this process.
20
25
21
-
## Getting Started
22
-
23
-
### Requirements
24
-
25
-
All of the tutorials have been designed to work in the cloud and can be accessed using a web browser. Therefore, the _only technical requirements_ are:
26
-
* Web browser
27
-
* Internet connection
28
-
29
-
In addition, you will need to:
30
-
* Sign up as as a TERRA REF [Beta User by filling out this application](http://terraref.org/beta).
31
-
* Sign up for an account on the [TERRA REF Workbench](https://www.workbench.terraref.org), and wait for approval.
32
-
33
-
### Using the Workbench
34
-
35
-
The Workbench uses the National Data Service Labs Workbench (NDS Labs Workbench) software. The Workbench is a cloud analysis environment that minimizes and standardizes the software requirements so users can get started quickly. It also provides access to large files and databases that would otherwise be slow and impractical for users to download and store.
36
-
37
-
Although we provide a few pre-configured computing environments, Workbench is designed to support any Docker container - that is, anything you can install on a linux computer can be used in the workbench - for an idea of what is possible, see the large number of options on [Docker Hub](https://hub.docker.com/explore/).
38
-
39
-
**To get started**, follow the [Workbench Quick Start](https://htmlpreview.github.io/?https://github.com/terraref/tutorials/blob/master/workbench/ndslabs_workbench_intro.html).
40
-
41
-
This will walk you through the process of getting started with the first tutorials on how to access data.
42
-
43
-
44
-
## To generate this documentation locally
45
-
46
-
If you would like to contribute to this documentation you can preview your
47
-
changes by running the following command:
26
+
There are two ways to preview your changes as you make them.
27
+
The first is by running the following on the command line from within the forked repository folder:
48
28
49
29
```bash
50
30
Rscript -e 'bookdown::render_book("index.Rmd")'
51
31
```
52
32
53
33
The output will be in the `docs` folder.
54
34
55
-
There is also a Dockerfile for convenience. It requires installing Docker on
56
-
your computer:
35
+
The second way to preview changes is using the Docker container.
36
+
This requires installing Docker on your computer:
57
37
58
38
-[Docker for Mac](https://download.docker.com/mac/stable/Docker.dmg)
59
39
-[Docker for Windows](https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe)
**Option 1** The recommended and easier option is to use our [VICE](https://learning.cyverse.org/projects/vice/en/latest/getting_started/about.html) app on [CyVerse](https://cyverse.org/)'s [Discovery Environment](https://de.cyverse.org/de/) platform. All necessary programs and libraries are installed and accessed using RStudio. You'll need a CyVerse account; follow instructions below to set up.
41
+
42
+
Launching TERRA REF app on VICE:
43
+
44
+
1. Google "Cyverse" and click link to website
45
+
2. Select Products tab
46
+
3. Under "Discovery Environment", select Launch button
47
+
4. Hit "Log in with your CyVerse ID" button
48
+
5. Log in with CyVerse credentials (username and password)
49
+
6. Select "Apps", type in "terra", select "TERRA REF Rstudio 3.6.0", and "Use App"
50
+
7. Click "Launch Analysis", hit Analysis button, and select arrow button in Analyses window
51
+
8. Wait patiently
52
+
9. Sign into RStudio using username: rstudio and password: rstudio1
53
+
54
+
Reopen running TERRA REF instance:
55
+
56
+
1. Google "Cyverse" and click link to website
57
+
2. Select Products tab
58
+
3. Under "Discovery Environment", select Launch button
59
+
4. Hit "Log in with your CyVerse ID" button
60
+
5. Log in with CyVerse credentials (username and password)
61
+
6. Open Analyses window and hit arrow button to open up RStudio
62
+
63
+
**Option 2** Everything necessary can be installed locally instead of using the VICE app.
64
+
You will need to [install R](https://www.r-project.org/) and a handful of R packages.
65
+
66
+
All of the packages except `traits` are available on CRAN and can be installed using the `install.packages` function:
Copy file name to clipboardExpand all lines: sensors/01-meteorological-data.Rmd
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -206,7 +206,7 @@ This higher resolution weather data can be used for VNIR calibration, for exampl
206
206
207
207
#### Download data
208
208
209
-
Here we will download the files using the Clowder API, but note that if you have access to the filesystem (on www.workbench.terraref.org or globus, you can directly access the data in the `sites/ua-mac/Level_1/EnvironmentLogger`. Folder
209
+
Here we will download the files using the Clowder API, but note that if you have access to the filesystem on Globus, you can directly access the data in the `sites/ua-mac/Level_1/EnvironmentLogger` folder.
Copy file name to clipboardExpand all lines: vignettes/00-introduction.Rmd
+4-25Lines changed: 4 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -6,36 +6,15 @@
6
6
These vignettes provide a **quick start** tutorial - they quickly show you how to access different types of data in the TERRA Reference datasets and perform ‘hello world’ tasks with them.
7
7
8
8
The vignettes currently include examples of:
9
+
9
10
* trait data
10
11
* weather data
11
12
* image data
12
13
* combining trait, weather, and image data in a single analysis
13
14
14
-
In order to make these vignettes as easy to use as possible, we are using a subset of the full dataset that is is available without an account or password. Specifically, we have made data from thirty two plots in each of the two seasons available.
15
+
In order to make these vignettes as easy to use as possible, we are using a subset of the full dataset that is available without an account or password. Specifically, we have made data from thirty two plots in each of the two seasons available.
15
16
16
17
Although we want to make these data broadly available, the remainder of the dataset requires an account to use so we can keep track of who and how many people are using it, and can contact users with their provided email addresses.
17
-
Information for getting a beta user account is available in the section on [User Accounts](#user-accounts).
18
-
19
-
20
-
## Prerequisites
21
-
22
-
### R
23
-
24
-
In order to use the vignettes, you will need to have R installed along with the extra packages that are used.
25
-
All of the packages except 'trait' are available on CRAN and can be installed using the `install.packages` function:
0 commit comments