Changeset 3d164b9 in sasview


Ignore:
Timestamp:
Sep 21, 2016 11:53:55 AM (5 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, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
6e0c7b2
Parents:
7d94915
Message:

Under review - minor changes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/perspectives/fitting/media/plugin.rst

    r05829fb r3d164b9  
    3232`model marketplace <http://marketplace.sasview.org/>`_. 
    3333 
    34 The builtin modules are available in the *sasmodels-data/models* subdirectory 
    35 of the sasview distribution.  On Windows, this will be something like 
    36 *C:\Program Files (x86)\SasView\models*.  On MacOSX, these will be within 
     34The built-in modules are available in the *sasmodels-data\\models* subdirectory 
     35of the sasview installation folder.  On Windows, this will be something like 
     36*C:\\Program Files (x86)\\SasView\\sasmodels-data.  On MacOSX, these will be within 
    3737the application bundle as 
    3838*/Applications/SasView 4.0.app/Contents/Resources/sasmodels-data/models*. 
     
    4141^^^^^^^^^^^^^^^^^^^^^^ 
    4242 
    43 In the *~/.sasview/plugin_models* directory, copy the appropriate files 
     43In the *~\\.sasview\\plugin_models* directory, copy the appropriate files 
    4444(using the examples above as templates) to mymodel.py (and mymodel.c, etc) 
    4545as required, where "mymodel" is the name for the model you are creating. 
     
    4848 
    4949- No capitalization and thus no CamelCase. 
    50 - If necessary use underscore to separate (i.e. barbell not BarBell or 
     50- If necessary use underscore to separate words (i.e. barbell not BarBell or 
    5151  broad_peak not BroadPeak) 
    52 - Don't include “model” in the name (i.e. barbell not BarBellModel) 
     52- Do not include “model” in the name (i.e. barbell not BarBellModel) 
    5353 
    5454 
     
    8585   - this is ReStructuredText enclosed between the r""" and """ delimiters 
    8686     at the top of the *.py* file 
     87   - what you write here is abstracted into the help documentation 
    8788 
    8889- a **definition** of the model: 
     
    107108   - the *.py* file should also contain a comment identifying *who* 
    108109     converted/created the model file 
     110 
     111Models that do not conform to these requirements will *never* be incorporated  
     112into the built-in library. 
    109113 
    110114More complete documentation for the sasmodels package can be found at 
Note: See TracChangeset for help on using the changeset viewer.