FitBenchmarking 1.4.0__tar.gz → 1.5.0__tar.gz

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FitBenchmarking
-Version: 1.4.0
+Version: 1.5.0
 Summary: FitBenchmarking: A tool for comparing fitting software
 Project-URL: Homepage, https://fitbenchmarking.github.io
 Project-URL: Documentation, https://fitbenchmarking.readthedocs.io/en/stable
@@ -14,7 +14,7 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10.1
-Requires-Dist: codecarbon<2.7,>=2.5.1
+Requires-Dist: codecarbon>=3.2.6
 Requires-Dist: configparser
 Requires-Dist: dash
 Requires-Dist: docutils
@@ -71,10 +71,10 @@ Requires-Dist: sasmodels; extra == 'sas'
 Requires-Dist: tinycc; (platform_system == 'Windows') and extra == 'sas'
 Description-Content-Type: text/markdown
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.4.0)
-[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.4.0)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.5.0)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.5.0)
 [![Install Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/install.yml?label=install&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/install.yml)
-[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.4.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.4.0)
+[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.5.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.5.0)
 [![Coverage Status](https://img.shields.io/coveralls/github/fitbenchmarking/fitbenchmarking.svg?style=flat-square)](https://coveralls.io/github/fitbenchmarking/fitbenchmarking)
 [![Chat](https://img.shields.io/badge/chat-CompareFitMinimizers-lightgrey.svg?style=flat-square&logo=slack)](https://slack.com/)
 [![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.15546207-blue.svg?style=flat-square)](https://zenodo.org/records/15546207)
@@ -83,10 +83,10 @@ Description-Content-Type: text/markdown
 
 FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub.
 
-- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/install_instructions/index.html
-- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/index.html
-- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/contributors/guidelines.html
-- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/tests.html
+- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/install_instructions/index.html
+- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/index.html
+- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/contributors/guidelines.html
+- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/tests.html
 
 The package is the result of a collaboration between STFC’s Scientific Computing Department and ISIS Neutron and Muon Facility and the Diamond Light Source. We also would like to acknowledge support from:
 

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/README.md

@@ -1,7 +1,7 @@
-[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.4.0)
-[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.4.0)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.5.0)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.5.0)
 [![Install Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/install.yml?label=install&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/install.yml)
-[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.4.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.4.0)
+[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.5.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.5.0)
 [![Coverage Status](https://img.shields.io/coveralls/github/fitbenchmarking/fitbenchmarking.svg?style=flat-square)](https://coveralls.io/github/fitbenchmarking/fitbenchmarking)
 [![Chat](https://img.shields.io/badge/chat-CompareFitMinimizers-lightgrey.svg?style=flat-square&logo=slack)](https://slack.com/)
 [![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.15546207-blue.svg?style=flat-square)](https://zenodo.org/records/15546207)
@@ -10,10 +10,10 @@
 
 FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub.
 
-- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/install_instructions/index.html
-- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/index.html
-- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.4.0/contributors/guidelines.html
-- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.4.0/users/tests.html
+- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/install_instructions/index.html
+- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/index.html
+- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.5.0/contributors/guidelines.html
+- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.5.0/users/tests.html
 
 The package is the result of a collaboration between STFC’s Scientific Computing Department and ISIS Neutron and Muon Facility and the Diamond Light Source. We also would like to acknowledge support from:
 

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/controllers/base_controller.py

@@ -17,6 +17,7 @@ from fitbenchmarking.utils.exceptions import (
     MissingBoundsError,
     UnknownMinimizerError,
 )
+from fitbenchmarking.utils.misc import ERROR_FLAG_MAPPINGS
 
 if TYPE_CHECKING:
     from fitbenchmarking.cost_func.base_cost_func import CostFunc
@@ -32,8 +33,6 @@ class Controller:
 
     __metaclass__ = ABCMeta
 
-    VALID_FLAGS = [0, 1, 2, 3, 4, 5, 6, 7, 8]
-
     #: Within the controller class, you must
     #: initialize a dictionary, ``algorithm_check``,
     #: such that the **keys** are given by:
@@ -195,28 +194,23 @@ class Controller:
 
     @property
     def flag(self):
-        """
-        | 0: `Successfully converged`
-        | 1: `Software reported maximum number of iterations exceeded`
-        | 2: `Software run but didn't converge to solution`
-        | 3: `Software raised an exception`
-        | 4: `Solver doesn't support bounded problems`
-        | 5: `Solution doesn't respect parameter bounds`
-        | 6: `Solver has exceeded maximum allowed runtime`
-        | 7: `Validation of the provided options failed`
-        | 8: `Confidence in fit could not be calculated`
-        """
         return self._flag
 
     @flag.setter
     def flag(self, value):
-        if value not in self.VALID_FLAGS:
+        if value not in ERROR_FLAG_MAPPINGS:
             raise ControllerAttributeError(
                 "controller.flag must be one of "
-                f"{list(self.VALID_FLAGS)}. Got: {value}."
+                f"{list(ERROR_FLAG_MAPPINGS.keys())}. Got: {value}."
             )
         self._flag = int(value)
 
+    _flag_docstring = "\n" + "\n".join(
+        f"""\t :{key}: {value}""" for key, value in ERROR_FLAG_MAPPINGS.items()
+    )
+    flag.__doc__ = f"""Valid flags:
+        {_flag_docstring}"""
+
     @property
     def software(self):
         """

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/core/fitting_benchmarking.py

@@ -5,6 +5,7 @@ fitting software.
 """
 
 import os
+import platform
 import timeit
 
 import numpy as np
@@ -71,6 +72,12 @@ class Fit:
         self._emissions_tracker = None
         self._logger_prefix = "    "
         if "energy_usage" in options.table_type:
+            if platform.system() == "Darwin":
+                LOGGER.info(
+                    "Please be aware that you may be prompted by "
+                    "CodeCarbon to provide a password to give sudo rights "
+                    "so that the powermetrics tool can be used."
+                )
             self._emissions_tracker = EmissionsTracker(
                 measure_power_secs=1,
                 tracking_mode="process",
@@ -151,8 +158,8 @@ class Fit:
                 results = self._loop_over_starting_values(problem)
                 self._results.extend(results)
 
-                if self._emissions_tracker:
-                    _ = self._emissions_tracker.stop()
+        if self._emissions_tracker:
+            _ = self._emissions_tracker.stop()
 
         self._checkpointer.finalise_group(
             self._label, self._failed_problems, self._unselected_minimizers
@@ -548,6 +555,7 @@ class Fit:
         num_runs = self._options.num_runs
         energy = np.nan
         tracker = self._emissions_tracker
+        tracker_stopped = False
 
         try:
             with self._grabbed_output:
@@ -559,6 +567,7 @@ class Fit:
                         num_runs, 1
                     )
                     energy = tracker.stop_task().energy_consumed / num_runs
+                    tracker_stopped = True
                 else:
                     runtimes = timeit.Timer(stmt=controller.execute).repeat(
                         num_runs, 1
@@ -630,7 +639,7 @@ class Fit:
         controller.timer.reset()
 
         # ensure emissions tracker has been stopped if energy not set
-        if energy == np.nan and self._emissions_tracker:
+        if self._emissions_tracker and not tracker_stopped:
             _ = self._emissions_tracker.stop_task()
 
         if controller.flag in [3, 6, 7]:

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/core/results_output.py

@@ -30,7 +30,7 @@ from fitbenchmarking.utils import create_dirs
 from fitbenchmarking.utils.exceptions import PlottingError
 from fitbenchmarking.utils.fitbm_result import FittingResult
 from fitbenchmarking.utils.log import get_logger
-from fitbenchmarking.utils.misc import get_css, get_js
+from fitbenchmarking.utils.misc import get_css
 from fitbenchmarking.utils.options import Options
 from fitbenchmarking.utils.write_files import write_file
 
@@ -494,7 +494,6 @@ def create_problem_level_index(
     :params config: Dictionary containing env config
     :type config: dict
     """
-    js = get_js(options, group_dir)
 
     root = os.path.dirname(inspect.getfile(fitbenchmarking))
     template_dir = os.path.join(root, "templates")
@@ -512,7 +511,7 @@ def create_problem_level_index(
             template.render(
                 css_style_sheet=css["main"],
                 custom_style=css["custom"],
-                mathjax=js["mathjax"],
+                mathjax="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js",
                 group_name=group_name,
                 table_type=names,
                 links=links,

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/results_processing/base_table.py

@@ -2,6 +2,7 @@
 Implements the base class for the tables.
 """
 
+import math
 import os
 from abc import ABCMeta, abstractmethod
 
@@ -9,13 +10,13 @@ import docutils.core
 import matplotlib as mpl
 
 from fitbenchmarking.cost_func.cost_func_factory import create_cost_func
+from fitbenchmarking.utils.fitbm_result import FittingResult
 
 mpl.use("Agg")
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
-
-from fitbenchmarking.utils.misc import get_js
+from pandas.io.formats import style
 
 FORMAT_DESCRIPTION = {
     "abs": "Absolute values are displayed in the table.",
@@ -91,8 +92,13 @@ class Table:
         :type table_name: str
         """
         # Flatten to reduce the necessity on having problems as rows.
+
+        # dict[row/problem, dict[column/minimiser, list[FittingResult]]]
         self.results = results
+
+        # dict[row/problem, dict[column/minimiser, FittingResult]]
         self.best_results = best_results
+
         self.options = options
         self.group_dir = group_dir
         self.pp_locations = pp_locations
@@ -226,13 +232,25 @@ class Table:
         """
         str_dict = {}
         for k, results in self.sorted_results.items():
-            _, text_arrs = self.get_colours_for_row(results)
+            _, text_colors = self.get_colours_for_row(results)
             str_dict[k] = [
-                self.get_str_result(r, t, html)
-                for r, t in zip(results, text_arrs)
+                self.get_str_result(result, color, html)
+                for result, color in zip(results, text_colors)
             ]
         return str_dict
 
+    def get_hover_table(self):
+        """
+        Create a dict with the tooltip for each cell from self.sorted_results
+
+        :return: The dictionary of strings for the table
+        :rtype: dict[list[str]]
+        """
+        str_dict = {}
+        for k, results in self.sorted_results.items():
+            str_dict[k] = [self.get_hover_text(result) for result in results]
+        return str_dict.values()
+
     def get_colour_df(self, like_df=None):
         """
         Generate a dataframe of colours to add to the html rendering.
@@ -336,6 +354,35 @@ class Table:
         )
         return val_str
 
+    @staticmethod
+    def get_hover_text(result: FittingResult) -> str:
+        """
+        Generate the tooltip text for a given fitting result.
+        :param result: The result to generate the text for
+        :type result: FittingResult
+
+        :return: The generated tooltip
+        :rtype: str
+        """
+
+        if math.isinf(result.runtime) or math.isinf(result.min_accuracy):
+            return f"Error: {result.status}"
+
+        if result.iteration_count is None or result.iteration_count == 0:
+            iterations = "not available"
+        else:
+            iterations = result.func_evals
+
+        return (
+            f"""Status: {result.status}"""
+            f"""\\a Accuracy: {result.accuracy:.4g}"""
+            f"""\\a {result.runtime_metric.capitalize()}"""
+            f""" runtime: {result.runtime:.4g}"""
+            f"""\\a Energy usage: {result.energy:.4g}"""
+            f"""\\a Iterations: {iterations}"""
+            f"""\\a Function Evaluations: {result.func_evals}"""
+        )
+
     def get_colours_for_row(self, results):
         """
         Get the colours as strings for the given results in the table.
@@ -385,31 +432,48 @@ class Table:
         :rtype: pandas.DataFrame
         """
         str_results = self.get_str_dict(html)
-        # Check all rows incase first row has missing information
+        rows, columns = self.format_results_indicies(str_results)
+
+        results_only = np.array(list(str_results.values()))
+
+        table = pd.DataFrame(results_only, index=rows, columns=columns)
+
+        return table
+
+    def format_results_indicies(self, results: dict[str, list[str]]):
+        """
+        Format rows and columns for the results dable
+
+        :param results: The results to format the indices for
+        :type dict: dict[row/problem, list[result string]]]
+        """
+        problems = list(results.keys())
+
+        problem_index_with_sizes = pd.MultiIndex.from_tuples(
+            zip(problems, self.problem_sizes)
+        )
+
         minimizers_list = []
+        # Check all rows incase first row has missing information
         for row in self.sorted_results.values():
-            for i, r in enumerate(row):
-                formatted = (r.software, r.modified_minimizer_name(False))
+            for i, result in enumerate(row):
+                formatted = (
+                    result.software,
+                    result.modified_minimizer_name(False),
+                )
+
+                # add the minimiser the first time it is seen
                 if len(minimizers_list) == i:
                     minimizers_list.append(formatted)
+                # if a longer minimiser name is seen under the same software,
+                # update the tuple to use that minimiser instead
+                # this ensures column width is wide enough for all minimisers
                 elif len(minimizers_list[i][1]) < len(formatted[1]):
                     minimizers_list[i] = formatted
 
         multi_columns = pd.MultiIndex.from_tuples(minimizers_list)
 
-        single_index = list(str_results.keys())
-
-        multi_index = pd.MultiIndex.from_tuples(
-            zip(single_index, self.problem_sizes)
-        )
-
-        results_only = np.array(list(str_results.values()))
-
-        table = pd.DataFrame(
-            results_only, index=multi_index, columns=multi_columns
-        )
-
-        return table
+        return problem_index_with_sizes, multi_columns
 
     def to_html(self):
         """
@@ -489,15 +553,21 @@ class Table:
         multi_index = pd.MultiIndex.from_tuples(double_index)
         table.index = multi_index
 
-        # Get columns where cost function changes
-        column_dividers = [table.columns[0]]
-        for column in table.columns[1:]:
+        style = self.style_df_for_html(multi_index, columns, table.style)
+
+        return style.to_html(table_uuid="table")
+
+    def style_df_for_html(
+        self, index, columns, styler: style.Styler
+    ) -> style.Styler:
+        column_dividers = [styler.columns[0]]
+        for column in styler.columns[1:]:
             if column[0] != column_dividers[-1][0]:
                 column_dividers.append(column)
         column_dividers = column_dividers[1:]
 
         # Set the cell colours and increase bars between cost functions
-        table_style = table.style.apply(
+        styler = styler.apply(
             lambda df: self.get_colour_df(like_df=df), axis=None
         ).set_table_styles(
             table_styles={
@@ -515,7 +585,26 @@ class Table:
             }
         )
 
-        return table_style.to_html(table_uuid="table")
+        hover_table = pd.DataFrame(
+            list(self.get_hover_table()),
+            index=index,
+            columns=columns,
+        )
+
+        styler = styler.set_tooltips(
+            ttips=hover_table,
+            props="white-space: pre;"
+            "visibility: hidden;"
+            "position: absolute; z-index: 1;"
+            "border: 1px solid #8c8b8b;"
+            "background-color: white;"
+            "color: black; font-size: 0.8em;"
+            "transform: translate(2em, -0.6em); padding: 0.6em;"
+            "border-radius: 0em;"
+            "pointer-events: none;",
+        )
+
+        return styler
 
     def to_csv_file(self):
         """
@@ -552,8 +641,9 @@ class Table:
                         " a problem ``rel = abs / 1e-10``."
                     )
             descrip = descrip.replace(":ref:", "")
-            js = get_js(self.options, self.group_dir)
-            docsettings = {"math_output": "MathJax " + js["mathjax"]}
+            docsettings = {
+                "math_output": "MathJax https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js"
+            }
             description_page = docutils.core.publish_parts(
                 descrip, writer_name="html", settings_overrides=docsettings
             )
@@ -832,7 +922,7 @@ class Table:
             "runtime_dropdown", "Select Runtime Metric", items
         )
 
-    def get_runtime_value_str(self, result):
+    def get_runtime_value_str(self, result: FittingResult) -> str:
         """
         Generates the value str for the compare and runtime tables.
 
@@ -843,6 +933,7 @@ class Table:
                  metrics.
         :rtype: str
         """
+        error = result.error_flag if result.error_flag != 0 else ""
         val_str = ""
         for rt in self.runtime_choices:
             formated_runtime = f"{getattr(result, rt + '_runtime'):.4g}"
@@ -851,7 +942,9 @@ class Table:
             val_str += (
                 f"<span class='runtime' id='{rt}' "
                 f"style='display:{display_style}'>"
-                f"{formated_runtime} ({formatted_norm_runtime})</span>"
+                f"{formated_runtime} ({formatted_norm_runtime})"
+                f"<sup>{error}</sup>"
+                f"</span>"
             )
         return val_str
 

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/results_processing/compare_table.py

@@ -3,6 +3,7 @@ compare table
 """
 
 from fitbenchmarking.results_processing.base_table import Table
+from fitbenchmarking.utils.fitbm_result import FittingResult
 
 
 class CompareTable(Table):
@@ -150,7 +151,7 @@ class CompareTable(Table):
         foreground_text = zip(acc_text, runtime_text)
         return background_col, foreground_text
 
-    def get_hyperlink(self, result, val_str, text_col):
+    def get_hyperlink(self, result: FittingResult, val_str, text_col):
         """
         Generates the hyperlink for a given result
 

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/results_processing/energy_usage_table.py

@@ -15,7 +15,11 @@ class EnergyUsageTable(Table):
 
     For more information on how energy usage is measured,
     see the Methodology section of the `codecarbon docs
-    <https://mlco2.github.io/codecarbon/methodology.html#cpu>`_.
+    <https://docs.codecarbon.io/latest/explanation/methodology/>`_.
+
+    Please be aware that if you are running on a Mac, then you may
+    be prompted to provide a password to give sudo rights (so that
+    the powermetrics tool can be used).
 
     """
 

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/results_processing/plots.py

@@ -13,7 +13,6 @@ import plotly.graph_objects as go
 from plotly.subplots import make_subplots
 
 from fitbenchmarking.utils.exceptions import PlottingError
-from fitbenchmarking.utils.misc import get_js
 
 
 class Plot:
@@ -87,9 +86,8 @@ class Plot:
         :param options: The options for the run
         :type options: utils.options.Options
         """
-        plotly_path = get_js(options, figures_dir).get("plotly")
         html_file_name = Path(figures_dir) / htmlfile
-        fig.write_html(html_file_name, include_plotlyjs=plotly_path)
+        fig.write_html(html_file_name, include_plotlyjs="cdn")
 
     @staticmethod
     def best_filename(result) -> str:
@@ -192,7 +190,7 @@ class Plot:
                 title=self.result.name, legend=self._legend_style
             )
             self._update_to_logscale_if_needed(fig, self.result)
-
+            self._add_menu_buttons(fig)
             htmlfile = (
                 f"{minimizer}_fit_for_{self.result.costfun_tag}"
                 f"_{self.result.sanitised_name}.html"
@@ -985,6 +983,40 @@ class Plot:
             fig.update_yaxes(type="log")
         return fig
 
+    @staticmethod
+    def _add_menu_buttons(fig) -> go.Figure:
+        """
+        Adds an interactible button to the plot, to toggle error bars
+
+        :param fig: The plotly figure to update the axis for
+        :type fig: plotly.graph_objects.Figure
+
+        :return: Updated plot
+        :rtype: plotly.graph_objects.Figure
+        """
+        fig.update_layout(
+            updatemenus=[
+                {
+                    "type": "buttons",
+                    "direction": "down",
+                    "showactive": False,
+                    "x": 1.25,
+                    "y": 1.15,
+                    "xanchor": "right",
+                    "yanchor": "top",
+                    "buttons": [
+                        {
+                            "label": "Toggle error bars",
+                            "method": "restyle",
+                            "args": [{"error_y.visible": [True]}, [0]],
+                            "args2": [{"error_y.visible": [False]}, [0]],
+                        }
+                    ],
+                }
+            ]
+        )
+        return fig
+
     @staticmethod
     def _sample_colours(points: np.ndarray) -> list[str]:
         """

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/results_processing/tables.py

@@ -15,22 +15,10 @@ from fitbenchmarking.utils.exceptions import (
     UnknownTableError,
 )
 from fitbenchmarking.utils.log import get_logger
-from fitbenchmarking.utils.misc import get_css, get_js
+from fitbenchmarking.utils.misc import ERROR_FLAG_MAPPINGS, get_css, get_js
 
 LOGGER = get_logger()
 
-ERROR_OPTIONS = {
-    0: "Successfully converged",
-    1: "Software reported maximum number of iterations exceeded",
-    2: "Software run but didn't converge to solution",
-    3: "Software raised an exception",
-    4: "Solver doesn't support bounded problems",
-    5: "Solution doesn't respect parameter bounds",
-    6: "Solver has exceeded maximum allowed runtime",
-    7: "Validation of the provided options failed",
-    8: "Confidence in fit could not be calculated",
-}
-
 SORTED_TABLE_NAMES = ["compare", "acc", "runtime", "local_min", "energy_usage"]
 
 
@@ -133,7 +121,7 @@ def create_results_tables(
                         dropdown_style=css["dropdown"],
                         table_style=css["table"],
                         dropdown_js=js["dropdown"],
-                        mathjax=js["mathjax"],
+                        mathjax="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js",
                         table_js=js["table"],
                         table=html["table"],
                         problem_dropdown=html["problem_dropdown"],
@@ -157,7 +145,7 @@ def create_results_tables(
                         ),
                         cbar=cbar,
                         run_name=run_name,
-                        error_message=ERROR_OPTIONS,
+                        error_message=ERROR_FLAG_MAPPINGS,
                         failed_problems=failed_problems,
                         unselected_minimzers=unselected_minimzers,
                         algorithm_type=options.algorithm_type,

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/templates/problem_index_page.html

@@ -4,8 +4,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="stylesheet" type="text/css" href="{{ css_style_sheet }}" />
     <link rel="stylesheet" type="text/css" href="{{ custom_style }}" />
-    <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
-    <script id="MathJax-script" async src="{{ mathjax }}"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js" defer></script>
 
     <head>
         <title>{{ run_name }}{{ group_name }} results</title>

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/templates/table_template.html

@@ -6,10 +6,9 @@
     <link rel="stylesheet" type="text/css" href="{{ custom_style }}" />
     <link rel="stylesheet" type="text/css" href="{{ dropdown_style }}" />
     <link rel="stylesheet" type="text/css" href="{{ table_style }}" />
-    <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
     <script type="text/javascript" src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
     <script type="text/javascript" src="{{ dropdown_js }}"></script>
-    <script id="MathJax-script" async src="{{ mathjax }}"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js" defer></script>
     <script type="text/javascript" src="{{ table_js }}"></script>
     <script>        
         // When the table page loads, read the selected runtime metric

{fitbenchmarking-1.4.0 → fitbenchmarking-1.5.0}/fitbenchmarking/utils/checkpoint.py

@@ -124,6 +124,7 @@ class Checkpoint:
             "J": _compress(result.jac_x),
             "fin_y": _compress(result.fin_y),
             "tags": result.algorithm_type,
+            "status": result.status,
         }
 
         with open(self.results_file, "a", encoding="utf-8") as f:
@@ -348,6 +349,7 @@ class Checkpoint:
                 new_result.r_x = _decompress(r["r"])
                 new_result.jac_x = _decompress(r["J"])
                 new_result.algorithm_type = r["tags"]
+                new_result.status = r.get("status", "unknown")
 
                 new_result.name = r["name"]
                 p = problems[new_result.name]