cli¶

Command-line entry point for PREP-SHOT.

Run as a console script after pip install:

prepshot

Or as a Python module:

python -m prepshot

Both forms look for config.json and params.json in the current working directory by default. The legacy entry point (python run.py) remains supported and reads those files relative to run.py instead.

prepshot.cli.main(root_dir=None)[source]¶

Run a full PREP-SHOT solve.

Parameters: root_dir (str, optional) -- Directory containing config.json and params.json. Defaults to the current working directory.
Returns: True if the model solved to optimality and results were saved, False otherwise.
Return type: bool