.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\01-project-configuration\update_potting_region.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_01-project-configuration_update_potting_region.py>`
        to download the full example code.

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

.. _sphx_glr_examples_gallery_examples_01-project-configuration_update_potting_region.py:


.. _ref_update_potting_region:

==============================
Add and Update Potting Regions
==============================

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
add potting regions, update existing potting regions, and properly close the connection.

Description
-----------
Sherlock's gRPC API allows users to automate workflows such as adding and updating potting
regions for CCAs.
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a project.
- Add a potting region.
- Update an existing potting region.

.. GENERATED FROM PYTHON SOURCE LINES 39-57

.. 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 (
        SherlockAddPottingRegionError,
        SherlockImportProjectZipArchiveError,
    )
    from ansys.sherlock.core.types.layer_types import (
        PolygonalShape,
        PottingRegion,
        PottingRegionUpdateData,
        UpdatePottingRegionRequest,
    )


.. GENERATED FROM PYTHON SOURCE LINES 59-62

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

.. GENERATED FROM PYTHON SOURCE LINES 62-65

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 66-69

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

.. GENERATED FROM PYTHON SOURCE LINES 69-76

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 77-80

Import Tutorial Project
=======================
Import the tutorial project zip archive from the Sherlock tutorial directory.

.. GENERATED FROM PYTHON SOURCE LINES 80-93

.. code-block:: Python


    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}")

    potting_region_id = "Test Region"


.. GENERATED FROM PYTHON SOURCE LINES 94-97

Add Potting Region
==================
Add a new potting region to a CCA.

.. GENERATED FROM PYTHON SOURCE LINES 97-126

.. code-block:: Python


    try:
        polygonal_shape = PolygonalShape(
            points=[
                (0, 0),
                (0, 6.35),
                (9.77, 0),
            ],
            rotation=87.8,
        )
        sherlock.layer.add_potting_region(
            project="Test",
            potting_regions=[
                {
                    "cca_name": "Auto Relay",
                    "potting_id": potting_region_id,
                    "side": "TOP",
                    "material": "epoxyencapsulant",
                    "potting_units": "in",
                    "thickness": 0.1,
                    "standoff": 0.2,
                    "shape": polygonal_shape,
                },
            ],
        )
        print("Potting region added successfully.")
    except SherlockAddPottingRegionError as e:
        print(f"Error adding potting region: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 127-130

Update Potting Region
=====================
Update an existing potting region.

.. GENERATED FROM PYTHON SOURCE LINES 130-157

.. code-block:: Python


    update_data = PottingRegionUpdateData(
        potting_region_id_to_update=potting_region_id,
        potting_region=PottingRegion(
            cca_name="Main Board",
            potting_id="Updated Test Region",
            potting_side="BOT",
            potting_material="epoxyencapsulant",
            potting_units="mm",
            potting_thickness=0.3,
            potting_standoff=0.1,
            shape=PolygonalShape(
                points=[(0, 1), (5, 1), (5, 5), (1, 5)],
                rotation=45.0,
            ),
        ),
    )

    try:
        update_request = UpdatePottingRegionRequest(
            project="Test",
            update_potting_regions=[update_data],
        )
        sherlock.layer.update_potting_region(update_request)
        print("Potting region updated successfully.")
    except Exception as e:
        print(f"Error updating potting region: {e}")


.. _sphx_glr_download_examples_gallery_examples_01-project-configuration_update_potting_region.py:

.. only:: html

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

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

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

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

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

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

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