.. meta::
   :keywords: Vitis, Library, Data Compression, Xilinx, FPGA OpenCL Kernels, LZ4 Demo, Snappy Demo, ZLIB Demo, GZip Demo
   :description: This section provides various application demos
   :xlnxdocumentclass: Document
   :xlnxdocumenttypes: Tutorials

=====
Demos
=====

Demo examples for **lz4**, **snappy**, **lz4_streaming**, **zlib** and **gzip** kernels are available in the ``L2/demos/`` directory.

.. toctree::
   :maxdepth: 1
   :caption: List of Demos

   gzip.rst
   lz4.rst
   lz4_streaming.rst
   snappy.rst
   snappy_streaming.rst
   zlib.rst
   zlib_streaming.rst

.. note::
Execute the following commands before building any of the examples:

.. code-block:: bash
   
   $ source <Vitis_Installed_Path>/installs/lin64/Vitis/2019.2/settings64.sh
   $ source <Vitis_Installed_Path>/xbb/xrt/packages/setup.sh

Build Instructions
------------------

Execute the following commands to compile and test run this example:

.. code-block:: bash
   
   $ make run TARGET=sw_emu

Variable ``TARGET`` can take the following values:

	- **sw_emu**	: software emulation
	
	- **hw_emu**	: hardware emulation
	
	- **hw**	: run on actual hardware

By default, the target device is set as Alveo U200. In order to target a different
device, use the  ``DEVICE`` argument. For example:

.. code-block:: bash

    make run TARGET=sw_emu DEVICE=<new_device.xpfm>

.. note::
Build instructions explained in this section are common for all the
applications. The generated executable names may differ.