Import IPC-2581 Archive

This example demonstrates how to connect to the Sherlock gRPC service and import an IPC-2581 project,

Description

Sherlock’s gRPC API allows users to automate workflows such as importing IPC-2581 archives. This script demonstrates how to: - Connect to the Sherlock service. - Import an IPC-2581 archive without specifying a project or CCA name.

This functionality is useful for initializing projects with IPC-2581 data for further analysis and workflows.

import os

from examples.examples_globals import SHERLOCK_CONNECT_TIMEOUT, get_sherlock_tutorial_path

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

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\02-importing\import_ipc_2581_archive.py", line 63, 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 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(), "Tutorial Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print(f"Error importing project")

Import IPC-2581 Archive

Import an IPC-2581 archive without specifying a project or CCA name.

try:
    ipc2581_path = os.path.join(os.getcwd(), "IPC2581A-TestCase2.cvg")
    sherlock.project.import_ipc2581_archive(
        archive_file=ipc2581_path,
        include_other_layers=True,
        guess_part_properties=True,
        project="Test",
        cca_name=None,
        polyline_simplification=False,
        polyline_tolerance=0.1,
        polyline_tolerance_units="mm",
    )
    print("IPC-2581 archive imported successfully.")
except SherlockImportIpc2581Error as e:
    print(f"Error importing IPC-2581 archive")