Photonic Design Automation

Warning

The PDA interface is experimental and may suffer breaking changes in the 1.4.* version family for improved usability. Please check the Changelog for more information after any updates.

PhotonForge PDA client API.

The package pf.pda exposes high-level helpers to initialize PDA access, query user/session information, and create/load/manage PhotonForge projects stored in PDA.

Project(document)

Live view of a PDA project or library document.

Functions

create_project(name, *[, description, ...])	Create a new PDA project from current PhotonForge configuration.
init([api_endpoint, ws_endpoint, storage])	Initialize global clients.
list_libraries([name, labels, visibility, ...])	List versioned project libraries with optional metadata filters.
list_projects([name, labels, visibility, ...])	List projects matching metadata, sharing, and retirement filters.
load_project([name, project_id, version, ...])	Load one project by name or document reference.
retire_project([name, project_id])	Retire a project document by name or identifier.
stop()	Close and clear global clients.
user_info()	Return current user ID and organization ID.