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

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

.. _sphx_glr_examples_gallery_examples_01-project-configuration_update_part_modeling_properties.py:


.. _ref_update_part_modeling_props:

===============================
Update Part Modeling Properties
===============================

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
and update part modeling properties.

Description
-----------
Sherlock's gRPC API allows users to automate workflows such as updating part
modeling properties for printed circuit boards (PCBs).
This script demonstrates how to:
- Connect to the Sherlock service.
- Import a project.
- Update part modeling properties.

The updated properties ensure accurate simulation results for mechanical and thermal analyses.

.. GENERATED FROM PYTHON SOURCE LINES 40-52

.. 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 (
        SherlockImportProjectZipArchiveError,
        SherlockUpdatePartModelingPropsError,
    )


.. GENERATED FROM PYTHON SOURCE LINES 54-57

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

.. GENERATED FROM PYTHON SOURCE LINES 57-60

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 61-64

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

.. GENERATED FROM PYTHON SOURCE LINES 64-71

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 72-75

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

.. GENERATED FROM PYTHON SOURCE LINES 75-86

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


.. GENERATED FROM PYTHON SOURCE LINES 87-90

Update Part Modeling Properties
===============================
Update the part modeling properties for the "Card" of the "Test" project.

.. GENERATED FROM PYTHON SOURCE LINES 90-111

.. code-block:: Python


    try:
        modeling_props = {
            "cca_name": "Main Board",
            "part_enabled": True,
            "part_min_size": 1,
            "part_min_size_units": "in",
            "part_elem_order": "First Order (Linear)",
            "part_max_edge_length": 1,
            "part_max_edge_length_units": "in",
            "part_max_vertical": 1,
            "part_max_vertical_units": "in",
            "part_results_filtered": True,
        }
        sherlock.analysis.update_part_modeling_props(
            project="Test",
            part_modeling_props=modeling_props,
        )
        print("Part modeling properties updated successfully.")
    except SherlockUpdatePartModelingPropsError as e:
        print(f"Error updating part modeling properties: {e}")


.. _sphx_glr_download_examples_gallery_examples_01-project-configuration_update_part_modeling_properties.py:

.. only:: html

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

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

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

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

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

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

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