solprop.scan#

Launch an explicitly selected scan script without evaluating CLI expressions.

python -m solprop.scan script.py [options] (and solprop scan): main() parses the options into one execution policy (_policy: Local, Pool, Queue or Slurm), sets it as the default executor of the scan script, which it then runs as __main__; a run_scan() with an explicit executor still takes precedence. --emit-slurm writes the Slurm array script instead, and python -m solprop.scan collect QUEUE --output OUT.h5 collects a durable queue into a scan file. current_executor() reads the policy in force. No option is evaluated as Python. The manual page is docs/guide/workflows/scans.md.

Functions

main([argv])

Run a scan script under an explicit CLI policy.

solprop.scan.current_executor()#

Return the CLI policy within the currently executing script.

Returns:
Executor or None

Default executor; explicit run_scan arguments always take precedence.

solprop.scan.main(argv=None)[source]#

Run a scan script under an explicit CLI policy.

Parameters:
argvsequence of str or None, optional

CLI arguments, or None to parse process arguments.

Returns:
int

Zero after a successful script execution.