Python IDEs

On this page, you will learn about various Python IDEs. An IDE (Integrated Development Environment) is a program dedicated to software development. It usually provides an editor designed to handle code (with, for example, syntax highlighting and auto-completion) as well as features such as build automation, code linting, testing and debugging. This can significantly speed up your work.

If you don't have an IDE yet, we recommend you go with Visual Studio Code (see below).

Visual Studio Code

VS Code is a full-featured IDE available for Linux, Mac OS X, and Windows platforms. Small and light-weight, but full-featured, VS Code is configurable for almost any task. It can easily be downloaded from the official VS Code page.

Installing Python support in VS Code is very accessible: the Marketplace is a quick button click away. Search for Python, click Install, and restart if necessary. It will recognize your Python installation and libraries automatically.

PyCharm

PyCharm is a highly popular and feature-rich IDE for Python development, appreciated by both beginners and experienced developers alike. Its robust set of tools, intelligent code assistance, and seamless integration with popular frameworks make it a valuable asset for Python programmers, enabling them to write high-quality code efficiently. It can easily be downloaded from the official Jet Brains page.

Remote Debugging

For remote debugging with your IDE, first start an interactive job on SOL. To run an interactive job, the srun command is used along with specific options. These options convey the resource requirements, such as the desired number of nodes, memory allocation, and time limit for the job (make sure to add the --no-container-remap-root flag).

srun
  --qos=low \
  --ntasks=1 \
  --gpus-per-task=0 \
  --cpus-per-task=4 \
  --mem=8G \
  --time=4:00:00 \
  --no-container-remap-root \
  --container-mounts=/data/bodyct:/data/bodyct \
  --container-image="doduo1.umcn.nl#uokbaseimage/diag:tf2.10-pt1.12-v1" \
  --pty bash

This command will open up a bash terminal from inside your running container. Pick an access port (e.g. 5574) and kick off the sshd service by typing /usr/sbin/sshd -p <port> in this terminal. This will expose a port in your container, which allows communication with your IDE. As a result, you can run debug sessions directly from your IDE inside your running docker container. You will need to properly setup your IDE, as is described below.

VS Code

Once you have completed the steps above, you can take a look at the following page on how to connect your running container to VS Code.

PyCharm

Once you have completed the previous steps, follow the PyCharm tutorial.