Skip to content

Introspection Workflow

CLI workflow for introspecting ReaxKit modules and folders.

This workflow powers the reaxkit intspec command, allowing users to: - Inspect a single Python module and view its top-level docstring summary along with public functions/classes and their one-line descriptions. - Recursively scan a folder or package and list all contained .py files with their module docstring first lines.

It is designed as a lightweight discovery and navigation tool to help users understand what functionality exists inside ReaxKit without opening files manually.

Usage context

  • Command routing: Resolve CLI aliases and normalized command names.
  • Task execution: Build request objects and invoke registered tasks.
  • Output handling: Forward results to table, plot, export, or report flows.

Command: intspec

Arguments

No command-specific arguments found.

The figure below shows an example terminal output when running intspec on workflows.

Intspec_folder_workflows

Figure: Sample terminal output when running intspec on workflows.

Common Runtime and Presentation Arguments

These are shared workflow-level CLI flags added before command-specific options, covering runtime context (engine/input/storage) and output presentation/export behavior.

Flag Required Default Help Choices
--file No Module name or path to .py. Example: --file reaxkit.workflows.meta.help_workflow, which inspects that module and lists public symbols.
--folder No Folder/package to scan recursively. Example: --folder workflows, which expands to the workflows package and lists contained modules.