Sherlock Project Export

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and export the project in multiple configurations.

Description Sherlock’s gRPC API enables automation of various workflows, including project export. This script demonstrates how to: - Connect to the Sherlock service. - Import a tutorial project ZIP archive. - Export a project with different configurations.

import os

from examples.examples_globals import get_sherlock_tutorial_path, get_temp_dir

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockExportProjectError,
    SherlockImportProjectZipArchiveError,
)

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

sherlock = launcher.connect(port=9092, timeout=10, transport_mode="wnua")

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\03-exporting\export_project.py", line 60, in <module>
    sherlock = launcher.connect(port=9092, timeout=10, transport_mode="wnua")
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 324, in connect
    raise e
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 306, in connect
    _wait_for_sherlock_grpc_ready(channel, timeout)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 395, in _wait_for_sherlock_grpc_ready
    raise SherlockConnectionError(message="Error starting gRPC service")
ansys.sherlock.core.errors.SherlockConnectionError: gRPC connection error: Error starting gRPC service

Delete Project

Delete the project if it already exists.

try:
    sherlock.project.delete_project("Test")
    print("Project deleted successfully.")
except Exception:
    pass

Import Tutorial Project

Import a sample project ZIP archive provided with the Sherlock installation.

try:
    sherlock.project.import_project_zip_archive(
        project="Test",
        category="Demos",
        archive_file=os.path.join(get_sherlock_tutorial_path(), "Auto Relay Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project.")

Export Project

Export the imported project with different configurations.

# Export with all options enabled
try:
    sherlock.project.export_project(
        project_name="Test",
        export_design_files=True,
        export_result_files=True,
        export_archive_results=True,
        export_user_files=True,
        export_log_files=True,
        export_system_data=True,
        export_file_dir=get_temp_dir(),
        export_file_name="Exported_Project_All.zip",
        overwrite_existing_file=True,
    )
    print("Project exported successfully with all options enabled.")
except SherlockExportProjectError as e:
    print("Error exporting project (all options).")

# Export with limited options
try:
    sherlock.project.export_project(
        project_name="Test",
        export_design_files=True,
        export_result_files=False,
        export_archive_results=False,
        export_user_files=False,
        export_log_files=False,
        export_system_data=False,
        export_file_dir=get_temp_dir(),
        export_file_name="Exported_Project_Limited.zip",
        overwrite_existing_file=True,
    )
    print("Project exported successfully with limited options.")
except SherlockExportProjectError as e:
    print("Error exporting project (limited options).")