Using Workbench Command

Workbench Command is a set of command-line tools that can be used to perform simple and complex operations within Connectome Workbench.

Full Documentation:

Documentation Home
SCENE FILE AND ITS DATA FILES RESTRUCTURE
   wb_command -scene-file-restructure
      <input-scene> - Path to the input scene file
      <output-directory> - Directory where the restructured scene and data
         files will be placed

      [-preview] - Lists the files that would be created without performing any
         copying

      [-skip-missing-files] - Issues warnings for missing or network files
         instead of fatal errors

      [-test-scenes] - After copying, tests loading of files for each scene in
         the output scene file

      [-overwrite-files-mode] - Controls behavior when files already exist in
         the output directory
         <overwrite-files-mode> - the overwrite files mode (ERROR, YES, or
            SKIP)

      Restructure a scene file and its associated data files by copying them
      into a new directory structure located in the specified output directory.
      The original scene file and data files are NOT modified.

      After execution, the output directory will contain:
         * The restructured scene file.
         * A subdirectory named data_files containing all associated data
      files.


      Overwrite Modes:
         *  YES: Overwrites existing files.
         *  ERROR: Fails if a file would be overwritten (default).
         *  SKIP: Skips copying if the file already exists.


      Notes:
         *  For best results, ensure the output directory is empty before
      running this command.
         *  Missing files will cause a fatal error unless the skip missing
      files option is used.  Note that missing files may cause scenes to
      display incorrectly.
         *  Use the preview option to simulate the file copying operations and
      review the expected output (No output files are created).
         *  Some datasets may contain multiple scene files that share data
      files.  Run this command on each scene file and:(1) Use the same output
      directory;  (2) Set the Overwrite Mode to SKIP to preserve shared files.


      Known Limitations:
         *  Files with the same name in different directories are not
      supported.
         *  Unsupported file types: GIFTI External Binary Files; Histology
      Slices Files (*.metaczi *.meta-image); MetaVolume Files (*.meta-volume);
      OME-ZARR Image File Files (*.ome.zarr *.ome.zarr.zip)
         *  Remote files (e.g., hosted on web servers) are not supported.