Export FEA Model

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and export a Finite Element Analysis (FEA) model.

Description Sherlock’s gRPC API enables automation of various workflows, including exporting FEA models. This script demonstrates how to: - Connect to the Sherlock service. - Import a tutorial project. - Export an FEA model with specific parameters.

import os

from ansys.api.sherlock.v0.SherlockModelService_pb2 import GeometryType, PcbMaterialType
from examples.examples_globals import (
    SHERLOCK_CONNECT_TIMEOUT,
    get_sherlock_tutorial_path,
    get_temp_dir,
)

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockExportFEAModelError,
    SherlockImportProjectZipArchiveError,
)
from ansys.sherlock.core.types.common_types import Measurement

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

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

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\03-exporting\export_fea_model.py", line 66, in <module>
    sherlock = launcher.connect(port=9092, timeout=SHERLOCK_CONNECT_TIMEOUT, 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 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(), "Tutorial Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project zip archive.")

Export FEA Model

Export the FEA model with customized parameters.

try:
    fea_export_path = os.path.join(get_temp_dir(), "export.wbjn")
    sherlock.model.export_FEA_model(
        project="Test",
        cca_name="Main Board",
        export_file=fea_export_path,
        analysis="NaturalFreq",
        drill_hole_parameters=[
            {
                "drill_hole_modeling": "ENABLED",
                "min_hole_diameter": Measurement(value=1.0, unit="mm"),
                "max_edge_length": Measurement(value=1.0, unit="mm"),
            }
        ],
        detect_lead_modeling="ENABLED",
        lead_model_parameters=[
            {
                "lead_modeling": "ENABLED",
                "lead_element_order": "First Order (Linear)",
                "max_mesh_size": Measurement(value=1.0, unit="mm"),
                "vertical_mesh_size": Measurement(value=0.5, unit="mm"),
                "thicknessCount": 3,
                "aspectRatio": 2,
            }
        ],
        display_model=False,
        clear_FEA_database=True,
        use_FEA_model_id=True,
        coordinate_units="mm",
        pcb_material_type=PcbMaterialType.Orthotropic,
        geometry_type=GeometryType.Step,
    )
    print("FEA model exported successfully.")
except SherlockExportFEAModelError as e:
    print("Error exporting FEA model.")