Skip to content

Commit

Permalink
Merge pull request #1 from albarema/main
Browse files Browse the repository at this point in the history
Updating ucloud manual for beginners
  • Loading branch information
jenbartell authored Feb 20, 2024
2 parents c362df1 + 743aabb commit dc922e6
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 18 deletions.
66 changes: 48 additions & 18 deletions develop/access/UCloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,70 @@ User accounts on UCloud are enabled by university login credentials using WAYF (

Each Danish university has its own usage relationship with UCloud as governed by their local front office of [DeiC](https://www.deic.dk/en) - check with your university IT support / DeiC representatives about requesting computational resources. For example, the University of Copenhagen has previously allotted an initial chunk of free UCloud compute hours to staff (from PhD students to professors as well as non-academic staff). If you have further questions about getting compute resources, please [contact](https://hds-sandbox.github.io/contact) Sandbox staff.

Extensive documentation on general use of UCloud (how to use apps and run jobs, etc.) is available in the UCloud [user guide](https://docs.cloud.sdu.dk/).
Extensive documentation on the general use of UCloud (how to use apps and run jobs, etc.) is available in the UCloud [user guide](https://docs.cloud.sdu.dk/).

## Example: how to open a Sandbox app

**Step 1** Log onto UCloud at the address [http://cloud.sdu.dk](http://cloud.sdu.dk) using university credentials.
### **Step 1**

Log onto UCloud at the address [http://cloud.sdu.dk](http://cloud.sdu.dk) using university credentials.

**Step 2** When you are logged in, choose the project from which you'd like to use compute resources (red circle). You can provision your own project (check with your local DeiC office if you're new to UCloud) or you can be invited to someone else's project. If you've joined one of our courses or workshops, your instructor will let you know which to choose. For this example, we select Sandbox_workshop.
![](../assets/images/workspace.png)

### **Step 2**

**Step 3** Then click on Apps in the left panel to investigate what tools and environments you can use (green circle). The easiest way to find Sandbox resources is to search via the toolbar (red circle). In this example, we'll choose the Genomics Sandbox.
![](../assets/images/apps.png)
When you are logged in, choose the project from which you'd like to use compute resources (red circle). Every user has their personal workspace (*Your workspace*). You can also provision your own project (check with your local DeiC office if you're new to UCloud) or you can be invited to someone else's project. If you've previously selected a project, it will be launched by default. If it's your first time, you'll be in your workspace. If you've joined one of our courses or workshops, your instructor will let you know which to choose. For this example, we select Sandbox_workshop.

> ![](../assets/images/workspace.png)
On the left side, you can see the structure of the project (content changes when you select a different project).

- **Files**: all folders/files you have access to. You can navigate through folders, download, upload, or share files with collaborators. You might have varying rights across folders, mostly depending on whether they are yours or have been shared with you
- **Projects**: you have been invited to
- **Resources**
- **Apps**: access to apps catalog. Recommended to look into the featured ones
- **Runs**: from where you submit your jobs and past runs information

### **Step 3**

Then click on Apps in the left panel to investigate what tools and environments you can use (green circle). The easiest way to find Sandbox resources is to search via the toolbar (red circle). In this example, we'll choose the Genomics Sandbox.

> ![](../assets/images/apps.png)

### **Step 4**

Click on the app button. You will get into the settings window. First, we recommend reading the documentation of the app (green square). Then, you can configure the app as shown below, or be provided with a configuration file made available in a workshop's project folders (*import parameters*) which will take care of everything for you.

> ![](../assets/images/configure_NGS.png)
**Step 4** Click on the app button. You will get into the settings window. You can configure the app as shown below, or be provided with a configuration file made available in a workshop's project folders which will take care of everything for you.
![](../assets/images/configure_NGS.png)
In this example, we configure our session by:

1. entering a job name

2. selecting hours of time we want to use a node

2. selecting hours of time we want to use a node (it can be modified afterward)
3. selecting a 4 CPU standard node with 24 GB memory

4. choosing the course "Introduction to NGS Data Analysis"

5. hitting submit (there may be a wait)
5. optional: add folders to access while in this job
6. hitting submit (there may be a wait)

The first 3 steps set up our computing resources for the period we want to work and can be customized as needed. However, **only step 2 can be modified after submitting the job**. For some of the Sandbox apps, you might want to select folders (Home and the Notebooks/Data from the module to avoid downloading it every time you start a new job). If you are in doubt, read the documentation specific to the app you are interested in.


### **Step 5**

Wait to go through the queue. When the session starts, the timer begins to count down. In a couple of minutes, you should be able to open the interface through the button (green circle) in a new window (refresh the window if needed).

> ![](../assets/images/running_NGS.png)
This page will remain open while you work (or you can return to it via 'Runs' in the left panel). You can end your session early by pressing and holding 'Stop application' (pink circle), you can see how much time you have left (red circle) and you can add hours to your session as you go (buttons in blue square).

### **Step 6**

The first 3 steps set up our compute resources for the period we want to work and can be customized as needed.
If you are testing the genomic app, your interface should look like in the image below. Different apps might use other development environments. In this case, you will be working from [JupyterLab](https://jupyter.org/). You can open Jupyter Notebooks (yellow square), R studio (blue square) or a terminal (black square) among others. In this case, #1 and #2 have all the software and packages that you will need pre-installed (this is not the case with Python 3 to the left).

> ![](../assets/images/interface_jupyterlab.png)
**Step 5** Wait to go through the queue. When the session starts, the timer begins to count down. In a couple of minutes you should be able to open the interface through the button (green circle).
You can navigate through the different folders and start running the Python notebooks (pink arrow).

![](../assets/images/running_NGS.png)
> ![](../assets/images/openning_notebook.png)
This page will remain open while you work (or you can return to it via 'Runs' in the left panel). You can end your session early by pressing and holding 'Stop application' (pink circle), you can see how much time you have left (red circle) and you can add hours to your session as you go (buttons in blue circle).
If you are an advanced user, you can also create your own Python files and select the kernel *NGS (python)* to use the pre-installed software. Watch videos on how to upload and download new data and share files that you have created/developed with collaborators [here](https://docs.cloud.sdu.dk/tutorials/tutorial1.html).
Binary file modified develop/assets/images/configure_NGS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added develop/assets/images/interface_jupyterlab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added develop/assets/images/openning_notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified develop/assets/images/running_NGS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dc922e6

Please sign in to comment.