The ``physical_merge.py`` module
================================

.. py:module:: pyedb.workflows.utilities.physical_merge


Summary
-------








.. py:currentmodule:: physical_merge
.. tab-set::







    .. tab-item:: Functions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~physical_merge`
            - Merge two EDBs together by copying the primitives from the merged_edb into the hosting_edb.



    .. tab-item:: Attributes

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~layer_mapping`
            - 


          * - :py:obj:`~cache_padstack_def`
            - 


          * - :py:obj:`~cache_layers`
            - 






















Module detail
-------------

.. py:function:: physical_merge(hosting_edb, merged_edb: Union[str, pyedb.Edb], on_top=True, vector=(0.0, 0.0), prefix='merged_', show_progress: bool = True) -> bool

   
   Merge two EDBs together by copying the primitives from the merged_edb into the hosting_edb.


   :Parameters:

       **hosting_edb** : :obj:`Edb`
           The EDB that will host the merged primitives.

       **merged_edb** : :class:`python:str`, :obj:`Edb`
           Aedb folder path or The EDB that will be merged into the hosting_edb.

       **on_top** : :ref:`bool <python:bltin-boolean-values>`, :obj:`optional`
           If True, the primitives from the merged_edb will be placed on top of the hosting_edb primitives.
           If False, they will be placed below. Default is True.

       **vector** : :class:`python:tuple`, :obj:`optional`
           A tuple (x, y) representing the offset to apply to the primitives from the merged. Default is (0.0, 0.0).

       **prefix** : :class:`python:str`, :obj:`optional`
           A prefix to add to the layer names of the merged primitives to avoid name clashes. Default is "merged_."

       **show_progress** : :ref:`bool <python:bltin-boolean-values>`, :obj:`optional`
           If True, print progress to stdout during long operations (primitives/padstacks merging). Default is True.



   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           True if the merge was successful, False otherwise.











   ..
       !! processed by numpydoc !!

.. py:data:: layer_mapping

.. py:data:: cache_padstack_def

.. py:data:: cache_layers