.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_openfpga_clock_tree/01_connection_patterns.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_clock_tree_01_connection_patterns.py>`
        to download the full example code.

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

.. _sphx_glr_auto_openfpga_clock_tree_01_connection_patterns.py:


==============================
Connection Pattern Generation
==============================

This example demonstrate how to genrate different connection pattern
for routing global signals. By default this library support basic fishbone
and HTree patterns, which can be extended to create desired connectivity
usng transformations like ``rotate``, ``transalate``, ``margin``, ``merge``,
``scale`` and ``sample``


**Output**

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_90.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_margin.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_merging.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_scaling1.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_scaling2.svg
    :width: 200px

.. image:: ../../../examples/OpenFPGA_clock_tree/_fishbone_pattern_sampling.svg
    :width: 200px

.. GENERATED FROM PYTHON SOURCE LINES 37-116

.. code-block:: Python


    from spydrnet_physical.util import ConnectionPattern

    p_manager = ConnectionPattern(5, 5)
    fishbone_pattern = p_manager.connections.merge(p_manager.get_fishbone(5, 5).set_color("green"))
    svg = p_manager.render_pattern(title="Fishbone Pattern")
    svg.saveas("_fishbone_pattern.svg", pretty=True, indent=4)

    # ===============================
    #        Rotate Example
    # ===============================
    fishbone_pattern.rotate(90)
    svg = p_manager.render_pattern(title="Rotation")
    svg.saveas("_fishbone_pattern_90.svg", pretty=True, indent=4)

    # ===============================
    #        Margin Example
    # ===============================
    p_manager.reset()
    fishbone_points = p_manager.get_fishbone(5, 5, x_margin=(1, 1))
    fishbone_pattern = p_manager.connections.merge(fishbone_points)
    svg = p_manager.render_pattern(title="Margin option")
    svg.saveas("_fishbone_pattern_margin.svg", pretty=True, indent=4)

    # ===============================
    #  Transalate and Merge Example
    # ===============================
    p_manager = ConnectionPattern(5, 5)
    left_tree = p_manager.connections
    left_tree = left_tree.merge(p_manager.get_fishbone(5, 5, x_margin=(1, 1)))
    left_tree.translate(-1, 0)

    p_manager = ConnectionPattern(5, 5)
    right_tree = p_manager.connections
    right_tree = right_tree.merge(p_manager.get_fishbone(5, 5, x_margin=(1, 2)))
    right_tree.translate(2, 0)
    right_tree.merge(left_tree)
    svg = p_manager.render_pattern(title="Merging option")
    svg.saveas("_fishbone_pattern_merging.svg", pretty=True, indent=4)

    # ===============================
    #        Scaling Example
    # ===============================
    p_manager = ConnectionPattern(3, 3)
    left_tree = p_manager.connections
    left_tree = left_tree.merge(p_manager.get_fishbone(3, 3))
    svg = p_manager.render_pattern(title="Original")
    svg.saveas("_fishbone_pattern_scaling1.svg", pretty=True, indent=4)
    left_tree.scale(2, anchor=(1, 1))

    p_manager = ConnectionPattern(5, 5)
    right_tree = p_manager.connections
    right_tree.merge(left_tree)
    right_tree.crop_edges()
    svg = p_manager.render_pattern(title="Scale")
    svg.saveas("_fishbone_pattern_scaling2.svg", pretty=True, indent=4)

    # ===============================
    #        Sampling Example
    # ===============================
    right_tree.sample_connections()
    svg = p_manager.render_pattern(title="Sampling after scaling")
    svg.saveas("_fishbone_pattern_sampling.svg", pretty=True, indent=4)


    # =========================================
    #        Up down connection with buffer
    # =========================================
    p_manager.reset()
    points = p_manager.get_fishbone(5, 5, x_margin=(1, 1), steps=2)
    fishbone_pattern = p_manager.connections.merge(points)
    fishbone_pattern.add_connection(2, 2, 3, 2)
    fishbone_pattern.make_top_connection(fishbone_pattern.points[0])
    fishbone_pattern.push_connection_down(fishbone_pattern.points[-1])
    fishbone_pattern.pull_connection_up(fishbone_pattern.points[-2])
    fishbone_pattern.points[-3].buffer = True

    svg = p_manager.render_pattern(title="Top and bottom connectivity")
    svg.saveas("_layer_connections.svg", pretty=True, indent=4)


.. _sphx_glr_download_auto_openfpga_clock_tree_01_connection_patterns.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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