Changeset 31d7803 in sasview for src/sas/sasgui/perspectives/fitting/media/plugin.rst

Timestamp:

Sep 26, 2016 10:05:13 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, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

a0373d5, e925f61

Parents:

7f23423

Message:

Completed review - minor changes

File:

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

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

@@ -288 +288 @@
         ["radius",      "Ang",        50, [0, inf],    "volume", "Sphere radius"],
     ]
+    # pylint: enable=bad-whitespace, line-too-long
 
 **parameters = [["name", "units", default, [min,max], "type", "tooltip"],...]**
@@ -577 +578 @@
 ............
 
-::
-
-    def ER(radius, thickness):
-        """Effective radius of a core-shell sphere."""
-        return radius + thickness
-
 Away from the dilute limit you can estimate scattering including
 particle-particle interactions using $I(q) = P(q)*S(q)$ where $P(q)$
@@ -591 +586 @@
 form averaged over all the polydispersity values.
 
-Consider the *core_shell_sphere*, which has a simple effective radius
+::
+
+    def ER(radius, thickness):
+        """Effective radius of a core-shell sphere."""
+        return radius + thickness
+
+Now consider the *core_shell_sphere*, which has a simple effective radius
 equal to the radius of the core plus the thickness of the shell, as
 shown above. Given polydispersity over *(r1, r2, ..., rm)* in radius and
@@ -616 +617 @@
 one return value for each point in the mesh grid.
 
-*NOTE: we may be removing or modifying this feature soon.*  As of this
-writing, core-shell sphere returns (1., 1.) for *VR*, giving a volume
-ratio of 1.0.
+*NOTE: we may be removing or modifying this feature soon. As of the 
+time of writing, core-shell sphere returns (1., 1.) for VR, giving a volume
+ratio of 1.0.*
 
 Unit Tests
@@ -660 +661 @@
 
 If you are editing your model from the SasView GUI, you can test it
-by selecting *Run -> Compile* from the *Model Editor* menu bar. An
+by selecting *Run > Compile* from the *Model Editor* menu bar. An
 *Info* box will appear with the results of the compilation and a
 check that the model runs.
 
 If the model compiles and runs, you can next run the unit tests that
-you have added using the **test=** values. Switch to the *Shell* tab
+you have added using the **test =** values. Switch to the *Shell* tab
 and type the following::
 
@@ -705 +706 @@
 For the random models,
 
-- sld will be in(-0.5,10.5),
-- angles (theta, phi, psi) will be in (-180,180),
-- angular dispersion will be in (0,45),
-- polydispersity will be in (0,1)
-- other values will be in (0, 2*v) where v is the value of the parameter in demo.
-
-Dispersion parameters n, sigma and type will be unchanged from demo so that
+- *sld* will be in the range (-0.5,10.5),
+- angles (*theta, phi, psi*) will be in the range (-180,180),
+- angular dispersion will be in the range (0,45),
+- polydispersity will be in the range (0,1)
+- other values will be in the range (0, 2\ *v*), where *v* is the value of the parameter in demo.
+
+Dispersion parameters *n*\, *sigma* and *type* will be unchanged from demo so that
 run times are predictable.
 
@@ -723 +724 @@
 ^^^^^^^^^^
 
-**NB: For now we are not providing pylint with SasView; unless you have a
-SasView development environment available, you can ignore this section.**
+**NB: For now we are not providing pylint with SasView; so unless you have a
+SasView development environment available, you can ignore this section!**
 
 Run the lint check with::
@@ -736 +737 @@
 for standard model functions *Iq*, *Iqxy*, etc.
 
-We will have delinting sessions at the SasView code camps, where we can
+We will have delinting sessions at the SasView Code Camps, where we can
 decide on standards for model files, parameter names, etc.
 
-For now, you can tell pylint to ignore things.  For example, to align you
+For now, you can tell pylint to ignore things.  For example, to align your
 parameters in blocks::
 
@@ -775 +776 @@
 - `amsmath <http://www.ams.org/publications/authors/tex/amslatex>`_
 
+There is also a neat online WYSIWYG ReStructuredText editor at http://rst.ninjs.org\ .
+
 Finally
 ^^^^^^^
@@ -780 +783 @@
 Once compare and the unit test(s) pass properly and everything is done,
 consider adding your model to the
-`model marketplace <http://marketplace.sasview.org/>`_.
+`Model Marketplace <http://marketplace.sasview.org/>`_.