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.
| Linux | Windows | macOS | |
|---|---|---|---|
| dev | |||
| release |
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.
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.
Required:
Optional:
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:
Optional:
usdview
Required:
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
- C++ compiler:
- Optional (Can be ignored by passing
--no-pythonas an argument tobuild_usd.py)- Python (required for bindings and tests)
- PyOpenGL (required for usdview)
- PySide6 or PySide2 (required for usdview)
You can download source code archives from GitHub or use git to clone the repository.
> git clone https://github.com/PixarAnimationStudios/OpenUSD
Cloning into 'OpenUSD'...
Run the build_usd.py script to build and install USD. Note that the build script
is 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, 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 /path/to/my_usd_install_dir.
> python OpenUSD/build_scripts/build_usd.py /path/to/my_usd_install_dir
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:\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 and
launch usdview 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 see the Contributing page in the documentation for more information.