Repository files navigation

Universal Scene Description (USD) is an efficient, scalable system forauthoring, reading, and streaming time-sampled scene description forinterchange between graphics applications.

For more details, please visit the web sitehere.

	Status
dev
release

• User Documentation and Tutorials
• API Documentation
• Advanced Build Configuration

Need help understanding certain concepts in USD? SeeGetting Help with USD orvisit ourforum.

If you are experiencing undocumented problems with the software, pleasefile a bug.If you need to report a security issue with the software, please review theSecurity Policy.

USD is primarily developed on Linux platforms (CentOS 7), but is built, testedand supported on macOS and Windows.

It is also possible to build USD libraries that can be embeddedin iOS and visionOS apps.

Please seeVERSIONS.md for explicitly tested versions.

Required:

• C/C++ compiler
• CMake
• Intel TBB

See3rd Party Library and Application Versions for version information.

Additional dependencies are required for the following components. Thesecomponents may be disabled at build-time. For further details seeAdvanced Build Configuration.

Imaging and USD Imaging

Required:

• OpenSubdiv

Optional:

• OpenEXR
• OpenImageIO
• OpenColorIO
• OSL (OpenShadingLanguage)
• Ptex

Python Bindings

Required:

• Python

usdview

Required:

• Python bindings
• PySide6 orPySide2
• PyOpenGL

The simplest way to build USD is to run the suppliedbuild_usd.pyscript. This script will download required dependencies and buildand install them along with USD in a given directory.

Follow the instructions below to run the script with its default behavior,which will build the USD core libraries, Imaging, and USD Imaging components.For more options and documentation, run the script with the--helpparameter.

SeeAdvanced Build Configuration for examples andadditional documentation for running cmake directly.

• Required:
  • C++ compiler:
    • gcc
    • Xcode
    • Microsoft Visual Studio
  • CMake
• Optional (Can be ignored by passing--no-python as an argument tobuild_usd.py)
  • Python (required forbindings and tests)
  • PyOpenGL (required forusdview)
  • PySide6 or PySide2 (required forusdview)

You can download source code archives fromGitHub or usegit to clone the repository.

> git clone https://github.com/PixarAnimationStudios/OpenUSDCloning into 'OpenUSD'...

Run the build_usd.py script to build and install USD. Note that the build scriptis structured with an out-of-source build in mind -- installing a build into the
directory where the repository was cloned is untested.

For example, the following will download, build, and install USD's dependencies,then build and install USD into/path/to/my_usd_install_dir.

> python OpenUSD/build_scripts/build_usd.py /path/to/my_usd_install_dir

In a terminal, runxcode-select to ensure command line developer tools areinstalled. Then run the script.

For example, the following will download, build, and install USD's dependencies,then build and install USD into/path/to/my_usd_install_dir.

> python OpenUSD/build_scripts/build_usd.py /path/to/my_usd_install_dir

When building from a macOS system, you can cross compilefor iOS based platforms.

Cross compilation builds are restricted to building libraries that can beembedded in applications built for the target platform. It can be helpfulto use a monolithic build when embedding USD(seeAdvanced Build Configuration).

These builds do not support Python bindings or command line tools.

For example, the following will download, build, and install USD's dependencies,then build and install USD for iOS into/path/to/my_usd_install_dir.

> python OpenUSD/build_scripts/build_usd.py --build-target iOS --build-monolithic /path/to/my_usd_install_dir

Or for visionOS:

> python OpenUSD/build_scripts/build_usd.py --build-target visionOS --build-monolithic /path/to/my_usd_install_dir

On Windows, it is possible to compile for either x64, or ARM64.Note: ARM64EC is not compatible at this time.Note 2: usdview is not supported on ARM64 at present, due to lack of PySide

Launch the "x64 Native Tools Command Prompt" (or "ARM64 Native Tools CommandPrompt" where appropriate) for your version of Visual Studio, and run the scriptin the opened shell. Make sure to use the appropriate version of the commandprompt (e.g. on x64, use the x64 version, not the x86 version).

Seehttps://docs.microsoft.com/en-us/cpp/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line for more details.

For example, the following will download, build, and install USD's dependencies,then build and install USD intoC:\path\to\my_usd_install_dir.

C:\> python OpenUSD\build_scripts\build_usd.py "C:\path\to\my_usd_install_dir"

Set the environment variables specified by the script when it finishes andlaunchusdview with a sample asset.

> usdview OpenUSD/extras/usd/tutorials/convertingLayerFormats/Sphere.usda

If you'd like to contribute to USD (and we appreciate the help!), please seetheContributing page in thedocumentation for more information.