kit-manual: Omniverse Kit Manual

kit-manual

• Kit Overview
  • Omniverse Kit
    • USD/Hydra
    • Omni.USD
    • Omniverse Client Library
    • Carbonite
      • Plugins
    • Omniverse RTX Renderer
    • Scripting
    • Kit Extensions
    • omni.ui
• Kit Architecture
  • Extensions
  • Kit Kernel (kit.exe/IApp)
  • omni.kit.app (omni::kit::IApp)
  • Bundled Extensions
  • Different Modes Example
    • CLI utility
    • GUI CLI utility
• Kit Core IApp Interface
  • Loop runners
  • Extension manager
  • Scripting
  • General message bus
  • Shutdown sequence
  • Hang detector
• Extensions (Basic)
  • 1. Open Extension Manager UI: Window -> Extensions
  • 2. Create New Extension Project: Press “Plus” button on the top left
  • 3. Push to git
  • More Advanced Things To Try
    • Explore kit.exe
    • Explore other extensions
• Extensions (Advanced)
  • What is an Extension?
  • Extension in a single folder
  • Extension Id
  • Extension Version
  • Extension Package Id
  • Single File Extensions
  • App Extensions
  • Extension Search Paths
  • Extensions Source Linking: Dev Paths
    • Custom Search Paths Protocols
    • Git URL as Extension Search Paths
  • Extension Discovery
  • Extension Dependencies
  • Specifying Dependency Version
    • Pre-release versions
  • Extension configuration file (extension.toml)
    • Config Fields
      • [core] section
        • [core.reloadable] (default: true)
        • [core.order] (default: 0)
      • [package] section
        • [package.version] (default: "0.0.0")
        • [package.title] default: ""
        • [package.description] default: ""
        • [package.category] (default: "")
        • [package.app] (default: false)
        • [package.feature] (default: false)
        • [package.toggleable] (default: true)
        • [package.authors] (default: [""])
        • [package.repository] (default: "")
        • [package.keywords] (default: [""])
        • [package.changelog] (default: "")
        • [package.readme] (default: "")
        • [package.preview_image] (default: "")
        • [package.icon] (default: "")
        • [package.target]
        • [package.writeTarget]
      • [dependencies] section
      • [python] section
        • [[python.module]]
        • [[python.scriptFolder]]
      • [native] section
        • [[native.plugin]]
        • [[native.library]] section
      • [settings] section
      • [[env]] section
      • [fswatcher] section
        • [fswatcher.patterns]
        • [fswatcher.paths]
      • [[test]] section
      • [documentation] section
      • [deprecation] section
        • [deprecation.warning] (default: "")
    • Config Filters
    • Example
  • Extension Enabling/Disabling
    • Python Modules
    • Native Plugins
    • Settings
    • Tokens
  • Extensions Manager
    • Reloading
    • Extension interfaces
    • Runtime Information
    • Hooks
    • Extension API Code Examples
      • Enable Extension
      • Get All Extensions
      • Get Extension Config
      • Get Extension Path
    • Other Settings
      • /app/extensions/disableStartup (default: false)
      • /app/extensions/precacheMode (default: false)
      • /app/extensions/debugMode (default: false)
      • /app/extensions/detailedSolverExplanation (default: false)
      • /app/extensions/registryEnabled (default: true)
      • /app/extensions/skipPublishVerification (default: false)
      • /app/extensions/excluded (default: [])
      • /app/extensions/preferLocalVersions (default: true)
      • /app/extensions/syncRegistryOnStartup (default: false)
      • /app/extensions/publishExtraDict (default: {})
      • /app/extensions/fsWatcherEnabled (default: true)
      • /app/extensions/mkdirExtFolders (default: true)
      • /app/extensions/installUntrustedExtensions (default: false)
      • /app/extensions/profileImportTime (default: false)
      • /app/extensions/fastImporter/enabled (default: true)
      • /app/extensions/fastImporter/searchInTopNamespaceOnly (default: true)
      • /app/extensions/fastImporter/fileCache (default: false)
      • /app/extensions/parallelPullEnabled (default: false)
  • Extension Registries
    • Publishing Extensions
    • Unpublishing Extensions
    • Pulling Extensions
    • Pre-downloading Extensions
    • Authentication and Users
  • Building Extensions
• Extensions (USD Schema)
• Extensions (API)
  • Python API
    • Example
    • Tool to check API: repo_checkapi
      • Common API Check Failures
      • Debugging the tool
    • API Deprecation
• Testing Extensions with Python
  • Adding Extension Test: Build Scripts
  • How does it work?
  • Writing First Test
  • Test Settings
    • Test Settings: Basics
    • Test Settings: Where to look for python tests?
    • Test Settings: Multiple test processes
    • Test Settings: Disable test on certain platform
  • Running Your Test
    • Run subset of tests
    • Run subset of tests using Tests Sampling
    • Run tests from a file
    • Retry Strategy
    • Developing Tests
    • Tests Code Coverage (Python)
    • Debugging Coverage
    • Disabling a python test
    • Pass extra cmd args to the test
    • Choose an app to run tests in
    • Test Output
    • Python debugger
    • Wait for the debugger to attach
    • Reading Logs
  • Marking tests as unreliable
  • Running unreliable tests
  • Listing tests
  • repo_test: Running All Tests
    • Excluding Tests from TC
  • Adding Info to Failed Test Summary
  • omni.kit.ui_test: Writing UI tests
  • (Advanced) Generating new tests or adapting discovered tests at runtime
• Running Tests As Benchmarks
  • Writing Python Benchmarks
    • Adding Samples of Custom Metrics per Benchmark
    • Example Benchmark Python Code
  • CLI Parameters to Run Benchmarks Manually
    • Example Command
    • Benchmark Addendum
