.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_openfpga_rendering/01_multi_merge_floorplan.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_auto_openfpga_rendering_01_multi_merge_floorplan.py>`
        to download the full example code.

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

.. _sphx_glr_auto_openfpga_rendering_01_multi_merge_floorplan.py:


=======================================
Placement aware instace merge operation
=======================================

This example demonstrate how a instance merge operation on pre placed instances
results in auto inferences of shape and placement of newly created module.

Output
======

**Before merging**

.. image:: ../../../examples/OpenFPGA_rendering/_merge_multiple_floorplan_before.svg
    :width: 400px

**After merging**

.. image:: ../../../examples/OpenFPGA_rendering/_merge_multiple_floorplan.svg
    :width: 400px

.. GENERATED FROM PYTHON SOURCE LINES 23-97

.. code-block:: Python


    import logging

    import spydrnet as sdn
    import spydrnet_physical as sdnphy
    from spydrnet_physical.util import FloorPlanViz

    PROPERTY = "VERILOG.InlineConstraints"

    logger = logging.getLogger("spydrnet_logs")
    sdn.enable_file_logging(LOG_LEVEL="DEBUG", filename="01_floorplan_rendering")

    netlist = sdnphy.load_netlist_by_name("basic_hierarchy")
    top = netlist.top_instance.reference

    module1 = next(netlist.get_definitions("module1"))
    module2 = next(netlist.get_definitions("module2"))

    inst_1_0 = next(top.get_instances("inst_1_0"))
    inst_1_1 = next(top.get_instances("inst_1_1"))

    inst_2_0 = next(top.get_instances("inst_2_0"))
    inst_2_1 = next(top.get_instances("inst_2_1"))


    # = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
    #         Set the WIDTH HEIGHT on the defition
    # = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

    top.properties["WIDTH"] = 250
    top.properties["HEIGHT"] = 300

    module1.properties["SHAPE"] = "cross"  # cross Shape
    module1.properties["POINTS"] = [40, 0, 40, 40, 40, 0]  # A, B, C, D , E, F

    module2.properties["SHAPE"] = "rect"
    module2.properties["WIDTH"] = 60
    module2.properties["HEIGHT"] = 40

    # = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
    #         Set the LOC_X, LOC_Y on all the instances
    # = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

    inst_1_0.properties["LOC_X"] = 50
    inst_1_0.properties["LOC_Y"] = 20

    inst_2_0.properties["LOC_X"] = 130
    inst_2_0.properties["LOC_Y"] = 20

    inst_1_1.properties["LOC_X"] = 50
    inst_1_1.properties["LOC_Y"] = 170

    inst_2_1.properties["LOC_X"] = 130
    inst_2_1.properties["LOC_Y"] = 170


    fp = FloorPlanViz(top)
    fp.compose(skip_connections=True)
    dwg = fp.get_svg()
    dwg.saveas("_merge_multiple_floorplan_before.svg", pretty=True, indent=4)


    main_def, instance_list = top.merge_multiple_instance(
        [
            ((inst_1_0, inst_2_0), "merged_inst_2_0"),
            ((inst_1_1, inst_2_1), "merged_inst_2_1"),
        ],
        new_definition_name="NewModule",
    )

    fp = FloorPlanViz(top)
    fp.compose(skip_connections=True)
    dwg = fp.get_svg()
    dwg.saveas("_merge_multiple_floorplan.svg", pretty=True, indent=4)


.. _sphx_glr_download_auto_openfpga_rendering_01_multi_merge_floorplan.py:

.. only:: html

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

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

      :download:`Download Jupyter notebook: 01_multi_merge_floorplan.ipynb <01_multi_merge_floorplan.ipynb>`

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

      :download:`Download Python source code: 01_multi_merge_floorplan.py <01_multi_merge_floorplan.py>`

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

      :download:`Download zipped: 01_multi_merge_floorplan.zip <01_multi_merge_floorplan.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_