Include standard data libraries in Python package (AcademySoftwareFou…

…ndation#1237)

Package the standard definition libraries as part of the Python package. This removes the need for users to have to always search for the libraries, and the possibility to mistakenly use libraries which do not match the Python distribution.

.github/workflows/main.yml

@@ -197,7 +197,7 @@ jobs:
         python MaterialXTest/main.py
         python MaterialXTest/genshader.py
         python Scripts/mxupdate.py ../resources/Materials/TestSuite/stdlib/upgrade --yes
-        python Scripts/mxvalidate.py ../resources/Materials/Examples/StandardSurface/standard_surface_marble_solid.mtlx --verbose
+        python Scripts/mxvalidate.py ../resources/Materials/Examples/StandardSurface/standard_surface_marble_solid.mtlx --stdlib --verbose
         python Scripts/mxdoc.py --docType md ../libraries/pbrlib/pbrlib_defs.mtlx
         python Scripts/mxdoc.py --docType html ../libraries/bxdf/standard_surface.mtlx
         python Scripts/generateshader.py ../resources/Materials/Examples/StandardSurface --path .. --target glsl

libraries/CMakeLists.txt

@@ -11,3 +11,10 @@ endif()
 
 install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pbrlib/genosl/pbrlib_genosl_impl.${PBRLIB_SUFFIX}"
         DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)
+
+install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
+        DESTINATION "python/MaterialX/${MATERIALX_INSTALL_STDLIB_PATH}" 
+        PATTERN "CMakeLists.txt" EXCLUDE
+        PATTERN "pbrlib_genosl_impl.*" EXCLUDE)
+install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pbrlib/genosl/pbrlib_genosl_impl.${PBRLIB_SUFFIX}"
+        DESTINATION "python/MaterialX/${MATERIALX_INSTALL_STDLIB_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)

python/MaterialX/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include libraries

python/MaterialX/main.py

@@ -9,7 +9,7 @@
 from .PyMaterialXCore import *
 from .PyMaterialXFormat import *
 from .datatype import *
-
+import os
 
 #
 # Element
@@ -292,3 +292,20 @@ def _stringToValue(string, t):
 #
 
 readFromXmlFile = readFromXmlFileBase
+
+
+#
+# Data Search Paths
+#
+def getDefaultDataSearchPath():
+    """
+    Return the default data search path.
+    """
+    root_path = os.path.dirname(__file__)
+    return root_path
+
+def getDefaultDataLibraryFolders():
+    """
+    Return list of default data library folders
+    """
+    return [ 'libraries' ]

python/Scripts/mxvalidate.py

@@ -23,11 +23,11 @@ def main():
 
     if opts.stdlib:
         stdlib = mx.createDocument()
-        filePath = os.path.dirname(os.path.abspath(__file__))
-        searchPath = mx.FileSearchPath(os.path.join(filePath, '..', '..'))
-        searchPath.append(os.path.dirname(opts.inputFilename))
-        libraryFolders = [ "libraries" ]
-        mx.loadLibraries(libraryFolders, searchPath, stdlib)
+        try:
+            mx.loadLibraries(mx.getDefaultDataLibraryFolders(), mx.getDefaultDataSearchPath(), stdlib)            
+        except err:
+            print(err)
+            sys.exit(0)
         doc.importLibrary(stdlib)
 
     (valid, message) = doc.validate()