doc: fitting and contraints with GUI

lavakyan · Feb 11, 2020 · fc110cc · fc110cc
1 parent 1e2d063
commit fc110cc
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 1 deletion.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
+release = '1.0.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc/source/gui/gui_contraints_coreshell.png b/doc/source/gui/gui_contraints_coreshell.png
diff --git a/doc/source/gui/gui_contraints_empty.png b/doc/source/gui/gui_contraints_empty.png
diff --git a/doc/source/gui/gui_fit.png b/doc/source/gui/gui_fit.png
diff --git a/doc/source/gui/gui_fitting.rst b/doc/source/gui/gui_fitting.rst
@@ -0,0 +1,36 @@
+.. _gui_fitting:
+
+Fitting and constraints
+-----------------------
+
+.. image:: interface_fitting.png
+
+
+Open file -- select file with column-formatted data to fit
+
+Plot button -- visualize data and compare it with theory
+
+
+
+
+Play button -- start fitting
+
+Stop button -- interrupt fitting
+
+ChiSq -- shows the obtained fitting quality parameter :math:`\chi^2` (see :class:mstm_studio.mstm_spectrum.SPR).
+
+.. image:: gui_fit.png
+
+Constraints button -- open new window with constraints options
+
+Empty constraints window:
+
+.. image:: gui_contraints_empty.png
+
+
+Example of possible constraints for core-shell nanoparticle:
+
+.. image:: gui_contraints_coreshell.png
+
+For details consult :ref:`Constraints`
+
diff --git a/doc/source/scripting/fitting.rst b/doc/source/scripting/fitting.rst
@@ -60,6 +60,9 @@ Fitter class
 .. autoclass:: mstm_studio.fit_spheres_optic.Fitter
     :members:
 
+
+.. _constraints:
+
 Constraints
 -----------