MAYA-105621 - MayaUSD: install USD from artifact beside plugin #631

seando-adsk · 2020-07-07T18:31:08Z

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

When given a USD relative path, set mod file and path/pythonpath accordingly.
Specific mod file for Windows (with paths) and Linux/Mac. Added .mod specific tags.

* When given a USD relative path, set mod file and path/pythonpath accordingly. * Specific mod file for Windows (with paths) and Linux/Mac. Added .mod specific tags.

seando-adsk · 2020-07-07T18:32:07Z

CMakeLists.txt

+if (DEFINED MAYAUSD_TO_USD_RELATIVE_PATH)
+    set(USD_INSTALL_LOCATION "${CMAKE_INSTALL_PREFIX}/${MAYAUSD_TO_USD_RELATIVE_PATH}")
+else()
+    set(USD_INSTALL_LOCATION ${PXR_USD_LOCATION})
+endif()


When given a USD relative path (from the ADSK internal build system) we will use that for the USD path in the .mod file.

Note: "USD_INSTALL_LOCATION" is a variable inside the module template files.

seando-adsk · 2020-07-07T18:32:28Z

CMakeLists.txt

+if (IS_WINDOWS)
+    configure_file(mayaUSD_Win.mod.template ${PROJECT_BINARY_DIR}/mayaUSD.mod)
+else()
+    configure_file(mayaUSD.mod.template ${PROJECT_BINARY_DIR}/mayaUSD.mod)
+endif()


Created Windows specific .mod file (with PATH) and one for Linux/Mac (no PATH)

seando-adsk · 2020-07-07T18:32:58Z

cmake/usd.cmake

+    if (DEFINED MAYAUSD_TO_USD_RELATIVE_PATH)
+        set(USD_INSTALL_LOCATION "${CMAKE_INSTALL_PREFIX}/${MAYAUSD_TO_USD_RELATIVE_PATH}")
+    else()
+        set(USD_INSTALL_LOCATION ${PXR_USD_LOCATION})
+    endif()


Again when given a USD relative path, use that for the PATH and PYTHONPATH.

I realized (from a clean build) that this change breaks the build. We need the PATH and PYTHONPATH to usd during the configure step for generating the schemas. So for that step we need to use USD from it's original location.

But then for running the tests we would want PATH & PYTHONPATH to point to the USD in the install folder. I need to think some more how to fix this.

seando-adsk · 2020-07-07T18:33:34Z

mayaUSD.mod.template

@@ -1,32 +1,37 @@
-+ USD ${USD_VERSION} ${PXR_USD_LOCATION}
+ USD ${USD_VERSION} ${USD_INSTALL_LOCATION}


Changed to new variable which is set from top-level CMakeLists.txt above.

seando-adsk · 2020-07-07T18:34:31Z

mayaUSD.mod.template

+icons: 
+plug-ins: 
+presets: 
+scripts: 
+resources: 


Use Maya module specific tags to not add anything specific for these paths since USD is not a Maya plugin and doesn't need Maya to know about its icons/presets/etc.

seando-adsk · 2020-07-07T18:35:01Z

mayaUSD.mod.template

-PATH+:=bin
-PATH+:=lib


These PATH vars are no needed on Linux/Mac. There is a Windows specific .mod template now.

seando-adsk · 2020-07-07T18:35:51Z

mayaUSD.mod.template

+icons: maya/lib/usd/usdMaya/resources
+plug-ins: maya/plugin
+scripts: maya/lib/usd/usdMaya/resources


Use module tags rather than setting the vars directly.

seando-adsk · 2020-07-07T18:36:26Z

mayaUSD_Win.mod.template

+PATH+:=bin
+PATH+:=lib


Windows specific mod template which just has these extra PATH lines. Otherwise it's identical.

HamedSabri-adsk

Great, Lgtm! Thank you.

* Moved the Maya module template files into sub-folder in repo.

* Reverted previous change to usd.cmake (adjustment to PATH/PYTHONPATH). Instead made that adjustment in test.cmake.

seando-adsk · 2020-07-08T14:49:31Z

cmake/test.cmake

+    # Adjust PATH and PYTHONPATH to include USD.
+    # These should come last (esp PYTHONPATH, in case another module is overriding
    # with pkgutil)
-    list(APPEND mayaUsd_varname_PATH $ENV{PATH})
-    list(APPEND mayaUsd_varname_PYTHONPATH $ENV{PYTHONPATH})
+   if (DEFINED MAYAUSD_TO_USD_RELATIVE_PATH)
+        set(USD_INSTALL_LOCATION "${CMAKE_INSTALL_PREFIX}/${MAYAUSD_TO_USD_RELATIVE_PATH}")
+    else()
+        set(USD_INSTALL_LOCATION ${PXR_USD_LOCATION})
+    endif()
+    list(APPEND mayaUsd_varname_PYTHONPATH
+        "${USD_INSTALL_LOCATION}/lib/python")
+    if(IS_WINDOWS)
+        list(APPEND mayaUsd_varname_PATH
+            "${USD_INSTALL_LOCATION}/bin")
+        list(APPEND mayaUsd_varname_PATH
+            "${USD_INSTALL_LOCATION}/lib")
+    endif()


I reverted my change in usd.cmake where I was using the USD from install folder because it was wrong. In our internal builds USD is only copied to install folder during install stage. During configure stage we'll need to use USD from the given input USD location.

However at test time we now check if we were given a USD relative path. If so we use'll that one and add USD to the PYTHONPATH from there.

Here I've only add USD to PATH when on Windows, just like usd.cmake does.

