source: sasview/fittingview/src/sans/perspectives/fitting/media/model_editor_help.html @ d40038e

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since d40038e was 83e0aa1, checked in by Jae Cho <jhjcho@…>, 13 years ago

Added model editor help doc

  • Property mode set to 100644
File size: 1.8 KB
Line 
1<html>
2<body>
3<h4>Edit Custom Model</h4>
4<ul>
5<li><a href="#description">Description</a></li>
6<li><a href="#new">New</a></li>
7<li><a href="#sum">Sum(p1,p2)</a></li>
8<li><a href="#advanced">Advanced</a></li>
9<li><a href="#delete">Delete</a></li>
10
11</ul>
12<h5><a name="description">Description</a></h5>
13<p>
14This menu (Fitting/Edit Custom Model in the menu bar) interface is to provide you an easy way to write your own custom models.
15The changes in a model function are effective after it is re-selected from the combo-box menu.
16</p>
17<br/>
18<img src="edit_model_menu.bmp"/>
19<br/>
20<br/>
21<h5><a name="new">New</a></h5>
22<p>
23This option is used to make a new model.
24A model code generated by this option can be viewed and further modified by the 'Advanced' option below.
25</p>
26<br/>
27<img src="new_model.bmp"/>
28<br/>
29<br/>
30<h5><a name="sum">Sum(p1,p2)</a></h5>
31<p>
32This option is used to change the p1 or p2 model in the sum model (Note: Not all models are currently supported).
33Select the model names in the combo box. The model name will be "UpperCaseOnly(p1_name)+UpperCaseOnly(p2_name)".
34It will overwrite the previous the sum model.
35If you need to keep the older sum model, use the 'Advanced' option to edit and save as a different file name(.py).
36</p>
37<br/>
38<img src="sum_model.bmp"/>
39<br/>
40<br/>
41<h5><a name="advanced">Advanced</a></h5>
42<p>
43The menu option shows all the files in the plugin_models folder.
44You can edit, modify, and save it.
45It is recommended to modify only the lines with arrow (## &#60-----).
46In the end of edit, 'Compile' and 'Run' from the menu bar to activate or to see the model working properly.
47</p>
48
49
50<h5><a name="delete">Delete</a></h5>
51<p>
52The menu option is to delete the custom models. Just select the file name to delete.
53</p>
54
55</body>
56
57</html>
Note: See TracBrowser for help on using the repository browser.