Update Harmonic Vibration Analysis properties

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and configure harmonic vibration analysis properties.

Description

Sherlock allows you to perform harmonic vibration analysis. This script performs the following steps: - Connect to the Sherlock service. - Import a project. - Configure the properties for harmonic vibration analysis.

"""
 sphinx_gallery_thumbnail_path =
 './images/sherlock_update_harmonic_vibe_analysis_props_example.png'
"""

import os

from examples.examples_globals import get_sherlock_tutorial_path

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

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

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

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(f"Error importing project zip archive: {e}")

Update Harmonic Vibration Properties

Configure properties for harmonic vibration analysis.

try:
    # Update properties for harmonic vibration analysis
    sherlock.analysis.update_harmonic_vibe_props(
        project="Test",
        harmonic_vibe_properties=[
            {
                "cca_name": "Auto Relay",
                "harmonic_vibe_count": 2,
                "harmonic_vibe_damping": "0.01, 0.05",
                "part_validation_enabled": False,
                "require_material_assignment_enabled": False,
                "analysis_temp": 23.8,
                "analysis_temp_units": "C",
                "filter_by_event_frequency": False,
            }
        ],
    )
    print("Harmonic vibration properties updated successfully.")
except SherlockUpdateHarmonicVibePropsError as e:
    print(f"Error updating harmonic vibration properties: {e}")