I believe that even all the PATH items above should only need to be done on Windows, but I didn't change them so as to not pollute this PR.

HamedSabri-adsk

Lgtm. Thanks Sean.

* Fix for Mac test failure.

* Fix for test failure on OSX, but also affects Windows/Linux.

seando-adsk · 2020-07-10T16:02:47Z

cmake/test.cmake

+    # NOTE: this should come after any setting of PATH/PYTHONPATH so
+    #       that our entries will come first.
+    # Inherit any existing PATH/PYTHONPATH, but keep it at the end.
+    # This is needed (especially for PATH) because we will overwrite
+    # both with the values from our list and we need to keep any
+    # system entries.
    list(APPEND mayaUsd_varname_PATH $ENV{PATH})
    list(APPEND mayaUsd_varname_PYTHONPATH $ENV{PYTHONPATH})


I realized this is important, especially for PATH. We will overwrite PATH with the value(s) set here. So we need to make sure we append the existing PATH otherwise we'll erase all the system entries and things won't work.

HamedSabri-adsk

lgtm! Thanks Sean.

seando-adsk · 2020-07-10T18:05:03Z

@mattyjams Can you have quick look at these changes to make sure nothing conflicts with the way you are building? Most of the changes are around "MAYAUSD_TO_USD_RELATIVE_PATH" which we use in our internal build system to generate relative rpaths. I split the Maya module template file into two (one Windows specific with PATH entries, and the other for Linux/Mac which use rpath). I also added some extra tags so Maya doesn't add extra paths for icons/scripts/etc for USD which aren't needed or wanted, since it is not a Maya plugin.

mattyjams

@seando-adsk: Yeah, this shouldn't affect us internally at all. Our internal build system is completely separate and ignores anything CMake-related.

Thanks!

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

b85cc41

* When given a USD relative path, set mod file and path/pythonpath accordingly. * Specific mod file for Windows (with paths) and Linux/Mac. Added .mod specific tags.

seando-adsk commented Jul 7, 2020

View reviewed changes

seando-adsk requested a review from HamedSabri-adsk July 7, 2020 18:36

HamedSabri-adsk approved these changes Jul 7, 2020

View reviewed changes

HamedSabri-adsk added the build Related to building maya-usd repository label Jul 7, 2020

seando-adsk assigned ecp-maya-devops-adsk Jul 7, 2020

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

fe99f65

* Moved the Maya module template files into sub-folder in repo.

seando-adsk added the do-not-merge-yet Development is not finished, PR not ready for merge label Jul 7, 2020

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

f7862eb

* Reverted previous change to usd.cmake (adjustment to PATH/PYTHONPATH). Instead made that adjustment in test.cmake.

seando-adsk commented Jul 8, 2020

View reviewed changes

seando-adsk requested a review from HamedSabri-adsk July 8, 2020 14:49

seando-adsk unassigned ecp-maya-devops-adsk Jul 8, 2020

HamedSabri-adsk approved these changes Jul 8, 2020

View reviewed changes

HamedSabri-adsk assigned ecp-maya-devops-adsk Jul 8, 2020

seando-adsk removed the do-not-merge-yet Development is not finished, PR not ready for merge label Jul 8, 2020

kxl-adsk assigned ecp-maya-devops-adsk and unassigned ecp-maya-devops-adsk Jul 9, 2020

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

10c096e

* Fix for Mac test failure.

seando-adsk assigned ecp-maya-devops-adsk and unassigned ecp-maya-devops-adsk Jul 9, 2020

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

5bce740

* Fix for test failure on OSX, but also affects Windows/Linux.

seando-adsk commented Jul 10, 2020

View reviewed changes

seando-adsk requested a review from HamedSabri-adsk July 10, 2020 16:02

seando-adsk assigned ecp-maya-devops-adsk and unassigned ecp-maya-devops-adsk Jul 10, 2020

HamedSabri-adsk approved these changes Jul 10, 2020

View reviewed changes

seando-adsk requested a review from mattyjams July 10, 2020 18:02

mattyjams approved these changes Jul 10, 2020

View reviewed changes

kxl-adsk merged commit 9e395a6 into dev Jul 10, 2020

kxl-adsk deleted the donnels/MAYA-105621/install_usd_to_install_folder branch July 10, 2020 20:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MAYA-105621 - MayaUSD: install USD from artifact beside plugin #631

MAYA-105621 - MayaUSD: install USD from artifact beside plugin #631

seando-adsk commented Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 9, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

seando-adsk Jul 7, 2020

HamedSabri-adsk left a comment

seando-adsk Jul 8, 2020

HamedSabri-adsk left a comment

seando-adsk Jul 10, 2020

HamedSabri-adsk left a comment

seando-adsk commented Jul 10, 2020

mattyjams left a comment

		@@ -1,32 +1,37 @@
		+ USD ${USD_VERSION} ${PXR_USD_LOCATION}
		+ USD ${USD_VERSION} ${USD_INSTALL_LOCATION}

		PATH+:=bin
		PATH+:=lib

		PATH+:=bin
		PATH+:=lib

MAYA-105621 - MayaUSD: install USD from artifact beside plugin #631

MAYA-105621 - MayaUSD: install USD from artifact beside plugin #631

Conversation

seando-adsk commented Jul 7, 2020

MAYA-105621 - MayaUSD: install USD from artifact beside plugin

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HamedSabri-adsk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HamedSabri-adsk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HamedSabri-adsk left a comment

Choose a reason for hiding this comment

seando-adsk commented Jul 10, 2020

mattyjams left a comment

Choose a reason for hiding this comment