From a7d8ada4dd9647ba62cfc550c857b88e2b774a4c Mon Sep 17 00:00:00 2001 From: avahoffman Date: Fri, 23 Aug 2024 17:40:16 -0400 Subject: [PATCH 1/8] Update student guide so there is a direct option for cloning a workspace --- child/_child_student_create_account.Rmd | 23 +++----- .../_child_student_workspace_clone_direct.Rmd | 59 +++++++++++++++++++ 2 files changed, 67 insertions(+), 15 deletions(-) create mode 100644 child/_child_student_workspace_clone_direct.Rmd diff --git a/child/_child_student_create_account.Rmd b/child/_child_student_create_account.Rmd index 3ba957a5..b9ce6c1d 100644 --- a/child/_child_student_create_account.Rmd +++ b/child/_child_student_create_account.Rmd @@ -1,39 +1,32 @@ -In order to run your analyses, you will use the [AnVIL cloud computing platform](https://anvilproject.org/), so that you do not need to install everything on your own computer. The AnVIL (Analysis Visualization and Informatics Lab-space) platform is specially designed for analyzing biological data, and is used by scientists doing all sorts of biological research. +In order to run your analyses, you will use the [AnVIL cloud computing platform](https://anvilproject.org/). The AnVIL (Analysis Visualization and Informatics Lab-space) platform is specially designed for analyzing biological data, and is used by scientists doing all sorts of biological research. :::{.notice} **AnVIL in a nutshell** -- Behind the scenes, AnVIL relies on Google Cloud Platform to provide computing infrastructure. Basically, AnVIL lets you "rent" computers from Google (remotely). Whenever you run an analyses on AnVIL, it actually runs on one of Google's computers, and AnVIL lets you see the results in your browser. -- AnVIL uses [Terra](https://anvil.terra.bio/) to provide many computational tools useful for biological data analysis, such as [RStudio](https://www.rstudio.com/products/rstudio/), [Galaxy](https://usegalaxy.org/), and [Jupyter Notebooks](https://jupyter.org/). Terra takes care of installing these tools on Google's computers, so that you can just start using them. +- Behind the scenes, AnVIL relies on Google Cloud Platform to provide computing infrastructure. Basically, AnVIL lets you "rent" computers through the internet. The analysis is run on the rented computer. AnVIL lets you see the results in your browser. +- AnVIL uses [Terra](https://anvil.terra.bio/) to provide many computational tools useful for biological data analysis, such as [RStudio](https://www.rstudio.com/products/rstudio/), [Galaxy](https://usegalaxy.org/), and [Jupyter Notebooks](https://jupyter.org/). Terra takes care of installing these tools so you can use them right away. ::: ### Create Google Account First, you will need to set up a (free) Google account. -If you do not already have a Google account that you would like to use for accessing AnVIL, [create one now](https://accounts.google.com/SignUp). +A Google account usually looks like "`myname@gmail.com`". Alternatively, you can enable Google for an existing non-Gmail email address using [these instructions](https://support.terra.bio/hc/en-us/articles/360029186611). -- Alternatively, if you would like to create a Google account that is associated with an existing non-Gmail email address, you can follow [these instructions](https://support.terra.bio/hc/en-us/articles/360029186611). +If you do not already have a Google account that you would like to use for accessing AnVIL, [create one now](https://accounts.google.com/SignUp). ### Log In to Terra Next, make sure you can log in to Terra -- you will use Terra to perform computations on AnVIL. -You can access Terra by going to [`anvil.terra.bio`](https://anvil.terra.bio/), or by clicking the link on the [AnVIL home page](https://anvilproject.org/). - - -```{r, echo=FALSE, fig.alt='Screenshot of the AnVIL home page. The section descring Terra is highlighted.'} -ottrpal::include_slide("https://docs.google.com/presentation/d/1-PVlDAzmDncjcCHIy9ZyR3ROyPpfjrg46LhEQopDc1Q/edit#slide=id.g22c9add987a_0_5") -``` - -Open Terra, and you should be prompted to sign in with your Google account. +You can access Terra by going to [`anvil.terra.bio`](https://anvil.terra.bio/). Open Terra, and you should be prompted to sign in with your Google account. ### Share Username -Finally, make sure your instructor has your Google account username (e.g. `myname@gmail.com`), so they can give you access to everything you need. +Make sure your instructor has your Google account username (e.g. `myname@gmail.com`), so they can give you access to everything you need. - Make sure there are no typos! -- If you have multiple Google accounts, make sure you give them the username that you will be using to access AnVIL +- If you have multiple Google accounts, make sure you give them the username that you will be using to log in to `anvil.terra.bio`. :::{.warning} It is *very important* that you share the Google account you will be using to access AnVIL with with your instructor! Otherwise, the instructor cannot add you to Billing Projects or Workspaces, and you will be unable to proceed with your assignments. diff --git a/child/_child_student_workspace_clone_direct.Rmd b/child/_child_student_workspace_clone_direct.Rmd new file mode 100644 index 00000000..831ef71c --- /dev/null +++ b/child/_child_student_workspace_clone_direct.Rmd @@ -0,0 +1,59 @@ +```{r, include = FALSE} +if (!exists("AnVIL_module_settings")) { + AnVIL_module_settings <- list() +} +if (is.null(AnVIL_module_settings$workspace_name)) { + AnVIL_module_settings$workspace_name = "specified by your instructor" + AnVIL_module_settings$clone_name = "ExampleWorkspace_Firstname_Lastname" +} else { +AnVIL_module_settings$clone_name = paste0(AnVIL_module_settings$workspace_name, "_Firstname_Lastname") +} +if (is.null(AnVIL_module_settings$workspace_link)) { + AnVIL_module_settings$workspace_link = "ask your instructor" +} +if (is.null(AnVIL_module_settings$billing_project)) { + AnVIL_module_settings$billing_project = "provided by your instructor" +} +``` + +:::{.warning} +This **will not work** until your instructor has given you permission to spend money to "rent" the computers that will power your analyses (by adding you to a "Billing Project"). +::: + +On AnVIL, you access files and computers through **Workspaces**. Each Workspace functions almost like a mini code laboratory - it is a place where data can be examined, stored, and analyzed. The first thing we want to do is to copy or “clone” a Workspace to create a space for you to experiment. This will give you access to + +- the files you will need (data, code) +- the computing environment you will use + +:::{.notice} +**Tip** +At this point, it might make things easier to open up a new window in your browser and split your screen. That way, you can follow along with this guide on one side and execute the steps on the other. +::: + +To clone an AnVIL Workspace: + +1. Go to the Workspace by clicking this link: `r AnVIL_module_settings$workspace_link`. + +1. Clone the workspace by clicking the teardrop button (![teardrop button](https://raw.githubusercontent.com/jhudsl/AnVIL_Template/main/child/child_assets/teardrop_button.png){width=25px}). Select "Clone". See the screenshot below on a different Workspace: + + ```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot showing the teardrop button. The button has been clicked revealing the "clone" option. The Clone option and the teardrop button are highlighted.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1a5Da6qX9BG7Q_6XAz7MvlDyWTvssm2hWwuo1WFJXb_0/edit#slide=id.g117abafa453_0_577") + ``` + +1. You will see a popup box appear, asking you to configure your Workspace + a. Give your Workspace clone a name by adding an underscore ("_") and your name. For example, \"`r AnVIL_module_settings$clone_name`\". + a. Select the Billing Project `r AnVIL_module_settings$billing_project`. + a. Leave the bottom two boxes as-is. + a. Click “CLONE WORKSPACE”. + + See the screenshot below on a different Workspace: + + ```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot showing the "clone a workspace" popout. The Workspace name, Billing Project, and Clone Workspace button have been filled in and highlighted.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1a5Da6qX9BG7Q_6XAz7MvlDyWTvssm2hWwuo1WFJXb_0/edit#slide=id.g17144dbacd0_0_352") + ``` + +1. The new Workspace should now show up under https://anvil.terra.bio/#workspaces. This is your own copy of the Workspace to work in. + +```{r, include = FALSE} +AnVIL_module_settings <<- NULL +``` From c6eeba6fae9528c4a1c512fc6b5a4f5b785f3c71 Mon Sep 17 00:00:00 2001 From: avahoffman Date: Fri, 23 Aug 2024 18:26:00 -0400 Subject: [PATCH 2/8] Update _child_terra_billing_project_create.Rmd --- child/_child_terra_billing_project_create.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/child/_child_terra_billing_project_create.Rmd b/child/_child_terra_billing_project_create.Rmd index 2dfe7420..8f57c04b 100644 --- a/child/_child_terra_billing_project_create.Rmd +++ b/child/_child_terra_billing_project_create.Rmd @@ -6,7 +6,7 @@ ottrpal::include_slide("https://docs.google.com/presentation/d/1POwxqv4p6AfPHJlN9VNq0TaT44fA2RAFSpIERIMHdWU/edit#slide=id.g116f8d759be_0_2") ``` -1. On the Billing page, click the "+ CREATE" button to create a new Billing Project. If prompted, select the Google account to use. If prompted, give Terra permission to manage Google Cloud Platform billing accounts. +1. On the Billing page, click the "+ CREATE" button to create a new Billing Project. Select GCP Billing Project (Google's Platform). If prompted, select the Google account to use and give Terra permission to manage Google Cloud Platform billing accounts. ```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot of the Terra Billing Page. The "plus" button next to "Billing Projects" is highlighted.'} ottrpal::include_slide("https://docs.google.com/presentation/d/1POwxqv4p6AfPHJlN9VNq0TaT44fA2RAFSpIERIMHdWU/edit#slide=id.g116f8d759be_0_149") From eb183cb5e1025513739c36724b10083752fc1acb Mon Sep 17 00:00:00 2001 From: avahoffman Date: Fri, 23 Aug 2024 18:27:06 -0400 Subject: [PATCH 3/8] Update _child_terra_billing_project_create.Rmd --- child/_child_terra_billing_project_create.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/child/_child_terra_billing_project_create.Rmd b/child/_child_terra_billing_project_create.Rmd index 8f57c04b..4eace75d 100644 --- a/child/_child_terra_billing_project_create.Rmd +++ b/child/_child_terra_billing_project_create.Rmd @@ -28,7 +28,7 @@ ottrpal::include_slide("https://docs.google.com/presentation/d/1POwxqv4p6AfPHJlN ottrpal::include_slide("https://docs.google.com/presentation/d/1POwxqv4p6AfPHJlN9VNq0TaT44fA2RAFSpIERIMHdWU/edit#slide=id.g2105956e909_0_0") ``` -1. Click "CREATE BILLING PROJECT". +1. Click "Create". ```{r, echo=FALSE, out.width = '100%', fig.alt='Screenshot of the Terra Add Billing Project dialog box. The button labeled "CREATE BILLING PROJECT" is highlighted.'} ottrpal::include_slide("https://docs.google.com/presentation/d/1POwxqv4p6AfPHJlN9VNq0TaT44fA2RAFSpIERIMHdWU/edit#slide=id.g116f8d759be_0_438") From 43e6012894f6ab5273e4d50bd537dce060f99f56 Mon Sep 17 00:00:00 2001 From: avahoffman Date: Fri, 23 Aug 2024 18:58:24 -0400 Subject: [PATCH 4/8] Update _child_galaxy_start.Rmd --- child/_child_galaxy_start.Rmd | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/child/_child_galaxy_start.Rmd b/child/_child_galaxy_start.Rmd index c1b91ed0..580de5b0 100644 --- a/child/_child_galaxy_start.Rmd +++ b/child/_child_galaxy_start.Rmd @@ -1,8 +1,13 @@ Note that, in order to use Galaxy, you must have access to a Terra Workspace with permission to compute (i.e. you must be a "Writer" or "Owner" of the Workspace). -Open your Workspace, and click on the “NOTEBOOKS” tab. Next, click on “Create a Cloud Environment for Galaxy”. You should see a popup window on the right side of the screen. Click on “NEXT” and “CREATE” to keep all settings as-is. This will take 8-10 minutes. When it is done, click “LAUNCH GALAXY”. +Open your Workspace, and click on the “Environment configuration” button, a cloud icon on the righthand side of the screen. -```{r, echo=FALSE, fig.alt='Screenshot of the Workspace Notebooks tab. The notebook tab name and the plus button that starts a cloud environment for Galaxy have been highlighted,'} -ottrpal::include_slide("https://docs.google.com/presentation/d/182AOzMaiyrreinnsRX2VhH7YsVgvAp4xtIB_7Mzmk6I/edit#slide=id.ged15532ded_0_788") +```{r, echo=FALSE, fig.alt='Screenshot of the Workspace that points to the Environment configuration button, an icon of a cloud with a lightning bolt.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge20e585f11_0_9") ``` +Under Galaxy, click on “Create new Environment”. Click on “Next” and “Create” to keep all settings as-is. This will take 8-10 minutes. + +```{r, echo=FALSE, fig.alt='The button that starts a cloud environment for Galaxy has been highlighted,'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge1182914a6_0_36") +``` From 98968acf2f8ebe46cda05c6038b07ada5dd94954 Mon Sep 17 00:00:00 2001 From: avahoffman Date: Fri, 23 Aug 2024 19:06:18 -0400 Subject: [PATCH 5/8] Typo --- 07-using_platforms_modules.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/07-using_platforms_modules.Rmd b/07-using_platforms_modules.Rmd index a855c346..2c408632 100644 --- a/07-using_platforms_modules.Rmd +++ b/07-using_platforms_modules.Rmd @@ -17,6 +17,7 @@ cow::borrow_chapter( repo_name = "jhudsl/AnVIL_Template" ) ``` +:::: ## Launching Jupyter From 99b688763510d4d2242ba7c1867ab6134efc0750 Mon Sep 17 00:00:00 2001 From: avahoffman Date: Tue, 27 Aug 2024 12:26:02 -0400 Subject: [PATCH 6/8] Final updates --- child/_child_galaxy_delete.Rmd | 20 ++++++++++---------- child/_child_galaxy_navigate.Rmd | 1 - child/_child_galaxy_start.Rmd | 6 ++++++ 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/child/_child_galaxy_delete.Rmd b/child/_child_galaxy_delete.Rmd index fe55a4ee..25e68f17 100644 --- a/child/_child_galaxy_delete.Rmd +++ b/child/_child_galaxy_delete.Rmd @@ -1,20 +1,20 @@ - Once you are done with your activity, you’ll need to shut down your Galaxy cloud environment. This frees up the cloud resources for others and minimizes computing cost. The following steps will delete your work, so make sure you are completely finished at this point. Otherwise, you will have to repeat your work from the previous steps. -Return to AnVIL, and find the Galaxy logo that shows your cloud environment is running. Click on this logo: +Return to AnVIL, and find the Galaxy logo that shows your cloud environment is running. Click on this logo. -```{r, echo=FALSE, fig.alt='Screenshot of the Workspace menu. The currently running Galaxy cloud environment logo on the top right of the page is highlighted.'} -ottrpal::include_slide("https://docs.google.com/presentation/d/182AOzMaiyrreinnsRX2VhH7YsVgvAp4xtIB_7Mzmk6I/edit#slide=id.gf243efded1_0_134") +```{r, echo=FALSE, fig.alt='Screenshot of the Workspace menu. The currently running Galaxy cloud environment logo on the right sidebar is highlighted.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge20e585f11_0_248") ``` -Next, click on “DELETE ENVIRONMENT OPTIONS”: +Next, click on "Settings". Click on "Delete Environment". -```{r, echo=FALSE, fig.alt='Screenshot of the cloud environment pop out menu. The “DELETE ENVIRONMENT OPTIONS” link is highlighted.'} -ottrpal::include_slide("https://docs.google.com/presentation/d/182AOzMaiyrreinnsRX2VhH7YsVgvAp4xtIB_7Mzmk6I/edit#slide=id.gf243efded1_0_140") +```{r, echo=FALSE, fig.alt='Screenshot of the cloud environment pop out menu. The "Delete Environment" button is highlighted.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge20e585f11_0_256") ``` -Finally, select “Delete everything, including persistent disk”. Make sure you are done with the activity and then click “DELETE”. +Finally, select "Delete everything, including persistent disk". Make sure you are done with the activity and then click "Delete". -```{r, echo=FALSE, fig.alt='Screenshot of the cloud environment pop out menu. The “Delete everything, including persistent disk” radio button has been checked and is highlighted. The “DELETE” button is highlighted.'} -ottrpal::include_slide("https://docs.google.com/presentation/d/182AOzMaiyrreinnsRX2VhH7YsVgvAp4xtIB_7Mzmk6I/edit#slide=id.gf243efded1_0_146") +```{r, echo=FALSE, fig.alt='Screenshot of the cloud environment pop out menu. The “Delete everything, including persistent disk” radio button has been checked and is highlighted. The “Delete” button is highlighted.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1UIfBMQcujMzyNTyIiMXQ6eU0DdWHmI9QUtseGylg6Ms/edit#slide=id.g117989bd49c_0_0") +``` diff --git a/child/_child_galaxy_navigate.Rmd b/child/_child_galaxy_navigate.Rmd index f6b18b87..8bc66bd8 100644 --- a/child/_child_galaxy_navigate.Rmd +++ b/child/_child_galaxy_navigate.Rmd @@ -12,4 +12,3 @@ ottrpal::include_slide("https://docs.google.com/presentation/d/182AOzMaiyrreinns ``` On the welcome page, there are links to tutorials. You may try these out on your own. If you want to try a new analysis this is a good place to start. - diff --git a/child/_child_galaxy_start.Rmd b/child/_child_galaxy_start.Rmd index 580de5b0..d7a81cac 100644 --- a/child/_child_galaxy_start.Rmd +++ b/child/_child_galaxy_start.Rmd @@ -11,3 +11,9 @@ Under Galaxy, click on “Create new Environment”. Click on “Next” and “ ```{r, echo=FALSE, fig.alt='The button that starts a cloud environment for Galaxy has been highlighted,'} ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge1182914a6_0_36") ``` + +Click on "Open Galaxy" when the environment is ready. + +```{r, echo=FALSE, fig.alt='The Open Galaxy button is highlighted in the ready environment popup.'} +ottrpal::include_slide("https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit#slide=id.ge1182914a6_0_57") +``` From 041ebb97883cf2af61624b3e0c8e9dadf2eca1ef Mon Sep 17 00:00:00 2001 From: avahoffman Date: Tue, 27 Aug 2024 13:22:18 -0400 Subject: [PATCH 7/8] Update video link --- child/_child_galaxy_video.Rmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/child/_child_galaxy_video.Rmd b/child/_child_galaxy_video.Rmd index 5e59ccd2..a7bf8fc9 100644 --- a/child/_child_galaxy_video.Rmd +++ b/child/_child_galaxy_video.Rmd @@ -1,7 +1,7 @@ Here is a video tutorial that describes the basics of using Galaxy on AnVIL. - + ### Objectives @@ -11,6 +11,6 @@ Here is a video tutorial that describes the basics of using Galaxy on AnVIL. ### Slides -The slides for this tutorial are are located [here](https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q). +The slides for this tutorial are are located [here](https://docs.google.com/presentation/d/1yYCg4cPVBMMDghT17B4XzROieqyMH99Ex9nMm_Scm9Q/edit?usp=sharing). From 63b4f4e00cc5a9370397847d8b1df87104319178 Mon Sep 17 00:00:00 2001 From: avahoffman Date: Tue, 27 Aug 2024 13:30:27 -0400 Subject: [PATCH 8/8] Trivial change to trigger re-render --- 02-chapter_of_course.Rmd | 1 - 1 file changed, 1 deletion(-) diff --git a/02-chapter_of_course.Rmd b/02-chapter_of_course.Rmd index 61240f16..234726dc 100644 --- a/02-chapter_of_course.Rmd +++ b/02-chapter_of_course.Rmd @@ -184,4 +184,3 @@ You should print out session info when you have code for [reproducibility purpos ```{r} devtools::session_info() ``` -