Update Part List Validation Analysis

This example demonstrates how to connect to the Sherlock gRPC service, import a project, update part list validation analysis properties, and retrieve those properties.

Description

Sherlock’s gRPC API allows users to automate workflows such as validating and updating part list analysis properties for CCAs. This script shows how to: - Connect to the Sherlock service. - Import a project. - Retrieve and print the updated part list validation analysis properties.

The retrieved analysis properties can be used for further validation or integration with other software tools.

import os

from examples.examples_globals import get_sherlock_tutorial_path

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockGetPartsListValidationAnalysisPropsError,
    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\04-analyses\get_parts_list_analysis_props.py", line 65, 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 the tutorial project zip archive from the Sherlock tutorial directory.

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 zip archive.")

Get Part List Validation Analysis Properties

Retrieve the updated part list validation analysis properties.

try:
    response = sherlock.analysis.get_parts_list_validation_analysis_props(
        project="Test",
        cca_name="Auto Relay",
    )
    print("Retrieved part list validation analysis properties:")
    print(f"Response: {response}")
except SherlockGetPartsListValidationAnalysisPropsError as e:
    print("Error retrieving part list validation analysis properties.")