Skip to content

Latest commit

 

History

History

pymaterialx

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
JSON_output
JSON_output
 
 
OCIO_output
OCIO_output
 
 
data
data
 
 
data_rendered
data_rendered
 
 
images
images
 
 
mtlxutils
mtlxutils
 
 
python
python
 
 
renders
renders
 
 
videos
videos
 
 
MaterialX_Python_Environment_Setup.md
MaterialX_Python_Environment_Setup.md
 
 
README.md
README.md
 
 
_generateMermaidGraph.py
_generateMermaidGraph.py
 
 
add_remove_node.py
add_remove_node.py
 
 
blender_export_mtlx_noui.html
blender_export_mtlx_noui.html
 
 
blender_export_mtlx_noui.ipynb
blender_export_mtlx_noui.ipynb
 
 
blender_export_mtlx_noui.py
blender_export_mtlx_noui.py
 
 
blender_mtlx.py
blender_mtlx.py
 
 
blender_notes.ipynb
blender_notes.ipynb
 
 
blender_uvbox.py
blender_uvbox.py
 
 
buildMaterialX.html
buildMaterialX.html
 
 
compareVersions.py
compareVersions.py
 
 
createDefinitions.py
createDefinitions.py
 
 
genMaterialsFromDefs.py
genMaterialsFromDefs.py
 
 
genOCIODefinitions.py
genOCIODefinitions.py
 
 
hello_materialx.py
hello_materialx.py
 
 
image_to_mesh.py
image_to_mesh.py
 
 
inlineImplementationFiles.py
inlineImplementationFiles.py
 
 
inside_blender_mtlx.py
inside_blender_mtlx.py
 
 
jsonIO.py
jsonIO.py
 
 
load_libraries.py
load_libraries.py
 
 
misc.ipynb
misc.ipynb
 
 
mtlx_bard.html
mtlx_bard.html
 
 
mtlx_bard.ipynb
mtlx_bard.ipynb
 
 
mtlx_bard.py
mtlx_bard.py
 
 
mtlx_basics_notebook.html
mtlx_basics_notebook.html
 
 
mtlx_basics_notebook.ipynb
mtlx_basics_notebook.ipynb
 
 
mtlx_basics_notebook.py
mtlx_basics_notebook.py
 
 
mtlx_brick.json
mtlx_brick.json
 
 
mtlx_comparing_notebook.html
mtlx_comparing_notebook.html
 
 
mtlx_comparing_notebook.ipynb
mtlx_comparing_notebook.ipynb
 
 
mtlx_comparing_notebook.py
mtlx_comparing_notebook.py
 
 
mtlx_connectivity_notebook.html
mtlx_connectivity_notebook.html
 
 
mtlx_connectivity_notebook.ipynb
mtlx_connectivity_notebook.ipynb
 
 
mtlx_connectivity_notebook.py
mtlx_connectivity_notebook.py
 
 
mtlx_copilot.html
mtlx_copilot.html
 
 
mtlx_copilot.ipynb
mtlx_copilot.ipynb
 
 
mtlx_copilot.py
mtlx_copilot.py
 
 
mtlx_definitions_libraries_notebook.html
mtlx_definitions_libraries_notebook.html
 
 
mtlx_definitions_libraries_notebook.ipynb
mtlx_definitions_libraries_notebook.ipynb
 
 
mtlx_definitions_libraries_notebook.py
mtlx_definitions_libraries_notebook.py
 
 
mtlx_definitions_notebook.html
mtlx_definitions_notebook.html
 
 
mtlx_definitions_notebook.ipynb
mtlx_definitions_notebook.ipynb
 
 
mtlx_definitions_notebook.py
mtlx_definitions_notebook.py
 
 
mtlx_generate_code.html
mtlx_generate_code.html
 
 
mtlx_generate_code.ipynb
mtlx_generate_code.ipynb
 
 
mtlx_generate_code.py
mtlx_generate_code.py
 
 
mtlx_graphs_notebook.html
mtlx_graphs_notebook.html
 
 
mtlx_graphs_notebook.ipynb
mtlx_graphs_notebook.ipynb
 
 
mtlx_graphs_notebook.py
mtlx_graphs_notebook.py
 
 
mtlx_json_notebook.html
mtlx_json_notebook.html
 
 
mtlx_json_notebook.ipynb
mtlx_json_notebook.ipynb
 
 
mtlx_json_notebook.pdf
mtlx_json_notebook.pdf
 
 
mtlx_json_notebook.py
mtlx_json_notebook.py
 
 
mtlx_node_editors.ipynb
mtlx_node_editors.ipynb
 
 
mtlx_ocio.html
mtlx_ocio.html
 
 
mtlx_ocio.ipynb
mtlx_ocio.ipynb
 
 
mtlx_ocio.pdf
mtlx_ocio.pdf
 
 
mtlx_ocio.py
mtlx_ocio.py
 
 
mtlx_removal_notebook.html
mtlx_removal_notebook.html
 
 
mtlx_removal_notebook.ipynb
mtlx_removal_notebook.ipynb
 
 
mtlx_removal_notebook.py
mtlx_removal_notebook.py
 
 
mtlx_render_notebook.html
mtlx_render_notebook.html
 
 
mtlx_render_notebook.ipynb
mtlx_render_notebook.ipynb
 
 
mtlx_render_notebook.py
mtlx_render_notebook.py
 
 
mtlx_render_notebook2.py
mtlx_render_notebook2.py
 
 
mtlx_render_notebook_working.html
mtlx_render_notebook_working.html
 
 
mtlx_render_notebook_working.ipynb
mtlx_render_notebook_working.ipynb
 
 
mtlx_render_notebook_working.py
mtlx_render_notebook_working.py
 
 
mtlx_shadergen_notebook.html
mtlx_shadergen_notebook.html
 
 
mtlx_shadergen_notebook.ipynb
mtlx_shadergen_notebook.ipynb
 
 
mtlx_shadergen_notebook.py
mtlx_shadergen_notebook.py
 
 
mtlx_targets_notebook.html
mtlx_targets_notebook.html
 
 
mtlx_targets_notebook.ipynb
mtlx_targets_notebook.ipynb
 
 
mtlx_targets_notebook.py
mtlx_targets_notebook.py
 
 
mtlx_traversal_notebook.html
mtlx_traversal_notebook.html
 
 
mtlx_traversal_notebook.ipynb
mtlx_traversal_notebook.ipynb
 
 
mtlx_traversal_notebook.py
mtlx_traversal_notebook.py
 
 
mtlx_usd.py
mtlx_usd.py
 
 
mtlx_usd_builds.html
mtlx_usd_builds.html
 
 
mtlx_usd_builds.ipynb
mtlx_usd_builds.ipynb
 
 
mtlx_usd_builds.py
mtlx_usd_builds.py
 
 
mtlx_usd_notebook.html
mtlx_usd_notebook.html
 
 
mtlx_usd_notebook.ipynb
mtlx_usd_notebook.ipynb
 
 
mtlx_usd_notebook.py
mtlx_usd_notebook.py
 
 
mtlx_validation.html
mtlx_validation.html
 
 
mtlx_validation.ipynb
mtlx_validation.ipynb
 
 
mxgraphio.py
mxgraphio.py
 
 
nested_nodegraph.md
nested_nodegraph.md
 
 
node_usage.html
node_usage.html
 
 
node_usage.ipynb
node_usage.ipynb
 
 

