PhotonForge Learning Center / Getting Started with the GUI 1 / 11
PhotonForge · GUI tutorial

Getting Started with the
PhotonForge GUI

Set up the PhotonForge web application with a local compute backend, create your first project, and open a schematic with a ready-to-use component library, all in nine short steps.

Use ← → arrow keys or the buttons below to navigate.

Step 1 · Backend setup

Allow Chrome local network access

Go to photonforge.simulation.cloud and sign in with your Flexcompute account. The first time you arrive without a running backend, the Backend Installation Wizard opens automatically and walks you through the three steps that follow.

  • PhotonForge talks to a server running on your own machine, and recent versions of Chrome require you to allow this explicitly.
  • When Chrome asks to "connect to any device on your local network", click Allow.
  • Dismissed the prompt earlier? Click the tune / lock icon next to the URL, open Site settings, set Local network access to Allow, and reload.

Nothing connects yet. This step only grants the browser permission to reach your machine. The backend itself comes online in the next two steps.

Wizard step 1: Chrome setup
Step 2 · Backend setup

Install PhotonForge

Install the photonforge package from PyPI in the Python environment of your choice:

$pip install photonforge

Optional foundry PDKs (for example siepic-forge) can be installed the same way; see the documentation for the full list.

Wizard step 2: pip install photonforge
Step 3 · Backend setup

Start the backend server

In a terminal, start the PhotonForge backend on your machine:

$photonforge-server
  • Keep this terminal open while you work: the GUI sends all computations to it.
  • Back in the browser, the top-right badge switches to Local server once the connection is up.
Wizard step 3: photonforge-server
Step 4 · Open the app

The Projects page

With the backend running, click Done to close the wizard. You land on the Projects page, which lists your own projects along with public PDK projects (SiEPIC EBeam, Luxtelligence, Abstract Components, …).

Local server badge: the green Local server badge in the top-right corner confirms the GUI is talking to the backend on your machine. If it is missing, check that the terminal running photonforge-server is still open.

PhotonForge Projects page
Step 5 · Create a project

Create a new project

On the Projects page, click + New project (top-right). Enter a Project name (required) and an optional Description, then click Submit. New projects are private to your account until you share them.

New project dialog
Step 6 · Open a schematic

Open a new schematic

Submitting takes you to the project page. Click + New application → Schematic editor to open a schematic workbench. Every application you create shows up as a card under the project's Applications tab.

New application menu with Schematic editor
Step 7 · The workbench

Meet the schematic workbench

  • Component Library (left): components you can drag onto the canvas; the Simulation tab configures runs.
  • Canvas (center): build your circuit here; switch between Schematic, Layout, and Both views.
  • Component Tree (right): the hierarchy of the component you are editing.
  • Save and Run (top-right): store your work and launch simulations.
Empty schematic workbench
Step 8 · Add a library

Add a component library

Click the library icon at the top of the Component Library panel to open the Libraries dialog, then click Add next to a library, for example Abstract Components, PhotonForge's behavioral component library. Foundry PDK libraries (SiEPIC EBeam, Luxtelligence, …) are added the same way.

Libraries dialog with Add buttons
Step 9 · Start designing

Your components are ready

The library now appears in the Component Library panel: Abstract Components (38) with lasers, modulators, couplers, filters, and more. Drag any component onto the canvas to start building your first circuit.

Abstract Components library expanded in the panel
You're all set

What's next?

  • Build a circuit: drag components from the library and connect their ports on the canvas.
  • Configure & run: set wavelengths and models in the Simulation tab, then hit Run.
  • Inspect results: S parameters and plots appear under the Results tab.
  • Go deeper: the PhotonForge Learning Center covers key concepts, and the Python API documentation unlocks fully parametric, scripted design.