PyCharm Remote Development Setup Guide for BGU HPC Cluster

Introduction

This guide explains the one-time setup required to configure a PyCharm workspace on the BGU HPC cluster. Once configured, you can refer to the streamlined usage guide.

Prerequisites

  • Completed the SSH setup guide.

  • Have access to the BGU HPC cluster with VPN/internal network.

Configuring PyCharm for Remote Development

Submit a PyCharm Workspace

Use runai-bgu submit to submit a PyCharm workspace:

$ ssh bhn20 (1)
$ runai-bgu submit pycharm \ (2)
  -n pycharm-setup \ (3)
  -c 2 \ (4)
  -m 4Gi \ (5)
  -g 0.1  (6)
1 Configure SSH connection to bhn20
2 Specifies it is a PyCharm.
3 Specifies the name of the job.
4 Allocates 2 CPU cores.
5 Allocates 4GiB of memory*.
6 Specifies the GPU allocation (whole or fractional). If you do not need a GPU, omit this flag.

Open PyCharm Remote Development

Launch PyCharm.

In the project selection screen, choose Remote Development  SSH.

Click New Project.

PyCharm welcome screen/project selection

Configure SSH Connection

Fill in the following fields:

  • Username: Your BGU account username.

  • Host: bhn20.

  • Port: Enter the assigned port from the runai-bgu CLI.

  • Private Key: Check the "Specify private key" box, click the button, and select your private key.

The private key must match the public key you uploaded to bhn20 during SSH setup.

Click Check connection and Continue.

New SSH project configuration screen

Select Project Directory

When prompted, specify the project directory:

  • Enter ~ to access your home directory.

  • Alternatively, specify a subdirectory if your project is stored elsewhere.

Click Download IDE and Connect.

Choosing project directory

Configure Python Interpreter

If prompted with "No Python interpreter is configured for the project":

Click Configure Python Interpreter  Add New Interpreter  Add Local Interpreter.

PyCharm "No interpreter" warning

In the configuration window:

  1. Select Conda Environment.

  2. Choose Use existing environment.

  3. Select your environment from the list.

  4. Click OK.

Selecting an interpreter for the project in PyCharm

If your environment is missing from the list, ensure the Python executable is available by running:

$ conda install -n <your_env> python

Next Steps

Your PyCharm Remote Development setup is done! You can now refer to the streamlined usage guide to start using PyCharm for your work.

Good luck!