Merge fb285c0 into e5f2e20

fitbenchmarking · Nov 15, 2019 · 7525d3f · 7525d3f
2 parents e5f2e20 + fb285c0
commit 7525d3f
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 3 deletions.
diff --git a/docs/source/users/index.rst b/docs/source/users/index.rst
@@ -10,4 +10,5 @@ Welcome to the documentation for the FitBenchmarking software.
     getting_started
     examples
     options
+    notes
 
diff --git a/docs/source/users/notes.rst b/docs/source/users/notes.rst
@@ -0,0 +1,60 @@
+.. _notes:
+
+#####
+Notes
+#####
+
+This document is used to detail any known issues or unexpected behaviour
+within the software.
+
+
+************************************
+Problem-Format/Software Combinations
+************************************
+
+Some of the pairings of problem types and software exhibit behavour which may
+be unexpected.
+These are listed in the below table.
+
+.. list-table::
+   :widths: 1 1 3 1 3 1
+   :stub-columns: 1
+   :header-rows: 1
+
+   * - Problem Types \\ Fitting Software
+     - DFOGN
+     - Mantid
+     - RALFit
+     - SASView
+     - Scipy
+   * - Fitbenchmark
+     - None
+     - | This is expected to have a smaller
+       | overhead on evaluating functions,
+       | and so may be faster when compared
+       | to other softwares.
+     - None
+     - | This is known to display a large
+       | amount of exceptions relating to
+       | setting values to inf.
+     - None
+   * - SASView
+     - None
+     - None
+     - None
+     - None
+     - None
+   * - NIST
+     - None
+     - None
+     - None
+     - None
+     - None
+
+The stopping criterion of each minimizer is set to the default value. An experienced user can change this.
+
+**************************
+SASView Problem Definition
+**************************
+Due to the physical expectation for problems in the SASView data format, all
+data with an x value of 0 will be removed from the dataset before fitting.
diff --git a/docs/source/users/options.rst b/docs/source/users/options.rst
@@ -18,7 +18,8 @@ These include:
 The software to use in fitting as a string or list of strings.
 Selected softwares will be benchmarked.
 
-Available options are ``"mantid"``, ``"sasview"``, ``"scipy"`` and ``"dfogn"``.
+Available options are ``"dfogn"``, ``"mantid"``, ``""ralfit""``, ``"sasview"``,
+and ``"scipy"``.
 
 ``results_dir``
 ---------------
@@ -30,7 +31,7 @@ If ``None``, a results directory will be created at ``./results``.
 Bool to select whether to use errors in the fitting process or not.
 
 ``color_scale``
---------------
+---------------
 The mapping from relative value to colour in the results table.
 
 This should be in the form of a list of 2-tuples,
@@ -126,13 +127,15 @@ Scipy:
 
 DFO-GN:
   - ``"dfogn"``
+
   Information about this can be found on the
   `DFO-GN documentation
   <http://people.maths.ox.ac.uk/robertsl/dfogn/>`__
 
 
 RALfit:
   - ``"ralfit"``
+
   Information about this can be found on the
   `RALfit documentation
   <https://github.com/ralna/RALFit>`__
@@ -164,6 +167,7 @@ Available options are ``"abs"``, ``"rel"``, or ``"both"``.
 ``num_runs``
 -------------------
 
-Number of runs is defines how many times FitBenchmarking calls a minimizer and thus calculates an average elapsed time using ``timeit``.
+Number of runs defines how many times FitBenchmarking calls a minimizer and
+calculates an average elapsed time using ``timeit``.
 
 Default set as ``5``.