fitbenchmarking.utils.create_dirs module

Utility functions for creating/deleting directories.

fitbenchmarking.utils.create_dirs.css(results_dir)

Creates a local css directory inside the results directory.

Parameters

support_pages_dir (str) – path to the results directory

Returns

path to the local css directory

Return type

str

fitbenchmarking.utils.create_dirs.del_contents_of_dir(directory)

Delete contents of a directory, including other directories.

Parameters

directory (str) – the target directory

fitbenchmarking.utils.create_dirs.figures(support_pages_dir)

Creates the figures directory inside the support_pages directory.

Parameters

support_pages_dir (str) – path to the support pages directory

Returns

path to the figures directory

Return type

str

fitbenchmarking.utils.create_dirs.group_results(results_dir, group_name)

Creates the results directory for a specific group. e.g. fitbenchmarking/results/Neutron/

Parameters
  • results_dir (str) – path to directory that holds all the results

  • group_name (str) – name of the problem group

Returns

path to folder group specific results dir

Return type

str

fitbenchmarking.utils.create_dirs.results(results_dir)

Creates the results folder in the working directory.

Parameters

results_dir (str) – path to the results directory, results dir name

Returns

proper path to the results directory

Return type

str

fitbenchmarking.utils.create_dirs.support_pages(group_results_dir)

Creates the support_pages directory in the group results directory.

Parameters

group_results_dir (str) – path to the group results directory

Returns

path to the figures directory

Return type

str