fitbenchmarking.cli.main module

This is the main entry point into 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.main.get_parser()

Creates and returns a parser for the args.

Returns:configured argument parser
Return type:argparse.ArgParser
fitbenchmarking.cli.main.main()

Entry point to be exposed as the fitbenchmarking command.

fitbenchmarking.cli.main.run(problem_sets, options_file='', debug=False)

Run benchmarking for the problems sets and options file given. Opens a webbrowser to the results_index after fitting.

Parameters:
  • problem_sets (list of str) – The paths to directories containing problem_sets
  • options_file (str, optional) – The path to an options file, defaults to ‘’
  • debug (bool) – Enable debugging output