Development/VS Code - Revision history

S Braun at 09:32, 21 April 2026

2026-04-21T09:32:28Z

← Older revision		Revision as of 11:32, 21 April 2026
Line 113:		Line 113:



	<!--
	== Connect to Remote Jupyter Kernel ==		== Connect to Remote Jupyter Kernel ==
	To work with your python scripts and notebooks within VSCode while using the resources of a compute node, you can create a batch job that launches JupyterLab and connect to it via VS Code. To do so, please follow the instructions below. Any parts of the scripts that might need adjustments are marked with the keyword "@params".		To work with your python scripts and notebooks within VSCode while using the resources of a compute node, you can create a batch job that launches JupyterLab and connect to it via VS Code. To do so, please follow the instructions below. Any parts of the scripts that might need adjustments are marked with the keyword "@params".
Line 346:		Line 346:
	#rm $slurm_out		#rm $slurm_out
	</syntaxhighlight>		</syntaxhighlight>
	-->

S Braun at 07:31, 21 April 2026

2026-04-21T07:31:33Z

← Older revision		Revision as of 09:31, 21 April 2026
Line 6:		Line 6:

	== Visual Studio Code ==		== Visual Studio Code ==
	Visual Studio Code (VS Code) is a lightweight, extensible code editor from Microsoft that supports many programming languages and features like ~~IntelliSense,~~ debugging, and integrated Git. It offers a rich extension marketplace to add language support, themes, and tools tailored to your workflow. VS Code runs on Windows, macOS, and Linux and is popular for its speed, customizability, and strong community ecosystem.		Visual Studio Code (VS Code) is a lightweight, extensible code editor from Microsoft that supports many programming languages and features like debugging, and integrated Git. It offers a rich extension marketplace to add language support, themes, and tools tailored to your workflow. VS Code runs on Windows, macOS, and Linux and is popular for its speed, customizability, and strong community ecosystem.

	=== Using AI agents ===		=== Using AI agents ===
