NeuroRuler.CLI package

Submodules

NeuroRuler.CLI.main module

Defines main(), the entrypoint of the CLI.

See tests/test_cli.py for examples of how to use this script.

Run with the -h option to see all CLI options.

NeuroRuler.CLI.main.main() None[source]

Main entrypoint of CLI.

Module contents

After installing NeuroRuler via pip, the functions here are importable like so

from NeuroRuler.CLI import {function}

where NeuroRuler.CLI is the name of the package this __init__.py file is in.

NeuroRuler.CLI.cli() None[source]

Run CLI.

Will create cli_config.json using package’s cli_config.json if it doesn’t already exist.