Maya Dome Diagnostics Tool - zicher3d-org/domemaster-stereo-shader GitHub Wiki
Introduction
The Dome Diagnostics tool provides a markdown formatted report log that analyses your current Maya session information using a MEL script. It is a powerful tool that can help troubleshoot configuration issues with hardware, networking, mapped network drives, environment variables, Maya scene files, Maya plugins, and 3rd party renderers.
Launching the Diagnostics Tool
After you run the Dome Diagnostics tool a log is saved to your desktop. If you have notepad++ installed on your system, the log file will be opened in a new notepad++ window.
Domemaster3D Shelf Item
The Dome Diagnostics tool can be launched from the Domemaster3D shelf by clicking on the "Diag" shelf icon.
Domemaster3D Menu Item
If you switch to the Rendering menu set, you can open the Domemaster3D menu and select the "Create Diagnostics Report" menu item.
Launching domeDiagnostics.mel in MayaBatch
It is possible to launch the diagnostics tool from the command line using the terminal / command prompt window. This can be handy if you are using SSH or screen sharing to investigate render node issues.
Windows Diagnostics
Here is an example using Maya Batch with the domeDiagnostics() MEL function on Windows:
mayabatch -script "C:\Program Files\Domemaster3D\maya\common\scripts\domeDiagnostics.mel" -command "domeDiagnostics();"
Mac Diagnostics
Here is an example using Maya Batch with the domeDiagnostics() MEL function on Mac OS X. The Mac example assumes you are using the Autodesk Maya provided terminal file "Maya Terminal.term", or you have added the mayabatch program folder to your system path variable using your ~/.bash_profile document.
mayabatch -script "/Applications/Domemaster3D/maya/common/scripts/domeDiagnostics.mel" -command "domeDiagnostics();"
Linux Diagnostics
Here is an example using Maya Batch with the domeDiagnostics() MEL function on Linux. For the example it is expected that the mayabatch program folder is in your system path variable.
maya -batch -script "/opt/Domemaster3D/maya/common/scripts/domeDiagnostics.mel" -command "domeDiagnostics();"
Diagnostics Report
The DomeDiagnostics function creates a dynamically generated report using Maya and MEL scripting with the following Maya specific outputs:
- Computer Name
- User Account
- Hardware
- Processor Type
- Number of Processors & Speed
- Physical Memory
- Free System Memory
- Networking
- Network Adapters
- IP addresses
- MAC Addresses
- Hard Disks
- Graphics
- Graphics Card Model
- Free GPU Memory
- OpenGL version
- Active Processes
- Maya Details
- Maya Version + Platform
- Maya Install Location
- Maya UI Language Format
- Maya Locale (Codeset) Format
- Maya Build Version
- MAYA Network Connection Status
MAYA_LICENSEMAYA_LICENSE_METHODMAYA_DISABLE_IDLE_LICENSEMAYA_ALT_EN- Rendering Software Available
- Active Renderer
- Current Maya Scene
- Recent Scenes
- Current Workspace
- Recent Workspaces
- Renderable Cameras
- Maya Home Folder Path
- Maya Render Log File Path
- Maya Scripts Folder List
Maya.envFile PathMaya.envFile ContentsuserSetup.pyFile ContentsuserSetup.melFile ContentsMAYA_MODULE_PATHMAYA_SHELF_PATHMAYA_SCRIPT_PATHSHARED_MAYA_DIRPYTHONPATHMAYA_PRESET_PATHXBMLANGPATHMAYA_PLUG_IN_PATHMAYA_QUICKTIME_ENCODING_GAMMAMAYA_RUNNING_TESTSMAYA_NO_CONSOLE_WINDOWMAYA_DISABLE_IDLE_LICENSEMAYA_ADSK_ASSET_LIBSMAYA_BATCH_RENDERING_STOPS_ON_ERRORMAYA_BG_DEPTH_IMAGEMAYA_BIFROST_COMPOUNDSMAYA_COLOR_MANAGEMENT_POLICY_FILEMAYA_COLOR_MANAGEMENT_POLICY_LOCKMAYA_CUSTOM_TEMPLATE_PATHMAYA_DISABLE_LOOKDEV_MATERIAL_VIEWERMAYA_DISABLE_LOOKDEV_PROPERTY_PANELMAYA_DISABLE_VP2_WHEN_POSSIBLEMAYA_ENABLE_CLASSIC_HAIRMAYA_ENABLE_LEGACY_HYPERSHADEMAYA_ENABLE_LEGACY_PARTICLESMAYA_ENABLE_LEGACY_RIGIDMAYA_ENABLE_LEGACY_RENDER_LAYERSMAYA_ENABLE_VP2_SHAPE_INSTANCINGMAYA_EXPOSE_FACADE_NODESMAYA_FBX_PLUGIN_LOCATIONMAYA_HELP_URLMAYA_NO_INITIAL_AUTOLOAD_MTMAYA_OFFSCREEN_HRBMAYA_OGS_DEVICE_OVERRIDEMAYA_PLUG_IN_RESOURCE_PATHMAYA_PROJECTMAYA_PROJECTS_DIRMAYA_PSEUDOTRANS_MODEMAYA_REAL_WORLD_SIZEMAYA_REVERSE_FILEFORMAT_EXTMAYA_SCRIPT_BASEMAYA_SHADER_LIBRARY_PATHMAYA_TESTING_CLEANUPMAYA_TEXTURED_SCULPTMAYA_UI_LANGUAGEMAYA_VP2_DEVICE_OVERRIDEMAYA_VR_PER_SHAPE_ATTRNEX_DRINIT_PATHONECLICK_KEEP_TEMP_FILESONECLICK_SELECT_WHOLE_CHARACTERONECLICK_TEMP_DIRPYMEL_SKIP_MEL_INITALIAS_RENDER_LIB_PATHENABLE_DEFAULT_VIEWPORT_CAMERA_SETSSUBSTANCES_LOCATIONWINEDITORXPC_SERVICE_NAME- Loaded Maya Plugins
- Image Formats
- Bifrost Environment Variables
BIFROST_ECHO_GEOSHADERBIFROST_ENABLE_GRAPH_EDITINGBIFROST_LOCATION
- QT Support Environment Variables
QT_MAC_NO_NATIVE_MENUBARQT_HIGHDPI_AWAREMAYA_ALIEN_WIDGETS
- XGEN Environment Variables
XGEN_CONFIG_PATHXGEN_EXPORT_ARCHIVE_STANDALONEXGEN_LOCATIONXGEN_ROOTHDF5_DISABLE_VERSION_CHECK
- SEEXPR Software Environment Variables
SE_EXPR_PLUGINS
- Domemaster3D Environment Variables
DOMEMASTER3D_MAYA_DIRDOMEMASTER3D_MAYA_TARGETDOMEMASTER3D_MAYA_REALTIME_FOV- Dome Diagnostics Script Path
- OS Environment Variables
- PATH
- TEMP
- USERPROFILE PATH
LD_LIBRARY_PATH
- Mental Ray Environment Variables
MI_CUSTOM_SHADER_PATHMI_CUSTOM_SHADER_SUPPRESSMI_MAYA_SOCKETSMI_MAYA_BATCH_OPTIONSMI_LIBRARY_PATHMENTALRAY_LOCATIONMENTALRAY_BIN_LOCATIONMENTALRAY_SHADERS_LOCATIONMENTALRAY_INCLUDE_LOCATIONMAYA_EXR_LONGNAMEMAYA_MRFM_SHOW_CUSTOM_SHADERSMAYATOMRIMF_PLUG_IN_PATH- Mental Ray Include Directory Contents
- Mental Ray Shader Directory Contents
- Arnold Environment Variables
solidangle_LICENSEARNOLD_PATHARNOLD_PLUGIN_PATHMTOA_TEMPLATES_PATHMTOA_EXTENSIONS_PATHMTOA_PATHMTOA_LOG_PATHMTOA_SILENT_MODEMTOA_COMMAND_PORTARNOLD_LICENSE_ATTEMPTSARNOLD_LICENSE_ATTEMPT_DELAYK_SEARCH_PATH
- PlayblastVR Variables and OptionVars
PlayblastVR Panorama FormatShow Batch Sequence viewerPlayblastVR Module Path
- Maxwell Environment Variables
MAXWELL3_ROOTMAXWELL3_LICENSE_SERVERMAXWELL3_MATERIALS_DATABASE
- Vray Environment Variables
VRAY_PATHVRAY_PLUGINS_x64VRAY_AUTH_CLIENT_FILE_PATHVRAY_FOR_MAYA_DRLISTS_PATHVRAY_FOR_MAYA_DRPORTVRAY_ADVANCED_UIVRAY_FOR_MAYA2010_MAIN_x64VRAY_FOR_MAYA2010_PLUGINS_x64VRAY_TOOLS_MAYA2010_x64VRAY_FOR_MAYA2011_MAIN_x64VRAY_FOR_MAYA2011_PLUGINS_x64VRAY_TOOLS_MAYA2011_x64VRAY_FOR_MAYA2012_SKIP_NODE_CATEGORIZATIONVRAY_FOR_MAYA2012_MAIN_x64VRAY_FOR_MAYA2012_PLUGINS_x64VRAY_TOOLS_MAYA2012_x64VRAY_FOR_MAYA2013_MAIN_x64VRAY_FOR_MAYA2013_PLUGINS_x64VRAY_TOOLS_MAYA2013_x64VRAY_FOR_MAYA2014_MAIN_x64VRAY_FOR_MAYA2014_PLUGINS_x64VRAY_FOR_MAYA2014_MAIN_PowerPCVRAY_TOOLS_MAYA2014_x64VRAY_FOR_MAYA2015_MAIN_x64VRAY_FOR_MAYA2015_PLUGINS_x64VRAY_TOOLS_MAYA2015_x64VRAY_FOR_MAYA2016_MAIN_x64VRAY_FOR_MAYA2016_PLUGINS_x64VRAY_TOOLS_MAYA2016_x64VRAY_OSL_PATH_MAYA2016_PowerPCVRAY_OSL_PATH_MAYA2016_x64VRAY_FOR_MAYA2016_5_MAIN_x64VRAY_FOR_MAYA2016_5_PLUGINS_x64VRAY_FOR_MAYA2016_5_MAIN_PowerPCVRAY_FOR_MAYA2016_5_PLUGINS_PowerPCVRAY_TOOLS_MAYA2016_5_x64
- Fabric Engine Environment Variables
FABRIC_CAPI_DIRFABRIC_DIRFABRIC_DOCUMENTATION_DIRFABRIC_EDK_DIRFABRIC_PYTHON_MODULE_DIRFABRIC_TOOLS_DIRFABRIC_EXTS_PATHFABRIC_SPLICE_UNGUARDEDFABRIC_CUDA_LOG
- RLM License Manager Environment Variables
HTTP_PROXYRLM_COMM_TIMEOUTRLM_CONNECT_TIMEOUTRLM_DEBUGRLM_DIAGNOSTICSRLM_EXTENDED_ERROR_MESSAGESRLM_LICENSERLM_NO_UNLIMITRLM_LICENSE_PASSWORDRLM_PATH_RANDOMIZERLM_PROJECTRLM_QUEUERLM_ROAMRLMSTAT
Viewing the Markdown Formatted Log
The diagnostics report is saved automatically to the system's desktop folder with the following naming convention:
Domemaster3D_Report_<Computer Name>_<User Account Name>.md
Using the above naming template, running the analysis report on a computer with the name "HP" and a user account of "hazelden" will create a diagnostics file named:
Domemaster3D_Report_HP_hazelden.md
The diagnostics output is formatted in plain text format using the "markdown" syntax and can be opened in Markdown Pad / StackEdit / Notepad++ / TextWrangler / BBedit / Atom or any other plain text editor. My personal favorite "visual" markdown document editors are Markdown Pad, and Atom and they both are available as free to use programs.
StackEdit
Markdown Pad
Notepad++
