pypeit.scripts.dashboard module

Command-line launcher for the PypeIt Dashboard.

The dashboard is launched like every other PypeIt script (e.g. run_pypeit): via this ScriptBase subclass, registered as the pypeit_dashboard console entry point.

class pypeit.scripts.dashboard.PypeItDashboard

Bases: ScriptBase

The pypeit_dashboard console script.

classmethod get_parser(width=None)

Construct the command-line argument parser.

Parameters:

width (int, optional) – Restrict the formatted help width to this many characters.

Returns:

The command-line parser.

Return type:

argparse.ArgumentParser

classmethod init_log(args)

Initialize the logger and install the dashboard’s exception hook.

Extends init_log(): after the standard logger setup (which installs the general PypeItLogger exception hook), replace the hook with dashboard_excepthook(), which logs the full traceback through the logger. Exceptions raised inside Qt slots are otherwise swallowed by the C++ event loop, so the dashboard needs every unhandled exception recorded loudly, with its complete traceback, in the console and log file.

Parameters:

args (argparse.Namespace) – The parsed command-line arguments.

classmethod main(args)

Launch the dashboard.

Parameters:

args (argparse.Namespace) – The parsed command-line arguments.

Returns:

The Qt application exit code.

Return type:

int