Changeset afb93df in sasview for src/sas/sasgui


Ignore:
Timestamp:
Oct 10, 2016 12:08:58 PM (8 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.1.1, release-4.1.2, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
b61bd57
Parents:
fd62331
Message:

Update fitting_help.rst with changes to Fitting > Edit Custom Model

Location:
src/sas/sasgui/perspectives
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/perspectives/calculator/media/python_shell_help.rst

    r8a63137 rafb93df  
    55.. Text revised during Code Camp V in Oct 2016. 
    66 
    7 Python ShellEditor Tool 
    8 ======================= 
     7.. _Python_shell: 
     8 
     9Python Shell-Editor Tool 
     10======================== 
    911 
    1012Description  
  • src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

    r82b0b05e rafb93df  
    145145and then one of the options 
    146146 
    147 *  *New* - to create a new custom model template 
    148 *  *Sum|Multi(p1,p2)* - to create a new model by summing/multiplying existing models in the model library 
    149 *  *Advanced* - to edit a new custom model 
     147*  *New* - to create a custom model template with a help dialog 
     148*  *Sum|Multi(p1,p2)* - to create a custom model by summing/multiplying *existing models* in the model library 
     149*  *Advanced* - to create/edit a custom model in a Python shell 
    150150*  *Delete* - to delete a custom model 
     151*  *Load* - to (re-)load custom models 
    151152 
    152153New 
     
    184185^^^^^^^^ 
    185186 
    186 Selecting this option shows all the custom models in the plugin model folder 
    187  
    188   *C:\\Users\\[username]\\.sasview\\plugin_models* - (on Windows) 
     187Selecting this option shows all the custom models in the plugin model folder, on Windows this is 
     188 
     189  *C:\\Users\\{username}\\.sasview\\plugin_models* 
    189190 
    190191You can edit, modify, and save the Python code in any of these models using the 
    191 *Advanced Custom Model Editor*. 
    192  
    193 See :ref:`Writing_a_Plugin` for details on the plugin format. 
    194  
    195 *NB: Sum/Product models are still using the SasView 3.x model format.  Unless 
    196 you are confident about what you are doing, it is recommended that you 
    197 only modify lines denoted with the ## <----- comments!* 
    198  
    199 When editing is complete, select *Run -> Compile* from the *Model Editor* menu bar. An 
    200 *Info* box will appear with the results of the compilation and model unit tests. The 
    201 model will only be usable if the tests 'pass'. 
     192*Advanced Custom Model Editor*. Note that this is actually the same tool as the :ref:`Python_shell` . 
     193 
     194For details of the SasView plugin model format see :ref:`Writing_a_Plugin` . 
     195 
     196.. note:: Model files generated with the Sum/Multi option are still using the SasView 3.x model format. Unless you are confident about what you are doing, it is recommended that you only modify lines denoted with the ## <----- comments! 
     197 
     198When editing is complete, select *Run* > *Check Model* from the *Advanced Custom Model Editor* menu bar. An *Info* box will appear with the results of the compilation and model unit tests. The model will only be usable if the tests 'pass'. 
    202199 
    203200To use the model, go to the relevant *Fit Page*, select the *Customized Models* 
    204201category and then select the model from the drop-down menu. 
    205202 
    206 *NB: Any changes to a custom model generated in this way only become effective after* 
    207 *it is re-selected from the model drop-down menu on the Fit Page.* 
     203Any changes to a custom model generated in this way only become effective *after* it is re-selected from the model drop-down menu on the FitPage. 
    208204 
    209205Delete 
     
    213209 
    214210*NB: Custom models shipped with SasView cannot be removed in this way.* 
     211 
     212Load 
     213^^^^ 
     214 
     215This option loads (or re-loads) all models present in the plugin model folder. 
    215216 
    216217.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
Note: See TracChangeset for help on using the changeset viewer.