Run Advanced Analysis

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and run various analyses on a project, including part validation, natural frequency, thermal derating, and more.

Description

Sherlock provides the ability to perform various types of analyses on a project. This script demonstrates how to: - Connect to the Sherlock service. - Import a project into Sherlock. - Run several types of analyses, such as part validation, mechanical shock, harmonic vibration, and others.

import os

from ansys.api.sherlock.v0 import SherlockAnalysisService_pb2
from examples.examples_globals import get_sherlock_tutorial_path

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

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\run_analysis.py", line 64, 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.")

Run Multiple Analyses

Run various types of analyses on the “Main Board” in the “Tutorial Project”.

try:
    # Run analyses
    pth_fatigue = SherlockAnalysisService_pb2.RunAnalysisRequest.Analysis.AnalysisType.PTHFatigue
    semiconductor_wearout = (
        SherlockAnalysisService_pb2.RunAnalysisRequest.Analysis.AnalysisType.SemiconductorWearout
    )
    thermal_derating = (
        SherlockAnalysisService_pb2.RunAnalysisRequest.Analysis.AnalysisType.ThermalDerating
    )
    component_failure_mode = (
        SherlockAnalysisService_pb2.RunAnalysisRequest.Analysis.AnalysisType.ComponentFailureMode
    )

    analysis_types = [
        (pth_fatigue, [("Phase 1", ["Thermal Event"])]),
        (semiconductor_wearout, [("Phase 1", ["Thermal Event"])]),
        (thermal_derating, [("Phase 1", ["Thermal Event"])]),
        (component_failure_mode, [("Phase 1", ["Thermal Event"])]),
    ]

    for analysis_type, params in analysis_types:
        sherlock.analysis.run_analysis(
            project="Test", cca_name="Auto Relay", analyses=[(analysis_type, params)]
        )

except SherlockRunAnalysisError as e:
    print("Error running analysis.")