Changeset 907186d in sasview

Timestamp:

Oct 26, 2016 9:12:33 AM (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:

20cfa23

Parents:

af6de50

Message:

Reviewed new text by PaulK. Minor corrections.

File:

• src/sas/sasgui/perspectives/fitting/media/plugin.rst (modified) (7 diffs)

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

@@ -27 +27 @@
 
 the next time SasView is started it will compile the plugin and add
-it to the list of *Plugin Models* in a FitPage.
+it to the list of *Customized Models* in a FitPage.
 
 SasView models can be of three types:
@@ -61 +61 @@
 - If necessary use underscore to separate words (i.e. barbell not BarBell or
   broad_peak not BroadPeak)
-- Do not include “modelâ€ￜ in the name (i.e. barbell not BarBellModel)
+- Do not include "model" in the name (i.e. barbell not BarBellModel)
 
 
@@ -486 +486 @@
 and it includes orientation parameters.
 
-*form_volume* defines the volume of the shape. As in python models,
+*form_volume* defines the volume of the shape. As in python models, it 
 includes only the volume parameters.
 
@@ -673 +673 @@
 particular problems:
 
-  (1) Code is too complex, or uses too much memory.  GPU devices only have a
+  **(1) Code is too complex, or uses too much memory.**  GPU devices only have a
   limited amount of memory available for each processor.  If you run programs
   which take too much memory, then rather than running multiple values in parallel
@@ -680 +680 @@
   some platforms, or worse, cause the screen to go blank or the system to reboot.
 
-  (2) Code takes too long.  Because GPU devices are used for the computer
+  **(2) Code takes too long.**  Because GPU devices are used for the computer
   display, the OpenCL drivers are very careful about the amount of time they
   will allow any code to run.  For example, on OS X, the model will stop running
-  after 5 seconds regardless if the computation is complete.  You may end up
-  with only some of your 2-D array defined, with the rest containing random
+  after 5 seconds regardless of whether the computation is complete.  You may end up
+  with only some of your 2D array defined, with the rest containing random
   data. Or it may cause the screen to go blank or the system to reboot.
 
-  (3) Memory is not *aligned*.  The GPU hardware is specialized to operate on
-  multiple values simultaneously.  To keep the GPU simpler the values in memory
+  **(3) Memory is not aligned**.  The GPU hardware is specialized to operate on
+  multiple values simultaneously.  To keep the GPU simple the values in memory
   must be aligned with the different GPU compute engines.  Not following these
   rules can lead to unexpected values being loaded into memory, and wrong answers
   computed.  The conclusion from a very long and strange debugging session was
   that any arrays that you declare in your model should be a multiple of four.
-  For example
+  For example::
 
       double Iq(q, p1, p2, ...)
@@ -702 +702 @@
 
 The first step when your model is behaving strangely is to set **single=False**.
-This automatically restricts the model to only run on the CPU, or on high end
-GPU cards.  There can still be problems even on high end cards, so you can force
+This automatically restricts the model to only run on the CPU, or on high-end
+GPU cards.  There can still be problems even on high-end cards, so you can force
 the model off the GPU by setting **opencl=False**.  This runs the model
 as a normal C program without any GPU restrictions so you know that
@@ -945 +945 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 10Oct2016
+.. note::  This help document was last changed by Steve King, 25Oct2016