add_project#

Project.add_project(project_name, project_category, project_description)#

Add a sherlock project to sherlock.

Available Since: 2024R1

Parameters:

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

  • project_category (str) – str: Category of the Sherlock project

  • project_description (str) – str: Description of the Sherlock project

Return type:

int

Returns:

:
int

0 for success otherwise error

Examples

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