Building Kit Applications#

  1. Download and unzip the necessary packages from NGC:

  2. Unpack the downloaded packages. For this example:

    • Kit SDK package is unpacked to c:/temp/kit-sdk

    • Extension registry package is unpacked to c:/temp/kit-extensions-registry

  3. In a Command Prompt window, navigate to the Kit SDK location.

    • cd c:/temp/kit-sdk

  4. Create a new project using:

    • Windows: new_project.bat

    • Linux: ./new_project.sh

  5. Follow the prompts in the new project set up.

    • Enter a path for your project. For example, c:/temp/my-project

  6. Navigate to your project folder.

    • cd c:/temp/my-project

  7. Create a new Kit application by using repo template new

    • Follow the instructions to create a new Viewer app.

    Note

    The default behavior is for the Kit application to search for extensions on a centralized Amazon S3 location. However, for air gap environments, we need to redirect the application to a local Kit Extension Registry, so that it can reference extension dependencies without requiring internet access.

  8. Change the application repo.toml to point to the local extension registry:

    • Edit repo.toml in your project folder.

    • Add a registry to repo_precache_exts section and then save the toml file.

    [repo_precache_exts]
    registries = [
       { name = "any_name", url = "C:/temp/kit-extensions-registry" },
    ]
    
  9. In the Command Prompt window, build the application using:

    • Windows: repo.bat build

    • Linux: ./repo.sh build

  10. Launch the Viewer application using:

    • Windows: repo.bat launch

    • Linux: ./repo.sh launch

  11. If you wish to load extensions at runtime from the application (necessary for running repo launch -d), you will need to also configure your application to use the local registry:

    [settings.exts."omni.kit.registry.nucleus"]
    registries = [
       { name = "kit/airgap", url = "c:/temp/kit-extensions-registry" },
    ]