add_project

Project.add_project(project_name: str, project_category: str, project_description: str) → int

Add a sherlock project to sherlock.

Available Since: 2024R1

Parameters:

• project_name (str) – Name of the Sherlock project.

• project_category (str) – Category of the Sherlock project

• project_description (str) – Description of the Sherlock project

Returns:

0 for success otherwise error

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> code = sherlock.project.add_project(
    "project name example",
    "project category example",
    "project description example")