.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\02-importing\import_ipc_2581_archive.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_examples_02-importing_import_ipc_2581_archive.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_examples_02-importing_import_ipc_2581_archive.py:


.. _ref_import_ipc2581:

=======================
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.

.. GENERATED FROM PYTHON SOURCE LINES 39-51

.. code-block:: Python



    import os

    from examples.examples_globals import get_sherlock_tutorial_path

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


.. GENERATED FROM PYTHON SOURCE LINES 53-56

Connect to Sherlock
===================
Connect to the Sherlock service and ensure proper initialization.

.. GENERATED FROM PYTHON SOURCE LINES 56-59

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 60-63

Delete Project
==============
Delete the project if it already exists.

.. GENERATED FROM PYTHON SOURCE LINES 63-70

.. code-block:: Python


    try:
        sherlock.project.delete_project("Test")
        print("Project deleted successfully.")
    except Exception:
        pass


.. GENERATED FROM PYTHON SOURCE LINES 71-74

Import Tutorial Project
=======================
Import a sample project ZIP archive provided with the Sherlock installation.

.. GENERATED FROM PYTHON SOURCE LINES 74-85

.. code-block:: Python


    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: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 86-89

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

.. GENERATED FROM PYTHON SOURCE LINES 89-105

.. code-block:: Python


    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: {e}")


.. _sphx_glr_download_examples_gallery_examples_02-importing_import_ipc_2581_archive.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: import_ipc_2581_archive.ipynb <import_ipc_2581_archive.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: import_ipc_2581_archive.py <import_ipc_2581_archive.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: import_ipc_2581_archive.zip <import_ipc_2581_archive.zip>`