OpenUSD Exchange Dev Tools#

Most users of OpenUSD Exchange SDK will have their own build systems & CI/CD processes, and our custom dev tools may be of limited use outside of the usd-exchange and usd-exchange-samples repositories.

However, there are three tools that we highly recommend using:

The Omniverse Asset Validator is a python module & command line interface for validating OpenUSD Stage/Layer data.
The usd-exchange python wheels include an optional test module, which we recommend for integrating into CI/CD processes to ensure valid output of data converters.
For C++ or mixed language developers, the repo install_usdex tool can be used to acquire all of the OpenUSD Exchange build & runtime requirements, including the public headers for all relevant compiled libraries.

Asset Validator#

The Omniverse Asset Validator provides both a python module & command line interface for validating OpenUSD Stage/Layer data.

It includes a suite of validation rules that check for common USD authoring mistakes:

All rules from OpenUSD’s usdchecker CLI.
Many additional rules, developed by NVIDIA, which are applicable to all OpenUSD Ecosystem products.
It is easily extended & configured with your own custom python rules specific to your data or workflows.

It can be used in several ways:

Interactively, to validate data on import into your application.
As a runtime component in data exchange workflows, for validating at each hand-off gate in your pipeline.
Integrated into CI/CD processes to test for correctness & compliance of OpenUSD data models.

See Python Wheel Optional Test Dependencies for the simplest installation instructions.

To use the validator from python, with the default rules enabled, simply provide any layer URI (or composed Usd.Stage object) and validate:

import omni.asset_validator

# validate an existing layer file
engine = omni.asset_validator.ValidationEngine()
print(engine.validate("foo.usd"))

# validate a stage in memory
stage = Usd.Stage.CreateAnonymous()
# define prims
engine = omni.asset_validator.ValidationEngine()
print(engine.validate(stage))

There are also CLI examples of the Asset Validator in OpenUSD Exchange Samples.

If you are using Python’s unittest framework for your regression testing, consider trying the usdex.test python module in your test suite. It includes a few unittest.TestCase derived classes to simplify some common OpenUSD testing scenarios, including the Asset Validator (e.g self.assertIsValidUsd()).

Unfortunately, the Omniverse Asset Validator is not yet available for pure C++ testing, but recent OpenUSD versions now include a UsdValidatorSuite that is implemented in C++. Over time these two frameworks will align & validation should be possible from either C++ or Python.

Python Wheel Optional Test Dependencies#

If you would like to use the usdex.test python module that comes with the usd-exchange wheels, you will need to opt-in to the optional test dependencies as well. This pulls an additional wheel for the Omniverse Asset Validator.

Important

Each OpenUSD Exchange SDK release supports many OpenUSD versions and python versions. When using wheels, the python version is automatically determined based on the interpreter. However, the version of OpenUSD is currently locked in the python wheels. If you need to control OpenUSD version use the install_usdex CLI instead of the python wheels.

Linux

# Create a virtual environment
python -m venv usdex-env

# Activate the virtual environment
source usdex-env/bin/activate

# Install the OpenUSD Exchange modules with test dependency
pip install usd-exchange[test]

Windows

# Create a virtual environment
python -m venv usdex-env

# Activate the virtual environment
usdex-env\Scripts\activate

# Install the OpenUSD Exchange modules with test dependency
pip install usd-exchange[test]

OpenUSD Exchange Dev Tools#

Asset Validator#

Python Wheel Optional Test Dependencies#

install_usdex#

Install usdex_core#

Extra OpenUSD plugins#

Install usdex_rtx#

Python Test Helpers#

repo_tools configuration#