Initial commit

.gitignore

@@ -0,0 +1 @@
+.p4*

BUILDING.md

@@ -0,0 +1,138 @@
+Advanced Build Configuration
+============================
+
+## Table of Contents
+- [Optional Components](#Optional-Components)
+- [Third Party Plugins](#Plugins)
+- [Other Build Options](#Other-Build-Options)
+- [USD Developer Options](#USD-Developer-Options)
+- [Optimization Options](#Optimization-Options)
+
+## Optional Components
+
+USD contains several optional components that are enabled by default
+but may be disabled when invoking cmake. Disabling these components
+removes the need for their dependencies when building USD.
+
+##### Imaging
+
+This component contains Hydra, a high-performance graphics rendering engine.
+
+Disable this component by specifying the cmake flag ```PXR_BUILD_IMAGING=FALSE``` when 
+invoking cmake. Disabling this component will also disable the [USD Imaging](#USD-Imaging)
+component.
+
+##### USD Imaging
+
+This component provides the USD imaging delegates for Hydra, as well as
+usdview, a standalone native viewer for USD files.
+
+Disable this component by specifying the cmake flag ```PXR_BUILD_USD_IMAGING=FALSE``` when
+invoking cmake. Enabling this component will enable the [Imaging](#Imaging)
+component.
+
+## Plugins
+
+USD provides several plugins for integration with third-party software packages,
+including Maya, Katana, and Alembic. There is additional documentation on each plugin 
+[here](http://openusd.org/docs/USD-3rd-Party-Plugins.html).
+These plugins are not built by default and must be enabled via the instructions below.
+
+##### Alembic Plugin
+
+Enable the [Alembic](https://https://github.com/alembic/alembic) plugin in the build
+by specifying the cmake flag ```PXR_BUILD_ALEMBIC_PLUGIN=TRUE``` when invoking cmake.
+This plugin is compatible with Alembic 1.5.2. The additional dependencies that must be supplied when invoking cmake are:
+
+| Dependency Name    | Description                                                             | Version |
+| ------------------ |-----------------------------------------------------------------------  | ------- |
+| ALEMBIC_LOCATION   | The location of [Alembic](https://https://github.com/alembic/alembic)   | 1.5.2   |
+| HDF5_LOCATION      | The location of [HDF5](https://www.hdfgroup.org/HDF5/)                  | 1.8.11  |
+
+For further information see the documentation on the Alembic plugin [here](http://openusd.org/docs/Alembic-USD-Plugin.html).
+
+##### Maya Plugin
+
+Enable the Maya plugin in the build by specifying the cmake flag ```PXR_BUILD_MAYA_PLUGIN=TRUE``` 
+when invoking cmake. This plugin is compatible with Maya 2016. The additional dependencies that must be supplied when invoking cmake are:
+
+| Dependency Name   | Description                                                                                     | Version   |
+| ----------------- | -----------------------------------                                                             | --------- |
+| MAYA_LOCATION     | The root path to a Maya SDK install                                                             | Maya 2016 |
+| MAYA_tbb_LIBRARY  | The location of TBB, this should be the same as TBB_tbb_LIBRARY provided to the core USD build  |           |
+
+For further information see the documentation on the Maya plugin [here](http://openusd.org/docs/Maya-USD-Plugins.html).
+
+##### Katana Plugin
+
+Enable the Katana plugin in the build by specifying the cmake flag ```PXR_BUILD_KATANA_PLUGIN=TRUE``` 
+when invoking cmake. This plugin is compatible with Katana 2.0v5. The additional dependencies that must be supplied when invoking cmake are:
+
+| Dependency Name       | Description                           | Version   |
+| --------------        | -----------------------------------   | -------   |
+| KATANA_API_LOCATION   | The root path to a Katana SDK install.| 2.0v5     |
+
+For further information see our additional documentation on the Katana plugins [here](http://openusd.org/docs/Katana-USD-Plugins.html).
+
+## Other Build Options
+
+##### Plugin Metadata Location
+
+Each library in the USD core generally has an associated file named 'plugInfo.json' that contains metadata about that library,
+such as the schema types provided by that library. These files are consumed by USD's internal plugin system to lazily load
+libraries when needed. 
+
+The plugin system requires knowledge of where these metadata files are located. The cmake build will ensure this is set up
+properly based on the install location of the build. However, if you plan to relocate these files to a new location after
+the build, you must inform the build by setting the cmake variable ```PXR_INSTALL_LOCATION``` to the intended final
+directory where these files will be located. This variable may be a ':'-delimited list of paths.
+
+## USD Developer Options
+
+##### ASCII Parser Editing/Validation
+
+There is an ASCII parser for the USD file format, which can be found in 
+[sdf](pxr/usd/sdf/). Most users will not have a need to edit the parser, but 
+for the adventurous ones, there are a couple additional requirements.
+
+If you choose to edit the ASCII parsers, make sure 
+```PXR_VALIDATE_GENERATED_CODE``` is set to ```TRUE```.  This flag enables tests 
+that check the generated code in [sdf](pxr/usd/lib/sdf) and 
+[gf](pxr/base/lib/gf).
+
+| Dependency Name                | Description                                                      | Version |
+| ------------------------------ |----------------------------------------------------------------- | ------- |
+| FLEX_EXECUTABLE                | Path to [flex](http://flex.sourceforge.net/) executable          | 2.5.35  |
+| BISON_EXECUTABLE               | Path to [bison](https://www.gnu.org/software/bison/) executable  | 2.4.1   |                        
+
+##### USD Schema Generation
+
+USD generates some code through a process called [schema 
+generation]. This process requires the following python modules be installed
+and available on the syspath. You can learn more about Schemas and why you 
+might want to generate them
+[here](http://openusd.org//docs/Generating-New-Schema-Classes.html).
+
+| Python Module Name                                           | Description                                                      | Version |
+| ------------------------------------------------------------ |----------------------------------------------------------------- | ------- |
+| [Jinja2](http://jinja.pocoo.org/docs/dev/)                   | Jinja is the core code generator of usdGenSchema                 | 2.0     |
+| [Argparse](https://docs.python.org/3/library/argparse.html)  | Argparse is used for basic command line arguments                |         |
+
+
+## Optimization Options
+
+There are certain optimizations that can be enabled in the build.
+
+##### Malloc Library
+
+We've found that USD performs best with allocators such as [Jemalloc](https://github.com/jemalloc/jemalloc).
+In support of this, you can specify your own allocator through ```PXR_MALLOC_LIBRARY```.
+This variable should be set to a path to a shared object for the allocator. For example,
+
+```bash
+-DPXR_MALLOC_LIBRARY:path=/usr/local/lib/libjemalloc.so
+```
+
+If none are specified, the default allocator will be used. More information on getting the most out of
+USD can be found [Getting the Best Performance with USD](http://openusd.org/docs/Maximizing-USD-Performance.html).
+

CMakeLists.txt

@@ -0,0 +1,60 @@
+project(usd)
+cmake_minimum_required(VERSION 2.8.8)
+
+set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/defaults
+                      ${CMAKE_SOURCE_DIR}/cmake/modules
+                      ${CMAKE_SOURCE_DIR}/cmake/macros)
+
+include(Options)
+include(ProjectDefaults)
+include(Packages)
+
+# This has to be defined after Packages is included, because it relies on the
+# discovered path to the python executable.
+set(PXR_PYTHON_SHEBANG "${PYTHON_EXECUTABLE}" 
+    CACHE 
+    STRING
+    "Replacement path for Python #! line."
+)
+
+# CXXDefaults will set a variety of variables for the project.
+# Consume them here. This is an effort to keep the most common
+# build files readable.
+include(CXXDefaults)
+add_definitions(${_PXR_CXX_DEFINITIONS})
+set(CMAKE_CXX_FLAGS ${_PXR_CXX_FLAGS})
+
+include(Public)
+
+add_subdirectory(pxr)
+add_subdirectory(extras)
+
+function(_addIfExists pkg pkgCmakeLists)
+    if (EXISTS ${pkgCmakeLists})
+        add_subdirectory(${pkg})
+    else()
+        message(WARNING "Specified third party package '${pkgName}' was not found. Please check that '${pkgCmakeLists}' exists")
+    endif()
+endfunction()
+
+function(_enableThirdPartyPlugin identifier)
+    set(pkg third_party/${identifier}) 
+    set(pkgCmakeLists ${CMAKE_CURRENT_SOURCE_DIR}/${pkg}/CMakeLists.txt)
+    _addIfExists(${pkg} ${pkgCmakeLists})
+endfunction()
+
+if (${PXR_BUILD_KATANA_PLUGIN})
+    if (NOT ${PXR_BUILD_USD_IMAGING})
+        message(WARNING "Skipping third_party/katana because PXR_BUILD_USD_IMAGING=OFF")
+    else()
+        _enableThirdPartyPlugin("katana")
+    endif()
+endif()
+
+if (${PXR_BUILD_MAYA_PLUGIN})
+    if (NOT ${PXR_BUILD_USD_IMAGING})
+        message(WARNING "Skipping third_party/maya because PXR_BUILD_USD_IMAGING=OFF")
+    else()
+        _enableThirdPartyPlugin("maya")
+    endif()
+endif()

ISSUES.md

@@ -0,0 +1,50 @@
+Filing Issues for USD
+=====================
+
+We are very excited to gather community feedback for USD. If you have found an
+issue, we ask that you follow these guidelines when filing.
+
+- List all relevant configuration information, including operating system,
+software versions, hardware configuration, driver versions etc.
+
+- Provide a "Minimal Repro", meaning the smallest set of steps necessary to 
+reproduce the bug.
+
+Below is an example bug description:
+
+    *Title*: Usd Stage Fails to Save.
+
+    *Content*:
+    System Information:
+    ```
+    Operating System: Ubuntu 12.04 64Bit
+    Hardware Configuration: Intel Core i5, Nvidia GTX 980(Driver 343.22)
+    Intel TBB Version: 4.4 Update 5
+    G++ Version: 6.1.0
+    Python Version: 2.7.5
+    Boost Version: 1.6.1
+    OpenSubdiv Version: 3.0.5 
+    GLEW Version: 1.10.0 
+    OpenImageIO Version: 1.5.11
+    Ptex Version: 2.0.30
+    Qt Version: 4.8.1 
+    Pyside Version: 1.2.2
+    ```
+
+
+    Repro case:
+    1. Launch Python
+    2. Run the following snippet
+
+    ```python
+
+        >>> from pxr import Usd
+        >>> stage = Usd.Stage.CreateNew('hello.usda')
+        >>> stage.GetRootLayer().Save()
+    ```
+
+    3. Note that 'hello.usda' is not created on disk, my expectation is that
+    it would be
+
+These guidelines will help us get to issues more quickly, we appreciate your
+help!