The best way to get started with Riva is to start with the tutorials.

This section covers the Requirements and Setup needed to run all Riva Tutorials.

Before you try running the NVIDIA Riva tutorials, ensure you meet the following requirements:

• Python 3

1. Clone the NVIDIA Riva tutorials repository.
   git clone https://github.com/nvidia-riva/tutorials.git
cd tutorials

2. Create a Python virtual environment - We will be using this virtual environment to install all the depencies needed for Riva tutorials.
   python3 -m venv venv-riva-tutorials

3. Activate the Python virtual environment we just created.
   . venv-riva-tutorials/bin/activate

4. Install Jupyter notebook.
   pip3 install jupyter

5. Create an IPython kernel - The Riva tutorials Jupyter notebooks will be using this kernel in the next step.
   ipython kernel install --user --name=venv-riva-tutorials

6. Start the Jupyter notebooks server.
   jupyter notebook --allow-root --port 8888
   If you have a browser installed on your machine, the notebook should automatically open. If you do not have a browser, copy/paste the URL from the command.
   Once you open a Riva tutorial notebook on a browser, choose the venv-riva-tutorials kernel by Kernel -> Change kernel -> venv-riva-tutorials

Before you try running the Riva client, ensure you meet the following requirements:

• You have access and are logged into NVIDIA NGC. For step-by-step instructions, refer to the NGC Getting Started Guide.
• Python 3

1. [Optional] If using the venv-riva-tutorials (or another) Python virtual environment, activate it.
   . <Python virtual environment directory location>/venv-riva-tutorials/bin/activate

2. Install nvidia-riva-client using pip.

pip install nvidia-riva-client

Alternatively, you can install from source nvidia-riva/python-clients.

Copyright 2022 NVIDIA Corporation. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.