Skip to content

pda.init

init(
api_endpoint: str | None = None,
ws_endpoint: str | None = None,
storage: str | None = None,
) -> None

Initialize global clients.

Existing clients are stopped before opening new connections.

Args

  • api_endpoint: Optional base URL for PDA REST endpoints.
  • ws_endpoint: Optional websocket endpoint for CRDT synchronization.
  • storage: 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.

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"