init¶

photonforge.pda.init(api_endpoint=None, ws_endpoint=None, storage=None)[source]¶

Initialize global clients.

Existing clients are stopped before opening new connections.

Parameters:

api_endpoint (str | None) – Optional base URL for PDA REST endpoints.
ws_endpoint (str | None) – Optional websocket endpoint for CRDT synchronization.
storage (str | None) – Optional path for contents storage. If set to "none", uses in-memory storage. If set to "auto" (default), uses a private temporary directory. Otherwise, use the given value as the cache directory base.

Return type:

None

Note

The default values for all arguments can be set in the tidy3d configuration toml file under the plugins.pda section. For example, to use only in-memory storage:

[web]
apikey = "<your API key>"

[plugins.pda]
storage = "none"