VS Code essentials

Back to Resources

Use VS Code to edit files, run Python, and review Git changes.

Install and open your project

1. Install VS Code.
2. Open File > Open Folder. Select your project folder, not one file.
3. Open Extensions. Install Python from Microsoft. Install Jupyter from Microsoft only if you use .ipynb notebooks.
4. Open Terminal > New Terminal. Run commands from the project folder.
5. Press Ctrl+Shift+P on Windows/Linux, or Cmd+Shift+P on macOS, to open the Command Palette.

Install the extensions you need

Open Extensions and search by name. Check that the publisher is Microsoft. Install Python for Python code, Jupyter for notebooks, and Remote - SSH only for remote server work. Add other extensions when a project needs them.

Select Python and run a file

1. Create a project environment with the next guide.
2. Open the Command Palette. Run Python: Select Interpreter.
3. Choose the Python inside your project’s .venv, or choose your named Conda environment.
4. Create hello.py:

print("My project is ready")

1. Save the file. Click Run Python File at the top of the editor.
2. Read the result in the terminal. If it fails, check the selected interpreter first.

Find errors with the debugger

1. Click beside a line number to add a breakpoint.
2. Open Run and Debug. Start Python Debugger: Current File if VS Code asks for a configuration.
3. Read the variable values when the program pauses.
4. Use Step Over to run the next line. Use Continue to run to the next breakpoint.

The Microsoft Python extension installs the Python Debugger extension. You do not need a separate code-runner extension for these steps. Official debugging guide.

Use notebooks and Git carefully

• Open a notebook. Click Select Kernel at the top right. Choose the same environment as your project. A notebook kernel can differ from the Python interpreter used for .py files.
• Run all cells from top to bottom before sharing results. A cell must not depend on a hidden earlier test.
• Open Source Control before each commit. Click each changed file and read the difference.
• Commit related changes with a short message. Pull before starting new work. Push after the commit.
• If Git reports a conflict, open the file and compare both versions. Ask for help if the correct version is unclear. Do not use force push to fix a conflict.

Official guides: Python in VS Code, Python environments, Source Control, and Jupyter notebooks.

Open an approved lab server with SSH

Use these steps only after you receive the server address and your account from the lab.

1. Install Remote - SSH from Microsoft in VS Code.
2. Check that SSH works in your computer’s terminal. Replace username and HOSTNAME with your lab details:

ssh username@HOSTNAME

1. Compare the server fingerprint with the details given by the server administrator before accepting a new host. Sign in with your assigned account.
2. In VS Code, open the Command Palette. Run Remote-SSH: Connect to Host. Enter the same address.
3. After it connects, use File > Open Folder to open your project on the server.
4. Install the Python extension in the remote window when VS Code asks. Create or select the Python environment on the server. Your laptop’s environment is separate.
5. Open a terminal and check its folder before running commands. Save changes before you disconnect.

The remote window edits and runs files on the server. Ask the lab for its account, storage, and GPU rules before starting a long job. Official Remote SSH guide.

Learn these first shortcuts

Use Terminal > New Terminal to open a terminal. Use Preferences: Open Keyboard Shortcuts to find or change other shortcuts. Keyboard shortcut guide.

Fix common problems

Use File > Preferences > Settings on Windows/Linux, or Code > Settings > Settings on macOS, for editor settings. Use the Workspace tab for project-only changes. Keep shared settings small. Settings guide.