Downloading & installing VS Code with Python support

Visual Studio Code (VS Code) is a powerful and popular Integrated Development Environment (IDE) that will help you with IPKISS development. It allows running and debugging your scripts and helps organizing your files and design projects.

This guide will walk you through installing VS Code and configuring it for Python development with IPKISS.

1. Installing VS Code

  1. Download the installer from https://code.visualstudio.com.

  2. Run the installer and follow the setup wizard instructions

2. Installing the Python extension

  1. In VS Code open the Command Palette with the Ctrl + P keyboard shortcut.

  2. Copy/Paste ext install ms-python.python in the dialog box and hit enter, the extension will now be installed.

3. Configuring the Python Environment

Setting up Conda

Now that VS Code and the Python extension are installed, you can continue to configure it to use the python interpreter distributed with the Luceda installer. This is necessary for VS Code to be able to run your IPKISS code.

  1. Open VS Code Settings by either using the Ctrl + , shortcut or by navigating to File ‣ Preferences ‣ Settings in the menutree.

  2. Search for ‘conda’ in the settings search bar

  3. Add the path to your conda executable, this will depend on your platform and the location of your installation:

    • Windows default path: C:\luceda\luceda_2025030\Scripts\conda.exe

    • Linux default path: $HOME/luceda/luceda_2025030/condabin/conda

    • Macos default path: ~/luceda/luceda_2025030/luceda/condabin/conda

Configure conda path in VS Code

You can now close the settings page.

Selecting The Python Interpreter

Now the last step left is selecting the Python executable that is distributed with the Luceda installer:

  1. Open the Command Palette, press the Ctrl + Shift + P shortcut or use the menu to access it

  2. Type “interpreter” and select “Python: Select Interpreter”

  3. Search for “2025030” in the dropdown

  4. Select the ‘ipkiss3’ interpreter from the list

Select the python interpreter.

4. Verifying your configuration

Your VS Code should now be ready to be used with ipkiss, you can test that this is the case by executing the following steps:

  1. Create a new Python file

    • Open Command Palette Ctrl + Shift + P

    • Search for and select ‘New Python File’

Create a new python file.
  1. Copy and paste the following test code:

import si_fab.all as pdk
import ipkiss3.all as i3

wg = i3.RoundedWaveguide().Layout(shape=[
    (0, 0),
    (20, 0),
    (20, 20)
])
wg.visualize()
  1. Run the code:

    • Right-click in the editor

    • Select Run Python File in Terminal Run Python ‣ Run Python File in Terminal

    • Save the file when prompted

If successful, you should see a visualization of a waveguide in the output window.

../../_images/vscode_result.png