PhotonForge 1.0.1 Documentation¶
PhotonForge is a design tool that integrates with foundry PDKs to speed up the design, simulation, and verification cycle for optical components and systems.
Installation¶
PhotonForge is a python module that can be easily installed via pip:
pip install photonforge
This command will install PhotonForge along with all of its dependencies in the current environment. If you have Tidy3D already installed in a virtual environment, you can use the same for PhotonForge.
A Tidy3D API key is required to authenticate PhotonForge users. If you don’t have one already configured, you can get a free API key and configure it with the following command:
tidy3d configure
On Windows, it is easier to use pipx to find the path to the configuration tool:
pip install pipx
pipx run tidy3d configure
More information about the installation and configuration of Tidy3D can be found here.
You can verify that the PhotonForge installation worked by running the following command to print the installed version:
python -c 'import photonforge as pf; print(pf.__version__)'
Optional: PDK Installation¶
Proprietary foundry PDKs are loaded as PhotonForge technologies, which are distributed within each PDK package along with installation instructions.
Publicly available PDKs can be installed with pip.
For example, to install SiEPIC OpenEBL’s PDK for FotonPhorge, simply use:
pip install siepic-forge