Devel

.gitignore

@@ -7,3 +7,4 @@ __pycache__
 *.log
 tmp
 build
+.coverage

doc/source/api/lsqfitgui.rst

@@ -24,3 +24,25 @@ API: lsqfitgui
 
 .. autoclass:: FitGUI
     :members:
+
+
+
+``BodyTemplate``
+------------------
+
+.. autoclass:: BodyTemplate
+    :members:
+
+
+``DefaultBodyTemplate``
+-----------------------
+
+.. autoclass:: DefaultBodyTemplate
+    :members:
+
+
+``DEFAULT_PLOTS``
+-----------------------
+
+.. autodata:: lsqfitgui.frontend.content.DEFAULT_PLOTS
+    :no-value:

doc/source/customization.md

@@ -0,0 +1,31 @@
+# Customization
+
+The content of the dashboard created by `lsqfitgui` is generated by the {class}`lsqfitgui.DefaultBodyTemplate` class.
+To update this content, you have to
+1. create a new class which inherits from the default template (or from the base {class}`lsqfitgui.BodyTemplate` class if you want to start from scratch),
+2. overload the {func}`lsqfitgui.DefaultBodyTemplate.get_content` method, and
+3. pass it to the GUI on instantiation.
+
+For example, the following code appends additional text to the dashboard
+
+```python
+from dash import html
+from lsqfit import nonlinear_fit
+from lsqfitgui import FitGUI, DefaultBodyTemplate
+
+class MyBodyTemplate(DefaultBodyTemplate):
+
+    def get_content(self, fit: nonlinear_fit, meta: Optional[Dict]=None) -> List[html.Base]:
+        """Add additional content to the default content."""
+        content = super().get_content(fit, meta=meta)
+        content.append(html.P("Hello world!"))
+        return content
+
+fit = nonlinear_fit(...)
+
+fit_gui = FitGUI(fit, template_cls=MyBodyTemplate)
+fit_gui.run_server()
+```
+
+The `fit` object represents the current fit (after updating the prior or meta information) and the `meta` values (if applicable).
+The content is a list of [`dash.html` components](https://dash.plotly.com/dash-html-components), which can be regular text content or figures.

doc/source/index.rst

@@ -12,6 +12,7 @@ lsqfitgui documentation
 
    quickstart
    examples
+   customization
    api/lsqfitgui
 
 

example/entrypoint.py

@@ -5,34 +5,43 @@
 
 from dash import html
 
-from lsqfitgui import run_server
-
-
-def get_additional_content(fit):
-    """Generate aditional dash html elements based on a fit object."""
-    return html.Div(
-        [
-            html.H2("Comparison against initial synthetic data values"),
-            html.P("Synthetic"),
-            html.Pre(str(A0)),
-            html.P("Posterior"),
-            html.Pre(str(fit.p)),
-        ]
-    )
+from lsqfitgui import FitGUI, DefaultBodyTemplate
+
+
+class MyBodyTemplate(DefaultBodyTemplate):
+    # Bootstrap columns: https://getbootstrap.com/docs/5.0/layout/grid/#grid-options
+    sidebar_div_class = "col-xs-12 col-sm-6 col-md-6 col-xl-5 col-xxl-4"
+    content_div_class = "col-xs-12 col-sm-6 col-md-6 col-xl-7 col-xxl-8"
+
+    def get_content(self, fit, meta=None):
+        """Add additional content to the default content."""
+        content = super().get_content(fit, meta=meta)
+        content.append(
+            html.Div(
+                [
+                    html.H2("Comparison against initial synthetic data values"),
+                    html.P("Synthetic"),
+                    html.Pre(str(A0)),
+                    html.P("Posterior"),
+                    html.Pre(str(fit.p)),
+                ]
+            )
+        )
+        return content
 
 
 def main():
     """Start the GUI for the fit."""
-    run_server(
-        name="Poly fit",
+    fit_gui = FitGUI(
         fit_setup_function=generate_fit,
         fit_setup_kwargs={"n_poly": 4},
         meta_config=[
             {"name": "n_poly", "type": "number", "min": 1, "max": 10, "step": 1}
         ],
-        use_default_content=True,
-        get_additional_content=get_additional_content,
+        template_cls=MyBodyTemplate,
     )
+    fit_gui.name = "Poly fit"
+    fit_gui.run_server()
 
 
 if __name__ == "__main__":

lsqfitgui/__init__.py

@@ -7,6 +7,20 @@
 """  # noqa: E501
 from lsqfitgui.lsqfitgui import FitGUI, run_server  # noqa
 from lsqfitgui.plot.uncertainty import wrap_plot_gvar, plot_gvar  # noqa
+from lsqfitgui.frontend.body import (  # noqa
+    BodyTemplate,
+    DefaultBodyTemplate,
+    DEFAULT_PLOTS,
+)
 from lsqfitgui.version import __version__  # noqa
 
-__all__ = ["FitGUI", "run_server", "wrap_plot_gvar", "plot_gvar", "__version__"]
+__all__ = [
+    "FitGUI",
+    "run_server",
+    "wrap_plot_gvar",
+    "plot_gvar",
+    "BodyTemplate",
+    "DefaultBodyTemplate",
+    "DEFAULT_PLOTS",
+    "__version__",
+]

lsqfitgui/_version.txt

@@ -1 +1 @@
-0.1.0
+0.2.0

lsqfitgui/backend/__init__.py

@@ -0,0 +1,5 @@
+"""Access to backend functions."""
+
+from lsqfitgui.backend.sidebar import process_priors, process_meta  # noqa
+
+__all__ = ["process_priors", "process_meta"]

lsqfitgui/backend/sidebar.py

@@ -1,4 +1,6 @@
 """Functions for parsing sidebar form values into python objects."""
+from typing import Dict, List, Any, Optional
+
 import re
 import gvar as gv
 from lsqfit import nonlinear_fit
@@ -33,6 +35,25 @@ def process_priors(prior_flat, initial_fit):
     return fit
 
 
-def process_meta(meta_array, meta_config):
+def process_meta(
+    meta_array: Optional[List[Any]], meta_config: Optional[List[Dict[str, Any]]]
+) -> Dict[str, Any]:
     """Parse meta form input into dictionary shape using meta config name values."""
-    return {config["name"]: val for config, val in zip(meta_config, meta_array)}
+    # for python 3.10+ this will be zip(*, strict=False)
+    if not meta_array and not meta_config:
+        return {}
+    elif meta_array and not meta_config:
+        raise TypeError(
+            "Improperly configured. Received meta config values but no meta config."
+        )
+    elif meta_config and not meta_array:
+        raise TypeError("Improperly configured. Received meta configs but no values.")
+    else:
+        assert isinstance(meta_config, list)
+        assert isinstance(meta_array, list)
+        if len(meta_config) != len(meta_array):
+            raise ValueError(
+                "Improperly configured."
+                " Meta config options does not have the same number of values recieved."
+            )
+        return {config["name"]: val for config, val in zip(meta_config, meta_array)}