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

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

.. _sphx_glr_auto_openfpga_basic_02_fpga_grid_generation.py:


===========================
FPGA layout grid generation
===========================

This class generates the 2D matrix of the FPGA grid.


**layout section of Architecture file**

.. rst-class:: hidden

.. program-output:: bash -c "mkdir -p auto_prog_output && xmllint --format --xpath '//layout' ../../examples/support_files/vpr_arch_render_demo.xml > ./auto_prog_output/arch_layout_snnipet.xml"


.. literalinclude:: ../auto_prog_output/arch_layout_snnipet.xml
    :language: xml


**Expected Output**:

**_complete_fpga_grid**
This prints complete logic block grid, if the logic block has width or height larger than
a unit LB width it is represeted by arrows (left and top arrows only)

**Grid**

.. literalinclude:: ../../../examples/OpenFPGA_basic/_fpga_grid.txt

**Full Grid**

.. literalinclude:: ../../../examples/OpenFPGA_basic/_fpga_full_grid.txt

**_complete_grid_metrics**

.. literalinclude:: ../../../examples/OpenFPGA_basic/_complete_grid_metrics.txt

**_complete_metrics**

.. literalinclude:: ../../../examples/OpenFPGA_basic/_complete_metrics.txt

.. GENERATED FROM PYTHON SOURCE LINES 44-94

.. code-block:: Python


    import logging

    import spydrnet as sdn
    from spydrnet_physical.util import FPGAGridGen

    logger = logging.getLogger("spydrnet_logs")
    sdn.enable_file_logging(LOG_LEVEL="INFO")


    def main():
        """
        Main method
        """
        fpga = FPGAGridGen(
            design_name="example_design",
            arch_file="../support_files/vpr_arch_render_demo.xml",
            release_root="_release",
            layout="small",
        )
        fpga.enumerate_grid()
        # Print CLB Grid
        output = fpga.print_grid()

        # grid_output
        with open("_fpga_grid.txt", "w", encoding="UTF-8") as fp:
            fp.write(output)

        # full grid_output
        output = fpga.print_grid(grid="full_grid")
        with open("_fpga_full_grid.txt", "w", encoding="UTF-8") as fp:
            fp.write(output)

        # Complete Matrics
        with open("_complete_grid_metrics.txt", "w", encoding="UTF-8") as fp:
            for y in range(fpga.height - 1, -1, -1):
                for x in range(fpga.width):
                    fp.write(f"[{' '.join(map(str, fpga.get_block(x, y))):^18}]")
                fp.write("\n")

        # Complete metrics
        with open("_complete_metrics.txt", "w", encoding="UTF-8") as fp:
            for y in range(2 * (fpga.height - 1), -1, -1):
                for x in range((fpga.width * 2) - 1):
                    fp.write(f" {fpga.get_top_instance(x, y):^12} ")
                fp.write("\n")


    if __name__ == "__main__":
        main()


.. _sphx_glr_download_auto_openfpga_basic_02_fpga_grid_generation.py:

.. only:: html

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

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

      :download:`Download Jupyter notebook: 02_fpga_grid_generation.ipynb <02_fpga_grid_generation.ipynb>`

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

      :download:`Download Python source code: 02_fpga_grid_generation.py <02_fpga_grid_generation.py>`

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

      :download:`Download zipped: 02_fpga_grid_generation.zip <02_fpga_grid_generation.zip>`


.. only:: html

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

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