Changeset e081946 in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Sep 15, 2017 11:40:46 AM (7 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ca383a0

Parents:

c56d9d74

Message:

Minor rst formatting fixes

Location:

src/sas/sasgui/perspectives/fitting/media

Files:

• fitting_help.rst (modified) (4 diffs)
• plugin.rst (modified) (1 diff)

src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

@@ -214 +214 @@
                      ['radius_effective', '', 1, [-numpy.inf, numpy.inf], 'volume', ''],
                      ['volfraction', '', 1, [-numpy.inf, numpy.inf], '', ''],
+                     [...],
 
 and to the declarations of the functions Iq and Iqxy:::
@@ -242 +243 @@
 them. Finally, click the *Apply* button to generate and test the model and then click *Close*.
 
-Any changes to a plugin model generated in this way only become effective *after* it is re-selected from the plugin models drop-down menu on the FitPage. If the model is not listed you can force a 
+Any changes to a plugin model generated in this way only become effective *after* it is re-selected 
+from the plugin models drop-down menu on the FitPage. If the model is not listed you can force a 
 recompilation of the plugins by selecting *Fitting* > *Plugin Model Operations* > *Load Plugin Models*.
 
@@ -253 +255 @@
      
      model_info = load_model_info('sphere+power_law')
-     model_info.name = 'My Plugin Model'
+     model_info.name = 'MyPluginModel'
      model_info.description = 'sphere + power_law'
      Model = make_model_from_info(model_info)
@@ -261 +263 @@
 and description too!!!
 
-The model specification string can handle multiple models and combinations of operators (+ - * /) which 
+The model specification string can handle multiple models and combinations of operators (+ - * \\) which 
 are processed according to normal conventions. Thus 'model1+model2*model3' would be valid and would 
 multiply model2 by model3 before adding model1. In this example, parameters in the *FitPage* would be 
-prefixed A_\ (for model2), B_\ (for model3) and C_\ (for model1). Whilst this might appear a little 
-confusing, unless you were creating a plugin model from multiple instances of the same model the parameter assignments ought to be obvious when you load the plugin.
-
+prefixed A (for model2), B (for model3) and C (for model1). Whilst this might appear a little 
+confusing, unless you were creating a plugin model from multiple instances of the same model the parameter 
+assignments ought to be obvious when you load the plugin.
+
+If you need to include another plugin model in the model specification string, just prefix the name of 
+that model with *custom*. For instance::
+
+     sphere+custom.MyPluginModel
+
+To create a P(Q)*\S(Q) model use the @ symbol instead of * like this::
+
+     sphere@hardsphere
+     
 This streamlined approach to building complex plugin models from existing library models, or models 
 available on the *Model Marketplace*, also permits the creation of P(Q)*\S(Q) plugin models, something 

src/sas/sasgui/perspectives/fitting/media/plugin.rst

@@ -20 +20 @@
 
 **What follows below is quite technical. If you just want a helping hand to get 
-started creating your own models see :ref:`Adding_your_own_models`.**
+started creating your own models see** :ref:`Adding_your_own_models`.
 
 Overview