• Testing Extensions with C++
  • Doctest
  • Set up testable libraries
  • Running a single test case
  • Unit Tests
  • Image comparison with a golden image
    • Regression testing of an executable with a golden image:
    • Regression testing of a rendering test using comparison of backbuffer with a golden image:
    • How to update and upload a new golden image
    • Troubleshooting
    • How to use asset folder for storing data
  • Skipping Vulkan or Direct3D 12 graphics tests
  • Getting C++ Code Coverage Information
    • Understanding the Teamcity Coverage pipeline
    • Troubleshooting Code Coverage
• Documenting Extensions
  • Documenting Python API
    • Adding Extensions to the automatic-introspection documentation system
    • Dealing with Sphinx Warnings
      • MyST-parser warnings
      • Docstring syntax warnings
      • C++ docstring issues
• Publishing Extensions
  • Publish Verification
  • Other Publish Tool Settings
• Creating Kit Apps
  • Simple App
  • Application Dependencies Management
    • Updating Version Lock
    • Version Specification Recommendations
    • Windows or Linux only dependencies
    • Caching extensions disabled by default
  • Deploying an App
  • Extensions without an App
  • Supported Targets Check
  • Other Precache Tool Settings
• Configuring
  • Quick Start
  • Application Config
  • Kit File
  • System Configs
  • Persistent Settings
  • Special Keys
    • Appending Arrays
    • Importing Other Configs
  • Portable Mode
    • Cmd Args
    • Portable Configs (Markers)
  • Changing Settings With Command Line
    • Changing an array value with command line
  • Passing Command Line arguments to extensions
  • Code Examples
    • Get Setting
    • Set Setting
    • Set Persistent Setting
    • Subscribe To Setting Changes
  • Kit Kernel Settings
    • /app/enableStdoutOutput (default: true)
    • /app/disableCmdArgs (default: false)
    • /app/printConfig (default: false)
    • /app/userConfigPath (default: ${data}/user.config.json)
    • /app/settings/persistent (default: true)
    • /app/settings/loadUserConfig (default: true)
    • /app/hangDetector/enabled (default: false)
    • /app/hangDetector/alwaysEnabled (default: false)
    • /app/hangDetector/timeout (default: 120)
    • /app/quitAfter (default: -1)
    • /app/quitAfterMs (default: -1.0)
    • /app/fastShutdown (default: true)
    • /app/python/logSysStdOutput (default: true)
    • /app/window/iconPath (default: '')
• Logging
  • Python Logging
  • Code Examples
    • Logging with python
    • Logging with C++
• Profiling
  • Easy Start
  • Profiling Backends
    • Chrome Trace
    • Tracy
      • On Demand
      • From Startup
    • Multiplexer
  • Instrumenting Code
  • Automatic Python Profiler
  • Profiling Startup Time
• Python Scripting
  • Overview
  • How to add a script folder
  • How to run a script
• Embedded Kit Python
  • Hello Python
  • Using system Python
  • Add extra search paths
  • Other Python Configuration Tweaks
  • Using numpy, Pillow etc.
  • Using Anaconda environment
  • Using other packages from pip
  • Why do some native Python modules not work in Kit?
  • Running Kit from Python
• Using Python pip packages
  • Runtime installation using omni.kit.pipapi
  • Build-time installation using repo_build
  • pip packages included in Kit: omni.kit.pip_archive
  • Code Examples
    • Install pip package at runtime
• Kit Python Package
  • Getting Started
  • KitApp Example
  • EULA
  • Editable Mode
• Dictionaries and Settings
  • Dictionaries
  • Settings
    • Default values
    • Notifications
    • Settings structure
    • Reacting to and consuming settings
    • Combining API and settings
• Event Streams
  • API/design overview
  • Recommended usage
    • Deferred callbacks
    • Event types
    • Transient subscriptions
  • Code examples
    • Subscribe to Shutdown Events
    • Subscribe to Update Events
    • Create custom event
• Tokens Reference
  • App Tokens
  • Environment Variable Tokens
  • Path Tokens
    • Omniverse Global Paths: omniverse.toml
    • Data Folder
    • Program data
    • Documents folder
    • Cache folder
    • Logs folder
    • Config folder
    • Temporary folder
    • Other useful paths
    • Platform tokens
    • Extension tokens
  • Overriding Tokens
  • Checking Token Values
  • Resolving your path
• Linux Troubleshooting
  • Q1) How to install a driver.
  • Q2) Omniverse kit logs only listed one of my GPUs, but nvidia-smi shows multiple GPUs.
  • Q3) How to verify a correct Vulkan setup with vulkaninfo or vulkaninfoSDK utility
  • Q4) I have a single GPU, but I see multiple GPUs of the same type reported in Omniverse kit logs.
  • Q5) Startup failure with: VkResult: ERROR_DEVICE_LOST
  • Q6) Startup failure with: GLFW initialization failed
  • Q7) Startup failure with: Failed to find a graphics and/or presenting queue.
  • Q8) Startup failure for carb::glinterop with X Error of failed request:  GLXBadFBConfig
  • Q9) How to specify what GPUs to run Omniverse apps on
  • Q10) Viewport is gray and nothing is rendered.
  • Q11) Getting spam of failures: Failed to create change watch for xxx: errno=28, No space left on device
    • To view the current watcher limit:
    • To update the watcher limit:
  • Q12) How to increase the file descriptor limit on Linux to render on more than 2 GPUs
    • To increase the file descriptor limit
• Frequently Asked Questions
  • Where can I find the core Kit config file?
  • Can I debug python extensions and scripts?
  • Random failures when loading omni.usd ?
• Kit SDK Extensions
• OpenUSD Python API
• API (python)