IPKISS sample project¶
The IPKISS sample project contains a series of examples, and a demonstration PDK. In several places in the documentation, we refer to this samples folder.
The samples folder is located in your home folder under:
Where you need to replace the
ipkiss340 in the path with the actual version you’re using.
To open this project in PyCharm, you’ll need to open the folder first, and then set up the Python interpreter, as explained below.
First, start with:
After loading, you will see the following project structure in the PyCharm project navigator:
Setting up the interpreter¶
Before we can run any Python scripts, you need to tell the code editor where the IPKISS Python interpreter is located.
In the PyCharm menu bar, select
Then in the Settings dialog, selecttab. Then, select the gear next to the interpreter list; and then click .
In Add Local Python Interpreter dialog, under Conda Environment section, select
Once the interpreter is chosen, you can verify the installed packages. It should contain IPKISS.
Let’s now run a script to test if all settings are correct. To do so, navigate to a samples (in this case, we take a sample from the tutorial on building circuit models), then right click, and select Run ….
After running, you’ll see the simulation result of a MZI (Mach-Zehnder Interferometer).