fitbenchmarking.cli.checkpoint_handler module

This is a command line tool for handling checkpoint files for the FitBenchmarking software package. For more information on usage type fitbenchmarking –help or for more general information, see the online docs at docs.fitbenchmarking.com.

fitbenchmarking.cli.checkpoint_handler.generate_report(options_file='', additional_options=None, debug=False)

Generate the fitting reports and tables for a checkpoint file.

Parameters

• options_file (str, optional) – Path to an options file, defaults to ‘’

• additional_options (dict, optional) –

  Extra options for the reporting. Available keys are:

  filename (str): The checkpoint file to use.

fitbenchmarking.cli.checkpoint_handler.get_parser() → argparse.ArgumentParser

Creates and returns a parser for the args.

Returns

Configured argument parser

Return type

ArgumentParser

fitbenchmarking.cli.checkpoint_handler.main()

Entry point exposed as the fitbenchmarking-cp command.