Line 51:		Line 51:
	=== Access to Compute Nodes ===		=== Access to Compute Nodes ===

	The workflow described above does not allow debugging on compute nodes that have been requested via an interactive Slurm job, for example~~. The security settings prevent the login node from being used as a proxy jump host. So there is no direct way to connect your locally installed VS code to the compute nodes~~. Debugging GPU codes is therefore also not possible, since this kind of resource is only accessible within Slurm jobs~~. Please have a look at the overview table in the first chapter to see which solution to follow~~.		The workflow described above does not allow debugging on compute nodes that have been requested via an interactive Slurm job, for example. Debugging GPU codes is therefore also not possible, since this kind of resource is only accessible within Slurm jobs.
			We strongly discourage using the Code Tunnel application, as it violates our access policies. In this scenario, an application running on the compute node connects to a Microsoft or GitHub server. The locally running VS Code then connects to the compute nodes via these external servers, thereby bypassing the login nodes.

			<!--
			Access the compute nodes via VS Code and the Remote-SSH plugin is only possible, if you start a temporarily running SSH service on the compute node which listens to an unprivileged port. By tunneling this port to your local computer, you can connect VS code to it.
			-->

	== Code-Server ==		== Code-Server ==

	The application [https://github.com/cdr/code-server code-server] allows to run the server part of VS Code on any machine, it can be accessed in the web browser. This enables, for example, development and debugging on compute nodes.		The application [https://github.com/cdr/code-server code-server] allows to run the server part of VS Code on any machine, it can be accessed in the web browser running on your local computer. This enables, for example, development and debugging on compute nodes.
	Code-server runs a web server which ~~runs~~ on an unprivileged port. In order to connect your web browser to the remotely running code server, you have to forward this port via a SSH tunnel.		Code-server runs a web server which serves on an unprivileged port. In order to connect your web browser to the remotely running code server, you have to forward this port via a SSH tunnel.

	[[File:code-server.png\|thumb\|code-server.png\|VS Code in web browser: code-server, Source: https://github.com/cdr/code-server">https://github.com/cdr/code-server\|400px]]		[[File:code-server.png\|thumb\|code-server.png\|VS Code in web browser: code-server, Source: https://github.com/cdr/code-server">https://github.com/cdr/code-server\|400px]]

S Braun at 07:12, 21 April 2026

2026-04-21T07:12:07Z

← Older revision		Revision as of 09:12, 21 April 2026
Line 5:		Line 5:
	[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development.		[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development.

	== VS Code ~~extension: Remote - SSH~~ ==		== Visual Studio Code ==
			Visual Studio Code (VS Code) is a lightweight, extensible code editor from Microsoft that supports many programming languages and features like IntelliSense, debugging, and integrated Git. It offers a rich extension marketplace to add language support, themes, and tools tailored to your workflow. VS Code runs on Windows, macOS, and Linux and is popular for its speed, customizability, and strong community ecosystem.

			=== Using AI agents ===
			When deploying AI agents on the bwHPC clusters, users must exercise extreme caution and maintain full oversight of the agent's activities. You are fully responsible for all actions initiated by an agent, including any security breaches or system disruptions it may cause. It is mandatory to strictly monitor resource usage on login nodes, as these are shared resources intended only for lightweight tasks. Any agent found consuming excessive CPU or memory on a login node will be terminated immediately to ensure stability for other users. To comply with usage policies, all AI-driven workloads which generate heavy load must be submitted to the Slurm batch queues rather than running directly on the login nodes.

			=== Extension: Remote-SSH ===

	In order to remotely develop and debug code at HPC facilities, you can use the [https://code.visualstudio.com/docs/remote/ssh '''Remote - SSH''' extension]. The extension allows you to connect your locally installed VS Code with the remote servers. So in contrast to using graphical IDEs within a remote desktop session (RDP, VNC), there are no negative effects like e.g. laggy reactions to your input or blurred display of fonts.		In order to remotely develop and debug code at HPC facilities, you can use the [https://code.visualstudio.com/docs/remote/ssh '''Remote - SSH''' extension]. The extension allows you to connect your locally installed VS Code with the remote servers. So in contrast to using graphical IDEs within a remote desktop session (RDP, VNC), there are no negative effects like e.g. laggy reactions to your input or blurred display of fonts.

	=== Installation and Configuration ===		==== Installation and Configuration ====

	[[File:vscode-extensions-button.png\|vscode-extensions-button.png\|30px]]<br>		[[File:vscode-extensions-button.png\|vscode-extensions-button.png\|30px]]<br>
Line 27:		Line 33:
	User xy_ab1234		User xy_ab1234

	=== Connect to Login Nodes ===		==== Connect to Login Nodes ====

	[[File:vscode-remoteexplorer-button.png\|vscode-remoteexplorer-button.png\|30px]]<br>		[[File:vscode-remoteexplorer-button.png\|vscode-remoteexplorer-button.png\|30px]]<br>
Line 38:		Line 44:
	Extensions, which are installed locally, are only usable on your local machine and are not automatically installed remotely. However, as soon as you open the Extensions-Explorer during a remote session, VS Code proposes to install the locally installed extensions remotely.		Extensions, which are installed locally, are only usable on your local machine and are not automatically installed remotely. However, as soon as you open the Extensions-Explorer during a remote session, VS Code proposes to install the locally installed extensions remotely.

	=== Disconnect from Login Nodes ===		==== Disconnect from Login Nodes ====

	[[File:vscode-remoteexplorer-indicator.png\|images/vscode-remoteexplorer-indicator.png\|200px]]<br>		[[File:vscode-remoteexplorer-indicator.png\|images/vscode-remoteexplorer-indicator.png\|200px]]<br>

S Braun at 07:04, 21 April 2026

2026-04-21T07:04:43Z

@@ Line 8: / Line 8: @@
 In order to remotely develop and debug code at HPC facilities, you can use the [https://code.visualstudio.com/docs/remote/ssh '''Remote - SSH''' extension]. The extension allows you to connect your locally installed VS Code with the remote servers. So in contrast to using graphical IDEs within a remote desktop session (RDP, VNC), there are no negative effects like e.g. laggy reactions to your input or blurred display of fonts.
 === Installation and Configuration ===
@@ Line 50: / Line 49: @@
 == Code-Server ==
-The application [https://github.com/cdr/code-server code-server] allows to run the server part of VS Code on any machine, it can be accessed in the web browser. This enables, for example, development and debugging on compute nodes.<br>
+The application [https://github.com/cdr/code-server code-server] allows to run the server part of VS Code on any machine, it can be accessed in the web browser. This enables, for example, development and debugging on compute nodes.
 [[File:code-server.png|thumb|code-server.png|VS Code in web browser: code-server, Source: https://github.com/cdr/code-server">https://github.com/cdr/code-server|400px]]
@@ Line 56: / Line 56: @@
 === Install Code-Server ===
 === Start Code-Server ===
@@ Line 131: / Line 101: @@
 If you want to temporarily log out from your code-server session you can open the “Application Menu” in the left side bar and click on “Log out”. To '''terminate''' the code-server session, you have to cancel it in the interactive Slurm job by pressing ++ctrl+c++.
 == Connect to Remote Jupyter Kernel ==
 To work with your python scripts and notebooks within VSCode while using the resources of a compute node, you can create a batch job that launches JupyterLab and connect to it via VS Code. To do so, please follow the instructions below. Any parts of the scripts that might need adjustments are marked with the keyword "@params".
@@ Line 363: / Line 335: @@
 #rm $slurm_out
 </syntaxhighlight>

S Braun at 06:48, 21 April 2026

2026-04-21T06:48:13Z

← Older revision		Revision as of 08:48, 21 April 2026
Line 5:		Line 5:
	[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development.		[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development.

	== Remote - SSH ==		== VS Code extension: Remote - SSH ==

	In order to remotely develop and debug code at HPC facilities, you can use the [https://code.visualstudio.com/docs/remote/ssh '''Remote - SSH''' extension]. The extension allows you to connect your locally installed VS Code with the remote servers. So in contrast to using graphical IDEs within a remote desktop session (RDP, VNC), there are no negative effects like e.g. laggy reactions to your input or blurred display of fonts.		In order to remotely develop and debug code at HPC facilities, you can use the [https://code.visualstudio.com/docs/remote/ssh '''Remote - SSH''' extension]. The extension allows you to connect your locally installed VS Code with the remote servers. So in contrast to using graphical IDEs within a remote desktop session (RDP, VNC), there are no negative effects like e.g. laggy reactions to your input or blurred display of fonts.
Line 20:		Line 20:
	[[File:vscode-remoteexplorer-add.png\|vscode-remoteexplorer-add.png\|350px]]<br>		[[File:vscode-remoteexplorer-add.png\|vscode-remoteexplorer-add.png\|350px]]<br>
	If there are no remote ssh targets defined within this file, you can easily add one by clicking on the + symbol. Make sure that “SSH Targets” is active in the drop down menu of the Remote-Explorer. Enter the connection details <code><user>@<server></code>. You will be asked, whether the file <code>~/.ssh/config</code> should be modified or if another config file should be used or created.		If there are no remote ssh targets defined within this file, you can easily add one by clicking on the + symbol. Make sure that “SSH Targets” is active in the drop down menu of the Remote-Explorer. Enter the connection details <code><user>@<server></code>. You will be asked, whether the file <code>~/.ssh/config</code> should be modified or if another config file should be used or created.

			A minimal entry within <code>~/.ssh/config</code> in order to have a remote target to be listed there could look like this:

			$ cat ~/.ssh/config
			Host uc3.scc.kit.edu
			HostName uc3.scc.kit.edu
			User xy_ab1234

	=== Connect to Login Nodes ===		=== Connect to Login Nodes ===

S Braun at 06:38, 21 April 2026

2026-04-21T06:38:30Z

@@ Line 3: / Line 3: @@
 [[File:vscode.png|thumb|Visual Studio Code, Source: https://code.visualstudio.com/|450px]]
-[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development. From the following table you can see which instructions you need to follow to develop on a bwHPC cluster with VS Code.
+[https://github.com/Microsoft/vscode Visual Studio Code] (VS Code) is an open source source-code editor from Microsoft. It has become one of the most popular IDEs according to a [https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment stackoverflow survey]. The functionality of VS Code can easily be extended by installing extensions. These extensions allow for almost arbitrary '''language support''', '''debugging''' or '''remote development'''. You can install VS Code locally and use it for remote development.
 == Remote - SSH ==
@@ Line 64: / Line 48: @@
 === Install Code-Server ===
 If no code-server module is provided, you can install it yourself.

P Schuhmacher: /* Connect to code-server */

2025-10-29T14:14:44Z

Connect to code-server

← Older revision		Revision as of 16:14, 29 October 2025
Line 110:		Line 110:
	As soon as code-server is running, it can be accessed in the web browser. In order to establish the connection, a SSH tunnel from your local computer to the remote server has to be created via:		As soon as code-server is running, it can be accessed in the web browser. In order to establish the connection, a SSH tunnel from your local computer to the remote server has to be created via:

	<syntaxhighlight lang="console">$ ssh -L 8081:<computeNodeID>:8081 <userID>@hk.scc.kit.edu</syntaxhighlight>		<syntaxhighlight lang="console">$ ssh -L 8081:<computeNodeID>:8081 <userID>@uc3.scc.kit.edu</syntaxhighlight>
	You need to enter the <code>computeNodeID</code> of the node on which the interactive Slurm job is running. If you have started code server on a login node, just enter <code>localhost</code>. Now you can open http://127.0.0.1:8081 in your web browser. Possibly, you have to allow your browser to open an insecure (non-https) site. The login site looks as follows:		You need to enter the <code>computeNodeID</code> of the node on which the interactive Slurm job is running. If you have started code server on a login node, just enter <code>localhost</code>. Now you can open http://127.0.0.1:8081 in your web browser. Possibly, you have to allow your browser to open an insecure (non-https) site. The login site looks as follows:

Line 117:		Line 117:

	Enter the password from <code>~/.config/code-server/config.yaml</code> or from the <code>PASSWORD</code> variable. After clicking the “Submit” button, the familiar VS Code interface will open in your browser.		Enter the password from <code>~/.config/code-server/config.yaml</code> or from the <code>PASSWORD</code> variable. After clicking the “Submit” button, the familiar VS Code interface will open in your browser.


	=== End code-server session ===		=== End code-server session ===

H Schumacher: Added code-server installation instructions

2025-08-12T07:06:32Z

Added code-server installation instructions

@@ Line 1: / Line 1: @@
 == Overview ==
@@ Line 17: / Line 16: @@
 |-
 !scope="column"| Other
-| Setup with [[Development/VS_Code#Connect_to_Remote_Jupyter_Kernel | Jupyter kernel]]
+| Setup with [[Development/VS_Code#Connect_to_Remote_Jupyter_Kernel | Jupyter kernel]] or [[Development/VS_Code#Install_Code-Server | install Code-Server]]
 | -
 |-
@@ Line 64: / Line 63: @@
 [[File:code-server.png|thumb|code-server.png|VS Code in web browser: code-server, Source: https://github.com/cdr/code-server">https://github.com/cdr/code-server|400px]]
 === Start Code-Server ===

H Schumacher: Fixed mistake in regex

2025-08-04T12:46:38Z

Fixed mistake in regex

← Older revision		Revision as of 14:46, 4 August 2025
Line 178:		Line 178:

	# Extract hostID and port from output. The pattern assumes a node name with a length of 6 characters and a port with a length of 3, 4 or 5 numbers.		# Extract hostID and port from output. The pattern assumes a node name with a length of 6 characters and a port with a length of 3, 4 or 5 numbers.
	url_pattern="http://([a-z0-9]{6}):([1-9]{3,5})/lab"		url_pattern="http://([a-z0-9]{6}):([0-9]{3,5})/lab"
	if [[ $url =~ $url_pattern ]]; then		if [[ $url =~ $url_pattern ]]; then
	hostID=${BASH_REMATCH[1]}		hostID=${BASH_REMATCH[1]}
Line 323:		Line 323:

	# Extract hostID and port from output.		# Extract hostID and port from output.
	url_pattern="http://([a-z0-9]{6}):([1-9]{3,5})/lab"		url_pattern="http://([a-z0-9]{6}):([0-9]{3,5})/lab"
	if [[ $url =~ $url_pattern ]]; then		if [[ $url =~ $url_pattern ]]; then
	hostID=${BASH_REMATCH[1]}		hostID=${BASH_REMATCH[1]}

H Schumacher: Fixed error in regex

2025-07-07T13:53:23Z

Fixed error in regex

← Older revision		Revision as of 15:53, 7 July 2025
Line 178:		Line 178:

	# Extract hostID and port from output. The pattern assumes a node name with a length of 6 characters and a port with a length of 3, 4 or 5 numbers.		# Extract hostID and port from output. The pattern assumes a node name with a length of 6 characters and a port with a length of 3, 4 or 5 numbers.
	url_pattern="http://([a-z0-9]{6}):([1-9]{3,4,5})/lab"		url_pattern="http://([a-z0-9]{6}):([1-9]{3,5})/lab"
	if [[ $url =~ $url_pattern ]]; then		if [[ $url =~ $url_pattern ]]; then
	hostID=${BASH_REMATCH[1]}		hostID=${BASH_REMATCH[1]}
Line 323:		Line 323:

	# Extract hostID and port from output.		# Extract hostID and port from output.
	url_pattern="http://([a-z0-9]{6}):([1-9]{4})/lab"		url_pattern="http://([a-z0-9]{6}):([1-9]{3,5})/lab"
	if [[ $url =~ $url_pattern ]]; then		if [[ $url =~ $url_pattern ]]; then
	hostID=${BASH_REMATCH[1]}		hostID=${BASH_REMATCH[1]}