Quick Setup

NVIDIA cuOpt Managed Service

An NGC org (organization) is a dedicated virtual instance used to enable and manage NVIDIA cloud services. Upon your approval of the cuOpt Cloud Service EA program, an NVIDIA representative added you to the NGC org. You should have already received a welcome email that instructed you to continue the activation and sign-in process.

Important

Please retrieve the Welcome to NGC email which you received from: noreply-ngc@nvidia.com

To get started with the cuOpt service, first, you will need to have an NGC account if you do not already have an account.

  1. Sign up for a free NGC org through the NGC sign-in portal and create a new NVIDIA account.

  2. Click on the link within the NGC Welcome email to accept the invitation to the org.

    Note

    Please refer to the NGC documentation for further details.


The following cuOpt Service landing page will be displayed.

image4.png

Prior to setting up the Python thin client, we’ll create a Python virtual environment that we’ll use for the installation. This will allow us to install any Python scripts or libraries specifically for this service.

Note

Supported OSes include Linux, WSL and macOS. We recommend you use bash shell on macOS.


  1. First, ensure that Python 3.9+ is installed on the system. You can check the version of Python that’s installed using the command below.

    Copy
    Copied!
                

    python3 --version


  2. Next, install the Python virtual environment package.

    • For installation on macOS, run:

      Copy
      Copied!
                  

      pip3 install virtualenv


    • For installation on Ubuntu, run:

      Copy
      Copied!
                  

      apt install python3.9-venv (or the specific package for your version of Python)


  3. Next, make sure you’re in a proper working directory, such as your home directory, and create a virtual environment within that directory.

    Copy
    Copied!
                

    cd ~ python3 -m venv cuopt-service-env


  4. Activate the new environment by running.

    Copy
    Copied!
                

    source cuopt-service-env/bin/activate


  5. Proceed to the next step to download and set up the Python thin client into this environment.

Important

You must complete this download step. After completion of this step, NVIDIA will produce your credentials as soon as possible. Please wait for a welcome email from NVIDIA granting access to a service account and making you the administrator of an Oauth 2.0 client, then proceed with step 4 to obtain your credentials.

The cuOpt Service Python Thin Client is a Python interface to enable access to the NVIDIA-managed service. This lightweight client connects to the cuOpt server via a standard socket connection. It does not hold any data but simply establishes a socket connection to the server and performs all operations through it. It sends new and updated data to the cuOpt server and receives the server response (either the optimized routes or an error message) in return.

  1. Login into NVIDIA NGC.

  2. Click on the Download Python Thin Client link on the cuOpt landing page in NGC, as shown in the highlight below. This will download a zip file called cuopt_managed_service.zip.

    landing.png


  3. Unzip the downloaded file into the current working directory, using the command below.

    Copy
    Copied!
                

    unzip cuopt_managed_service.zip -d .


  4. Navigate to the managed service directory that was just unzipped.

    Copy
    Copied!
                

    cd cuopt_managed_service


  5. Make sure that your Python virtual environment that you created in the previous step is active, then execute the following command:

    Copy
    Copied!
                

    pip install .

    This will install everything included in the managed service directory into your Python virtual environment. Now cuopt_cli can be run from that env, and the cuopt_thin_client package can now be imported in Python.

  6. Wait to receive an email from NVIDIA granting access to a service account and making you the administrator of an Oauth 2.0 client

Note

The cuOpt Managed Service Client handles requests to the cuOpt service through NVIDIA Cloud Functions (NVCF). Route Optimization problem data files are sent to the server using .json. Please refer to the upcoming API section for more details.

  1. Please review the welcome email from NVIDIA granting access to a service account and Oauth 2.0 client

  2. Click on the Admin Portal link in the above welcome email and enter your email address.

  3. Proceed with the service account setup.

    Note

    It is recommended to use the same login and password as in your NGC account setup.


  4. Verify the account by email.

  5. Once your email is verified, the NVIDIA Service Accounts portal will display a form containing your Client ID and secret.

  6. Congratulations, these credentials will be used to connect to the cuOpt Managed Service.

Important

Please copy over both the Client ID and secret to a safe, private, and protected location on your disk

© Copyright 2021-2023, NVIDIA. Last updated on Nov 13, 2023.