..
   Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
   NVIDIA CORPORATION and its licensors retain all intellectual property
   and proprietary rights in and to this software, related documentation
   and any modifications thereto. Any use, reproduction, disclosure or
   distribution of this software and related documentation without an express
   license agreement from NVIDIA CORPORATION is strictly prohibited.

=====
Setup
=====

This section covers on the required build and execute environments along with
the build system configuration

=====  ====================
 Host Machine configuration
---------------------------
=====  ====================
CPU     X86 based Quad core
RAM     32GB Recommended
OS      Ubuntu 20.04
GPU     RTX 2080 and above
=====  ====================

Development Software Stack installation on X86
----------------------------------------------
First extract the release package and then run the below command to install the required
dependencies on X86 platform

..  code-block:: bash

   ./engine/build/scripts/install_dependencies.sh

After the installation is completed the setup is ready to build or run GXF graph.

Development Software Stack installation on Jetson device
--------------------------------------------------------
Flashing the Jetson device
^^^^^^^^^^^^^^^^^^^^^^^^^^
Jetson device can be easily setup with the help of SDK Manager which is a gui based tool.
Step-by-step installation guide can be found here: https://docs.nvidia.com/sdk-manager/download-run-sdkm/index.html#login
Once the SDK Manager is installed, the device can be flashed with the help of mentioned command line
interface. Appropriate BSP version has to be chosen to be provided as an argument to the sdkmanager.
Below example makes use of jetpack 5.0.2 GA b149.

..  code-block:: bash

   # Flash the device with JP 5.0.2 GA b149
   sdkmanager --server https://urm.nvidia.com/artifactory/sw-sdkm-generic-local/server/jetson/933/sdkm-config/main/sdkml1_repo.json

After flashing is complete the device is ready to be used

Using the GXF package on the Jetson device
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Untar the release tarball on host machine
Change directory to the location where gxf is located and follow the below steps

..  code-block:: bash

   ./engine/build/scripts/install_dependencies.sh
   ./engine/build/scripts/install_dependencies_jetson.sh -u ubuntu -h <jetson_ip>
   bazel build ...
   # Deploy the app on jetson using the below command:
   ./engine/build/deploy.sh -p //gxf/test:all_test -d <jetpack_version> -h <jetson_ip> -b bazel --remote_user ubuntu