create_project

photonforge.pda.create_project(name, *, description=None, labels=(), visibility='private', role=None, module_path=_DEFAULT_MODULE_PATH, create_template=True)[source]

Create a new PDA project from current PhotonForge configuration.

Parameters:

  • name (str) – Project name.

  • description (str | None) – Optional project description.

  • labels (Sequence[str]) – Project labels.

  • visibility (Literal['private', 'organization']) – Initial sharing visibility.

  • role (Literal['editor', 'viewer'] | None) – Initial sharing role for non-private visibility.

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

  • create_template (bool) – Whether to generate a starter module.

Returns:

Loaded project object.

Return type:

Project

The initial project includes exported config dependencies and an optional template Python module directory.

Important

Setting public visibility is not allowed, as it shares the contents and all dependencies with all users in the platform. Please contact support if you want to share a public library.