Navigating Terra Workspaces¶
Let's learn the basics of Terra workspaces by creating one!
Remember that you need the following before you can use Terra workspaces:
- GCP billing account with Terra added as a "Billing Account User"
- Terra billing project linked to GCP billing account
Go back to the previous lesson if you need to set these up!
Step 1: Navigate to Workspaces¶
Click on the three lines and click on the Workspaces tab:
Step 2: Create a new workspace¶
Click on the + button to create a new workspace:
Step 3: Enter workspace information¶
For the new workspace, enter:
- A unique workspace name
- Use the dropdown menu to select your Terra billing project (created previously)
- Optional: add a short description for the workspace
- Optional: select group(s) to give access to the workspace with Authorization Domains permissions
Click CREATE WORKSPACE. It may take a few seconds for the workspace to open.
Basics of Terra workspaces¶
When your workspace opens, you should see the Dashboard! Your
<billing project/workspace name> is shown at the top of the page. In the screenshot below, we used a billing project called "cfde-terra-demo" and a workspace called "demo-23feb21":
The Terra workspace is an organized repository with the following tabs:
Dashboard: document analysis information
Data: upload new data or import existing datasets already on Terra
Notebooks: build Jupyter notebooks
Workflows: run workflows
Job History: check workflow job status
Cloud Environment: configure your own cloud set up, and spin up a Rstudio session
The right-side panel of the Dashboard displays useful information about the workspace, including workspace cost per month. This rate is associated with data storage, not compute. Even if you are not running notebooks or workflows from a given workspace, the workspace continues to accrue storage costs for any associated data, input, or output files stored in the assigned Google Storage bucket. For this reason, it's a good habit to clean up workspaces that are not being used and can be safely deleted (see below for deleting workspaces).
A Google Storage bucket is automatically assigned to each workspace (the bucket path is displayed on the Dashboard). The bucket will hold any files you upload and all output files from workflows.
We'll discuss the
Job History tabs in more detail in the next lessons. For now, let's keep exploring workspace features.
What else can you do with a workspace? ¶
You can edit any workspaces linked to your billing project(s) or workspaces that you have been given permission to edit.
You can make a clone of an existing workspace and edit it. This feature is useful if you want to use a publicly available workspace that has analysis workflows or data you want to use for your own project.
For example, Terra maintains a few demo workspaces that you can clone to learn how to use data tables, workflows, and notebooks. Let's clone the workspace for data tables.
- In the workspace search bar, type "quickstart"
- Select FEATURED
- Click on the three dots at the end of the row for "Terra-Data-Tables-Quickstart"
Select your Terra billing project from the dropdown menu
- Optional: edit the workspace name and description
- Click CLONE WORKSPACE
The cloned workspace should list your billing project and you as the owner of the workspace, but all the contents in the workspace will start out the same as the original one.
You can use this space to add your own notes on the Dashboard, upload files in the Data tab, run notebooks or workflows, and of course, follow the quickstart tutorials and exercises!
We recommend trying the Terra quickstart lessons to practice using the Terra interface.
- Similar to the clone steps, on the workspace you want to share, click the three dots and select Share
- Add the email address(es) of people you want to add or the name of a group if you've made one and type Enter
- The people you've added will be listed in the pop up box, where you can assign their permissions ("Reader", "writer", or "Owner") and decide whether they can share and/or use the workspace to compute.
It's good to clean up old workspaces. It helps to keep track of active workspaces and saves you from accruing storage costs on workspaces you do not need.
- Similar to the clone steps, on the workspace you want to delete, click the three dots and select Delete
You cannot retrieve deleted workspaces or their contents!
- A pop up window will open checking to make sure you do want to delete the workspace. If this is true, type "Delete Workspace" and click DELETE WORKSPACE
In the next lesson, we'll run an existing workflow on Terra.