Try the Samples#

The best way to learn about OpenUSD Exchange functionality is to try out the OpenUSD Exchange Samples. These are simple applications that showcase many features and key concepts of the SDK.

You can execute the samples to try them out, learn from their source code, and modify them to experiment with OpenUSD and the OpenUSD Exchange SDK for yourself.

Get the Samples#

The OpenUSD Exchange Samples are available on GitHub. You can clone the repository or download the source as a zip file.

The Samples README provides detailed descriptions and documentation about the individual samples.

Each sample provides equivalent C++ and Python implementations. Before they can be used, you must first build the Samples.

Build the Samples#

To try the Samples you will need to build them from source. The included build scripts make it easy.

Linux

This project requires “make” and “g++”.

Open a terminal.
To obtain “make” type sudo apt install make (Ubuntu/Debian), or yum install make (CentOS/RHEL).
For “g++” type sudo apt install g++ (Ubuntu/Debian), or yum install gcc-c++ (CentOS/RHEL).
Use the provided build script to download all other dependencies (e.g OpenUSD), create the Makefiles, and compile the code:
```
./repo.sh build
```

Windows

This project requires Microsoft Visual Studio 2019 or newer.

Download & install Visual Studio with C++.
Use the provided build script to download all dependencies (e.g OpenUSD), create the projects, and compile the code:

.\repo.bat build

Run the C++ Samples#

Once you have built the samples, you can run their executables to try them. All of the compiled samples are executed with a run script with the program name as the first argument. There are many samples under the source folder, like createStage, createLights, createTransforms, etc.

Linux

Use the run.sh script (e.g. ./run.sh createStage) to execute each program with a pre-configured environment.

For command line argument help, use --help

./run.sh createStage --help

Windows

Use the run.bat script (e.g. .\run.bat createStage) to execute each program with a pre-configured environment.

For command line argument help, use --help

.\run.bat createStage --help

Run the Python Samples#

After building the Samples, you can run the individual python samples.

Important

Even if you installed a python virtual environment as suggested in Getting Started, you still need to build the samples and use the python.sh|bat scripts at the root of the Samples repository.

In the future, the python samples may be adapted to work with the wheels directly.

Linux

Use the python.sh script to execute each program with a pre-configured environment.

./python.sh source/createStage/createStage.py

Windows

Use the python.bat script to execute each program with a pre-configured environment.

.\python.bat source/createStage/createStage.py

Experiment

Once you have oriented yourself with the samples that interest you, try modifying the source code in the source/ directory of the repository to experiment with the SDK. Once you’ve made your change, just repeat the Build and Run steps in this guide and test out your change.

When you’re ready, see Create a Native Application to learn how to start building your own application or simply continue using the Python wheels in your own scripts & modules.