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
Copy file name to clipboardExpand all lines: home_precourse.qmd
+65-44Lines changed: 65 additions & 44 deletions
Original file line number
Diff line number
Diff line change
@@ -7,69 +7,90 @@ sidebar: false
7
7
format: html
8
8
---
9
9
10
-
## Getting Started
11
10
12
-
Welcome to the course! Please follow these preparation instructions to ensure a smooth experience.
11
+
Welcome to the course! There are few things to do **before** the course starts. Please read carefully and follow the instructions so we can have a good start to the course. Contact us in case anything is unclear.
13
12
14
-
::: {.callout-tip}
15
13
16
-
### Critical Pre-Course Tasks
14
+
##HPC resources and creating an account
17
15
18
-
Before the course begins, make sure to:
16
+
During the course we will be using Uppsala University’s high performance computer cluster ([UPPMAX](https://docs.uppmax.uu.se/cluster_guides/uppmax_cluster/)) as well as run scripts locally on laptops using `R` and `RStudio`.
19
17
20
-
- Create your course account
21
-
- Download the course materials
22
-
- Test your internet connection
18
+
### Register at NAISS
23
19
24
-
:::
20
+
A NAISS account is needed to use UPPMAX resources. If you do not already have one, please register for an account at [NAISS](https://supr.naiss.se/person/register/) and then you must accept the user [agreement](https://supr.naiss.se/person/user_agreement/naiss/) either online or in paper form. For those within Swedish academia, it is recommended to register with your SWAMID. If you don’t have a SWAMID connected account, you will have to send in your signed user agreement in paper form together with a copy of your passport. Note that this manual process can take a week or more. You can follow this detailed [instruction](https://docs.uppmax.uu.se/getting_started/supr_register/). Once you have a NAISS account, please [request](https://docs.uppmax.uu.se/getting_started/join_existing_project/) membership to the project *UPPMAX 2026/X-XXX* --- check your email for the correct project number.
25
21
26
-
### Preparation Checklist
22
+
### Apply for an UPPMAX user account
27
23
28
-
| Task | Status | Deadline |
29
-
|------|--------|----------|
30
-
| Check your equipment compatibility | ☐ | 1 week before |
31
-
| Install required software | ☐ | 1 week before |
32
-
| Complete pre-course readings | ☐ | 3 days before |
33
-
| Join the course community | ☐ | At course start |
24
+
After you have been added to a NAISS project, you can now apply for a user account in UPPMAX if you do not have an existing account yet. This will be the account you use to log in to UPPMAX so it is not the same as your NAISS account. Note that it might take up to 2 working days for your account to be created. You will then receive 2 emails with information on how to login to UPPMAX. To activate your user account, click [here](https://supr.naiss.se/account/).
34
25
35
-
## System Requirements & Installation
36
26
37
-
### Hardware Requirements
27
+
##Working with the compute resources from UPPMAX
38
28
39
-
Your computer should meet the following *minimum* specifications:
29
+
There are three ways to connect to Pelle:
40
30
41
-
-**RAM**: 8 GB or more
42
-
-**Storage**: 20 GB available space
43
-
-**Processor**: Dual-core processor or better
44
-
-**Internet**: Reliable broadband connection
31
+
- An ssh connection from a terminal
32
+
- A graphical remote desktop using a Thinlinc client on your laptop
33
+
- A remote desktop environment via a web browser
45
34
46
-
::: {.callout-warning}
47
-
If your system does not meet these requirements, please contact support **before** the course begins.
48
-
:::
35
+
### SSH connection using a terminal
49
36
50
-
### Software Installation
37
+
A straightforward way to connect to Pelle is through a terminal using ssh connection.
51
38
52
-
Follow these steps to prepare your environment:
39
+
- For Linux users, use Terminal (included by default).
40
+
- For Mac users, use Terminal (included by default). You need to also install [XQuartz](https://www.xquartz.org/) to enable X11 forwarding from a terminal, i.e., to run graphical applications on a remote server while displaying them on your laptop.
41
+
- For Windows system, we recommend using [MobaXterm](http://mobaxterm.mobatek.net/). Please install the program and not use the portable version. MobaXterm also has a built-in X11 and an integrated SFTP file browser to transfer data between the remote cluster and your computer.
53
42
54
-
1.**Familiarize Yourself with the Course Platform**: Log in and explore available resources
55
-
2.**Install Development Tools**: Download and install any required software from the course syllabus
56
-
3.**Verify Installation**: Run the provided verification scripts to ensure everything is working
57
-
4.**Prepare Your Workspace**: Set up a dedicated folder for course materials
43
+
Other SSH clients and X-servers for MacOS and Windows are described [here](https://docs.uppmax.uu.se/software/ssh_client/#ssh-client).
58
44
59
-
##Community & Support
45
+
### GUI desktop using ThinLinc locally
60
46
61
-
::: {.callout-note}
62
-
We look forward to seeing you in the course! Here are resources to help you succeed:
63
-
:::
47
+
You can also connect to Pelle via a graphical remote desktop using a local ThinLinc client on your laptop. Thinlinc is useful if you need to view images or documents in GUI programs without having to first download the image/document to your own computer first. Since it is using graphics, it will require you to have an internet connection that is good and stable. Please install [ThinLinc](https://www.cendio.com/thinlinc/download/) to be able to access UPPMAX in this manner.
48
+
49
+
### GUI desktop using ThinLinc in a web browser
50
+
51
+
Lastly, you can connect to Pelle using a remote desktop environment via a web browser at [https://pelle-gui.uppmax.uu.se](https://pelle-gui.uppmax.uu.se/). This is the easiest option as no software installation is needed but it will give you the slowest connection. It will require you to have an internet connection that is good and stable. For this option, you have to set up your UPPMAX two factor authorization (2FA). See [how to get an UPPMAX 2FA](https://docs.uppmax.uu.se/getting_started/get_uppmax_2fa/).
52
+
53
+
54
+
### Additional instructions/resources
55
+
56
+
This [tutorial](https://docs.uppmax.uu.se/getting_started/login_pelle/) will guide you to connect to Pelle using the three methods as described above. For Windows users with MobaXterm, please follow this [instruction](https://docs.uppmax.uu.se/software/ssh_client/#using-ssh-with-different-terminals-that-allow-for-graphics).
57
+
58
+
Some useful tutorials:
59
+
60
+
-[Troubleshoot your MobaXterm X11 connection to UPPMAX](https://hackmd.io/@pmitev/UPPMAX-MobaXterm-X11)
61
+
-[File transfer to/from Pelle](https://docs.uppmax.uu.se/cluster_guides/transfer_pelle/)
62
+
-[Change your UPPMAX password](https://docs.uppmax.uu.se/getting_started/change_reset_uppmax_password/)
63
+
-[How to get an UPPMAX 2FA](https://docs.uppmax.uu.se/getting_started/get_uppmax_2fa/)
64
+
65
+
66
+
## Check configuration
67
+
68
+
After you complete setting-up and you receive a notification from NAISS that your account **has been added to the course allocation**.
69
+
70
+
1. Log in to [pelle.uppmax.uu.se](pelle.uppmax.uu.se)
71
+
2. Type id in the command line
72
+
3. Copy the output of the command and email back (to the course organisers at [edu.epigenomics@nbis.se](edu.epigenomics@nbis.se))
73
+
74
+
75
+
## Working from your local machine
76
+
77
+
To be able to work from your local machine, please make sure you have the following installed:
78
+
79
+
-`R-4.6.1` and `RStudio`. If you have other versions of `R` installed, you can used [rig](https://github.com/r-lib/rig) to version control `R` installation and start `RStudio` with different versions of `R`. We will be using `R-4.6.1` during the workshop.
80
+
- The [Integrative Genomics Viewer](https://software.broadinstitute.org/software/igv/).
81
+
82
+
### Cloning the repo and installing the needed `R` packages
83
+
84
+
More instructions will follow here on how to clone the GitHub repo of the workshop and install all needed R packages using `renv`.
85
+
86
+
87
+
## Additional (optional) reading material to help you prepare
88
+
89
+
-[Unix](http://www.ee.surrey.ac.uk/Teaching/Unix/): especially the first three chapters.
90
+
- DataCamp free [Introduction to R](https://www.datacamp.com/blog/all-about-r).
91
+
-[A short introduction to R](https://cran.r-project.org/doc/contrib/Torfs+Brauer-Short-R-Intro.pdf). A very short introduction to using `R`.
92
+
- How to install and use `RStudio` from [Data Camp RStudio Tutorial](https://www.datacamp.com/tutorial/r-studio-tutorial).
64
93
65
-
### Getting Help
66
94
67
-
| Resource | Purpose |
68
-
|----------|---------|
69
-
| Course Forum | Ask questions and connect with peers |
70
-
| Office Hours | One-on-one support from instructors |
71
-
| FAQ Section | Quick answers to common questions |
72
-
| Slack Channel | Real-time chat with the community |
73
95
74
-
**Remember**: Don't hesitate to reach out if you have any questions or concerns. We're here to help!
subtitle: "Instructions on how to work with the tutorials"
4
+
date: ""
5
+
toc: false
6
+
sidebar: false
7
+
format: html
8
+
---
9
+
10
+
11
+
Please make sure that you have followed the pre-course instructions before continuing with the instructions here.
12
+
13
+
14
+
## Working on Pelle (UPPMAX HPC)
15
+
16
+
We have booked 5 cores on Pelle per course participant. To run the tutorial in the interactive mode log on to Pelle and run interactive command:
17
+
18
+
```{r}
19
+
#| eval: false
20
+
ssh -Y <username>@pelle.uppmax.uu.se
21
+
```
22
+
23
+
24
+
While logged to Pelle, book the interactive session:
25
+
```{r}
26
+
#| eval: false
27
+
interactive -A uppmax2025-2-309 -p core -n 5 -t 08:00:00
28
+
```
29
+
30
+
This command gives you access to 5 cores for eight hours or until 17:00, whichever comes first. Please make sure you do it only ONCE per day, as by repeating this command you will use up resources reserved for others.
31
+
32
+
Check which node you were assigned
33
+
```{r}
34
+
#| eval: false
35
+
squeue -u <username>
36
+
```
37
+
38
+
39
+
And connect to your node with
40
+
```{r}
41
+
#| eval: false
42
+
ssh -Y <nodename>
43
+
```
44
+
45
+
46
+
If you lose connection to the server during a tutorial, please connect again to Pelle and do `ssh -Y <nodename>` again. You will reconnect to your set of cores.
47
+
48
+
49
+
## Working on your local machine
50
+
51
+
Instructions to follow.
52
+
53
+
## Structuring your folders and working directories
0 commit comments