README.md

Universal Scene Description

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

For more details, please visit the web site here.

Build Status

	Linux	Windows	macOS
dev
release

Additional Documentation

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

Getting Help

Need help understanding certain concepts in USD? See Getting Help with USD or visit our forum.

If you are experiencing undocumented problems with the software, please file a bug.

Supported Platforms

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

Please see VERSIONS.md for explicitly tested versions.

Dependencies

Required:

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

Optional:

• Python

See 3rd Party Library and Application Versions for version information.

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

Imaging and USD Imaging

Required:

• OpenSubdiv

Optional:

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

usdview

Required:

• PySide6 or PySide2
• PyOpenGL

Getting and Building the Code

The simplest way to build USD is to run the supplied build_usd.py script. This script will download required dependencies and build and 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 --help parameter.

See Advanced Build Configuration for examples and additional documentation for running cmake directly.

1. Install prerequisites (see Dependencies for required versions)

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

2. Download the USD source code

You can download source code archives from GitHub or use git to clone the repository.

> git clone https://github.com/PixarAnimationStudios/USD
Cloning into 'USD'...

3. Run the script

Linux:

For example, the following will download, build, and install USD's dependencies, then build and install USD into /usr/local/USD.

> python USD/build_scripts/build_usd.py /usr/local/USD

MacOS:

In a terminal, run xcode-select to ensure command line developer tools are installed. Then run the script.

For example, the following will download, build, and install USD's dependencies, then build and install USD into /opt/local/USD.

> python USD/build_scripts/build_usd.py /opt/local/USD

Windows:

Launch the "x64 Native Tools Command Prompt" for your version of Visual Studio and run the script in the opened shell. Make sure to use the 64-bit (x64) command prompt and not the 32-bit (x86) command prompt.

See https://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 into C:\USD.

C:\> python USD\build_scripts\build_usd.py "C:\USD"

4. Try it out

Set the environment variables specified by the script when it finishes and launch usdview with a sample asset.

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

Contributing

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