Photonic Design Automation

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.

Result Classes

AttachmentStatus(data)	What a project holds, and which of its files no longer describe it.
BoundQuery(document, *[, attachment, target])	A saved pointer attached to a component, and what it points at.
Edit	One change in a document's chain, with the state it produced.
EditLog(edits, *[, target, project_name, ...])	The chain behind one document, oldest first.
History(entries, *[, project_name, target, me])	An ordered view of the versions and tags on one or more documents.
HistoryEntry	One version or tag, as a plain dict with convenience accessors.
ProjectTree(data)	What a project holds, as a tree of nodes.
Trace(data)	The result of walking one attachment back to a component.
TraceabilityMatrix(data)	Which file belongs to which version: one row per file, one column per version.
Version(data)	What one call to Project.add_version() did.
Watcher(task, loop)	A running watch.

Functions

create_project(name, *[, description, ...])	Create a new PDA project from current PhotonForge configuration.
init([api_endpoint, ws_endpoint, storage])	Initialize global clients.
last_timing_report()	Return the most recent rendered PDA timing report.
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.
restore_project([name, project_id])	Restore a previously retired project document.
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.