matflow.environments.env_configure_dream3d#

matflow.environments.env_configure_dream3d(shell, pipeline_runner_path, setup_py=None, setup_runner=None, use_current=True)#

Configure the Dream3D MatFlow environment.

The Dream3D environment requires:

  1. a dream_3D_runner executable that runs the PipelineRunner CLI tool, and

  2. a python_script executable that runs the pre and post processing.

Parameters:

  • shell (Literal['bash', 'powershell']) –

  • pipeline_runner_path (str) –

  • setup_py (str | list[str] | None) –

  • setup_runner (str | list[str] | None) –

  • use_current (bool) –

Return type:

Environment