Changeset 8ae8532 in sasmodels for doc/guide/sesans

Timestamp:

May 7, 2017 2:24:16 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

990d8df

Parents:

630156b

Message:

doc reorg

Location:

doc/guide/sesans

Files:

• SESANSinSASVIEW.pdf (moved) (moved from doc/ref/sesans/SESANSinSASVIEW.pdf)
• sans_to_sesans.rst (added)
• sesans_fitting.rst (moved) (moved from doc/ref/sesans/sesans_fitting.rst) (7 diffs)
• sesans_img/HardSphereLineFitSasView.png (moved) (moved from doc/ref/sesans/sesans_img/HardSphereLineFitSasView.png)
• sesans_img/SphereLineFitSasView.png (moved) (moved from doc/ref/sesans/sesans_img/SphereLineFitSasView.png)

doc/guide/sesans/sesans_fitting.rst

@@ -7 +7 @@
 ===================
 
-.. note:: A proper installation of the developers setup of SasView (http://trac.sasview.org/wiki/AnacondaSetup) is a prerequisite for using these instructions.
+.. note::
+
+    A proper installation of the developers setup of SasView
+    (http://trac.sasview.org/wiki/AnacondaSetup) is a prerequisite for
+    using these instructions.
 
 It is possible to fit SESANS measurements from the command line in Python.
@@ -13 +17 @@
 Simple Fits
 ...........
-In the folder sasmodels/example the file sesans_sphere_2micron.py gives an example of how to fit a shape to a measurement.
+In the folder sasmodels/example the file sesans_sphere_2micron.py gives
+an example of how to fit a shape to a measurement.
 
 The command::
@@ -23 +28 @@
 .. image:: sesans_img/SphereLineFitSasView.png
 
-All the parameters and names in sesans_sphere_2micron.py (shown below) can be adjusted to fit your own problem::
+All the parameters and names in sesans_sphere_2micron.py (shown below) can
+be adjusted to fit your own problem::
 
   """
@@ -64 +70 @@
   # Constraints
   # model.param_name = f(other params)
-  # EXAMPLE: model.scale = model.radius*model.radius*(1 - phi) - where radius and scale are model functions and phi is
-  # a custom parameter
+  # EXAMPLE: model.scale = model.radius*model.radius*(1 - phi) - where radius
+  # and scale are model functions and phi is a custom parameter
   model.scale = phi*(1-phi)
 
@@ -74 +80 @@
 Incorporating a Structure Factor
 ................................
-An example of how to also include a structure factor can be seen in the following example taken from Washington et al., 
-*Soft Matter*\, (2014), 10, 3016 (dx.doi.org/10.1039/C3SM53027B). These are time-of-flight measurements, which is the 
-reason that not the polarisation is plotted, but the :math:`\frac{log(P/P_0)}{\lambda^2}` . The sample is a dispersion 
-of core-shell colloids at a high volume fraction with hard sphere interactions.
+An example of how to also include a structure factor can be seen in the
+following example taken from Washington et al., *Soft Matter*\, (2014), 10, 3016
+(dx.doi.org/10.1039/C3SM53027B). These are time-of-flight measurements, which
+is the reason that not the polarisation is plotted, but the
+:math:`\frac{log(P/P_0)}{\lambda^2}` . The sample is a dispersion of
+core-shell colloids at a high volume fraction with hard sphere interactions.
 
 The fit can be started by::
@@ -87 +95 @@
 .. image:: sesans_img/HardSphereLineFitSasView.png
 
-The code sesans_parameters_css-hs.py can then be used as a template for a fitting problem with a structure factor::
+The code sesans_parameters_css-hs.py can then be used as a template for a
+fitting problem with a structure factor::
 
  """
@@ -131 +140 @@
  # Constraints
  # model.param_name = f(other params)
- # EXAMPLE: model.scale = model.radius*model.radius*(1 - phi) - where radius and scale are model functions and phi is
- # a custom parameter
+ # EXAMPLE: model.scale = model.radius*model.radius*(1 - phi) - where radius
+ # and scale are model functions and phi is a custom parameter
  model.scale = phi*(1-phi)
  model.volfraction = phi