unravel.unravel_commands module#

Use unravel_commands or uc to print a list of commands available in the UNRAVEL package.

For help on a command, run: <command> -h

Note

  • Documentation: https://b-heifets.github.io/UNRAVEL/

  • Commands are roughly organized by the order of the workflow and/or the relatedness of the commands.

  • Aliases are provided for most commands to make them easier to type.

  • Filtering is case-insensitive and matches substrings in the printed lines (regex).

  • For example, use of -f with -d will find matches in the command name and/or description, preserving those lines.

Next steps:
  • Start with io_metadata (m) for most workflows (e.g., to extract or specify raw voxel sizes and image dimensions).

  • Many scripts are designed for batch processing of sample directories, which can be tested using utils_get_samples (s).

Usage to print common commands, aliases, and descriptions:#

uc -cad

Usage to print all commands matching a specific string:#

uc -ad -f vstats # Find voxel-wise stats commands

Usage to print all commands and module names:#

uc -m

unravel.unravel_commands.parse_args()[source]#
unravel.unravel_commands.main()[source]#