README.md

Python MaterialX Workspace

This folder can be used as a workspace for running MaterialX via Python.

There are various example (.ipynb) files which correspond to tutorials (Jupyter notebooks) on the learning site. The corresponding html and python files are generated from those notebooks. MaterialX and other support file types are included.

The files are targeted for usage with Visual Studio Code with appropriate extensions installed to run in a Python virtual environment. Other editors can be used as desired. These notebooks can be used as is or published to something like a Github Codespaces or Google Colab.

The notebooks are not "published" as yet due to lack of a PyPi package for MaterialX (note that at time of writing this is in the works).

Dependent packages used in the notebooks are not installed within the notebooks. They can be installed from PyPi as needed (e.g, Usd and Blender packages)

All notebooks currently have been tested with Python 3.10 and 3.9.

Support Files

  • Utilities used for tutorials are packaged in the mtlxutils folder.
  • Data files used for tutorials are in the data folder.
  • As of MaterialX 1.38.7 definition libraries are part of the Python package.
  • The videos folder will contain videos for tutorials. Currently a Python / Visual Studio code setup video is included.

Additional Utilities

Some stand-alone utilities are available which package up notebook logic, or additional logic. This includes:

  • usd_mtlx.py : Usd to MaterialX sample converter. Logic used in the Usd / MaterialX notebookx
  • blender_mtlx.py : Blender material to MaterialX / GLTF converter. Logic for bespoke conversion as shown in the Blender notebook

As with notebooks, additional utilities will be made available over time, if not added as part of the core MaterialX distribution. This includes scripts used to generate the site's contents such as the definition reference library.