Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
habrok:connecting_to_the_system:connecting_via_vsc [2024/05/13 14:21] – adminhabrok:connecting_to_the_system:connecting_via_vsc [2026/04/28 12:52] (current) – [Connecting with VS Code via SSH] pedro
Line 1: Line 1:
 ====== Advanced: Connecting to Hábrók with Visual Studio Code ====== ====== Advanced: Connecting to Hábrók with Visual Studio Code ======
  
-[[https://code.visualstudio.com/|Microsoft Visual Studio Code]] (VS Code) is a popular source code editor and IDE that is available for free and which can run on Linux, Windows and macOS systems. It allows connecting to remote environments and working from them and the installation of extensions to support different programming languages and make use of additional development tools. Because of this, it is suitable for connecting to Hábrók to perform software development tasks.+[[https://code.visualstudio.com/|Microsoft Visual Studio Code]] (VS Code) is a popular source code editor and IDE that is available for free and which can run on Linux, Windows and macOS systems. It allows connecting to remote environments and working from them and the installation of extensions to support different programming languages and make use of additional development tools. Because of this, it is suitable for connecting to Hábrók to perform software development tasks. There are two main ways to use VS Code from Hábrók, either by connecting your local VS Code installation client via SSH to a VS Code server running in one of the access nodes, or by running it directly on your browser through our [[https://portal.hb.hpc.rug.nl/|web portal]].
  
-===== Connecting with VS Code to a login node=====+There is a separate section on using Python virtual environments: [[../examples/vscode_python]] 
 + 
 +===== Using the web portal ===== 
 +The simplest and most straightforward way of using VS Code on Hábrók is by using our [[https://portal.hb.hpc.rug.nl/|web portal]]. Simply login with your university account and open the VS Code Server Interactive App by navigating in the top bar to Interactive Apps -> VS Code Server or by clicking the shortcut in the main page after logging in. From the VS Code Server page, you can queue a job with the necessary memory and CPU requirements for your use case and the root directory for your VS Code session. After that, simply launch the job and wait for a while until your job begins, often this takes only just a moment.  
 + 
 +As soon as the job has started and is ready, you should see a blue button to Connect to VS Code. This will automatically start up your VS Code session in the compute node your job is running. 
 + 
 +If you are using VS Code to program in Python, you should take a look at the [[..:examples:vscode_python|]] documentation page to be setup your environment. 
 +===== Connecting with VS Code via SSH ===== 
 +<WRAP center round tip 60%> 
 +Connecting via SSH requires the setup below, which involves a number of steps. If you simply mean to quickly edit a script or do basic software development, then the web portal method described above will likely provide a much more streamlined user experience. If you require advanced features provided by the local Visual Studio Code installation on your PC, or want to frequently execute your code on local files, then the setting up the SSH connection may be worthwhile. 
 +</WRAP> 
 + 
 +If you'd like to run the VS Code client natively in your desktop, you can also do so by setting up a Remote-SSH connection. This takes some additional setup when compared with the connection via the [[https://portal.hb.hpc.rug.nl/|web portal]]. 
 + 
 +==== Connecting with VS Code via SSH to an access node ====
  
   - If you haven't already you will need to install the Remote-SSH extension for VS Code: [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote-SSH]]   - If you haven't already you will need to install the Remote-SSH extension for VS Code: [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote-SSH]]
Line 18: Line 33:
  
  
-===== Connecting with VS Code to a compute node=====+==== Connecting with VS Code via SSH to a compute node ====
  
 In addition to connecting to one of the login or interactive nodes, you may choose to connect directly to a compute node in order to have a similar environment and restrictions as you have for your compute jobs. You could even use a debugger to interactively debug your program in an identical environment as those your jobs run in. To do so, you should follow the same instructions as above, but there are a few extra steps and details to take into account: In addition to connecting to one of the login or interactive nodes, you may choose to connect directly to a compute node in order to have a similar environment and restrictions as you have for your compute jobs. You could even use a debugger to interactively debug your program in an identical environment as those your jobs run in. To do so, you should follow the same instructions as above, but there are a few extra steps and details to take into account:
Line 24: Line 39:
   * Connect to Hábrók to any of the login nodes as normal (via a terminal, MobaXterm, or the web portal) and submit a job to the desired node type and with the desired settings. This job should not do anything, so you can use the ''sleep'' command to ensure it stays open. Here is an example:   * Connect to Hábrók to any of the login nodes as normal (via a terminal, MobaXterm, or the web portal) and submit a job to the desired node type and with the desired settings. This job should not do anything, so you can use the ''sleep'' command to ensure it stays open. Here is an example:
  
-    #!/bin/bash +<code bash> 
-    #SBATCH --time=00:30:00 +#!/bin/bash 
-    #SBATCH --partition=regular +#SBATCH --time=00:30:00 
-    #SBATCH --nodes=1 +#SBATCH --partition=regular 
-    #SBATCH --cpus-per-task=4 +#SBATCH --nodes=1 
-    #SBATCH --mem=8GB +#SBATCH --cpus-per-task=4 
-     +#SBATCH --mem=8GB 
-    sleep 1800 +  
 +sleep 1800 
 +</code>
   * Once the job is running, you can find out what node has been assigned to it with ''squeue''. You will need this information later.   * Once the job is running, you can find out what node has been assigned to it with ''squeue''. You will need this information later.
   * Press ''Ctrl+P'' or ''Command+P'' once more and enter "Connect to Host".   * Press ''Ctrl+P'' or ''Command+P'' once more and enter "Connect to Host".
   * From the drop-down menu, select "+ Add New SSH Host...".   * From the drop-down menu, select "+ Add New SSH Host...".
-  * Input the ''ssh'' command to connect, but this time with the information to connect to the relevant compute node. Assuming your job is running on ''node2'', you would write: ''ssh -J pNUMBER@login1.hb.hpc.rug.nl node2''.+  * Input the ''ssh'' command to connect, but this time with the information to connect to the relevant compute node. Assuming your job is running on ''node2'', you would write: ''ssh -J pNUMBER@login1.hb.hpc.rug.nl pNUMBER@node2''.
   * You will then be asked what configuration file to save the information at. Any of the suggested options should work, the ''.ssh/config/'' you presumably have on your home directory is a good option.   * You will then be asked what configuration file to save the information at. Any of the suggested options should work, the ''.ssh/config/'' you presumably have on your home directory is a good option.
   * Again press ''Ctrl+P'' or ''Command+P'' and write "Connect to Host". Then, choose the appropriate connection, in this case ''node2''.   * Again press ''Ctrl+P'' or ''Command+P'' and write "Connect to Host". Then, choose the appropriate connection, in this case ''node2''.