.. 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\add_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_add_potting_region.py>`
        to download the full example code.

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

.. _sphx_glr_examples_gallery_examples_01-project-configuration_add_potting_region.py:


.. _ref_add_potting_region:

====================================
Add Potting Regions for PCB Analysis
====================================

This example demonstrates how to use the Sherlock gRPC service to:
- Import a project.
- Add potting regions to a PCB model.
- Define potting shapes and properties.

Description
-----------
This script connects to the Sherlock gRPC service, imports a project,
and creates potting regions.

.. GENERATED FROM PYTHON SOURCE LINES 37-49

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


.. GENERATED FROM PYTHON SOURCE LINES 50-53

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

.. GENERATED FROM PYTHON SOURCE LINES 53-56

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 57-60

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

.. GENERATED FROM PYTHON SOURCE LINES 60-67

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 68-71

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

.. GENERATED FROM PYTHON SOURCE LINES 71-82

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


.. GENERATED FROM PYTHON SOURCE LINES 83-86

Add Potting Region
==================
Define a polygonal shape and add it as a potting region to the PCB.

.. GENERATED FROM PYTHON SOURCE LINES 86-110

.. code-block:: Python


    try:
        # Define the polygonal shape for the potting region
        polygonal_shape = PolygonalShape(points=[(0, 0), (0, 6.35), (9.77, 0)], rotation=87.8)

        # Add the potting region
        sherlock.layer.add_potting_region(
            project="Test",
            potting_regions=[
                {
                    "cca_name": "Auto Relay",
                    "potting_id": "Test Region",
                    "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}")


.. _sphx_glr_download_examples_gallery_examples_01-project-configuration_add_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: add_potting_region.ipynb <add_potting_region.ipynb>`

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

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

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

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