search

NVIDIA-Omniverse / OpenUSD-Code-Samples

Common code snippets for OpenUSD
Apache License 2.0
58 stars 14 forks source link

readme

OpenUSD Code Samples

License See the Code Samples

This repository contains useful Universal Scene Description (OpenUSD) code samples in Python, C++, and USDA. If you want to browse the code samples to use them, you can see them fully rendered in the OpenUSD Code Samples documentation page.

Configuration

This repository uses Poetry for dependency management. If you're new to Poetry, you don't need to know much more than the commands we use in the build instructions. To make it easier when authoring code samples and contributing, we recommend installing:

  1. Install any version of Python between versions 3.8-3.10 .
  2. Install Poetry

How to Build

  1. poetry install
  2. poetry run python build_docs.py
  3. In a web browser, open sphinx/_build/index.html

Have an Idea for a New Code Sample?

Ideas for new code samples that could help other developers are always welcome. Please create a new issue requesting a new code sample and put [New Request] at the end of your title. Someone from the NVIDIA team or OpenUSD community will pick it up. If you can contribute it yourself, even better!

Find a Typo or an Error?

Please let us know if you find any mistakes or non-working code samples. File an issue with a comment that this is a bug.

Contributing

Contributions are welcome! If you would like to contribute, please read our Contributing Guidelines to understand how to contribute. Also, check out the Code Sample Guidelines to understand how code samples file and folders are structured in this repository and how to adhere to follow our code samples style.

Disclosures

The goal of this repository is to help developers learn OpenUSD and be more productive. To that end, NVIDIA reserves the right to use the source code and documentation in this repository for the purpose of training and/or benchmarking of an AI code assistant for OpenUSD developers.