load_project

photonforge.pda.load_project(name=None, *, project_id=None, version=None, tag=None, module_path=_DEFAULT_MODULE_PATH, set_config=True, create_template=False)[source]

Load one project by name or document reference.

Parameters:

  • name (str | None) – Project name to load.

  • project_id (DocumentId | ReadOnlyURL | None) – Project document ID or reference URL.

  • version (str | None) – Optional version filter.

  • tag (str | None) – Optional tag filter.

  • module_path (str) – Root path where modules are unpacked.

  • set_config (bool) – Whether to apply project config to PhotonForge.

  • create_template (bool) – Whether to create a starter module if absent.

Returns:

Loaded project object.

Return type:

Project