Changeset a5d0d00 in sasmodels for sasmodels/models/barbell.py

Timestamp:

Feb 27, 2015 11:16:23 AM (9 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

61ba623

Parents:

529b8b4

Message:

doc fixups: add doc category to model def, convert equations to latex for barbell and bcc

File:

• sasmodels/models/barbell.py (modified) (5 diffs)

sasmodels/models/barbell.py

@@ -16 +16 @@
 The barbell geometry is defined as
 
-.. image:: img/image105.jpg
+.. image:: img/barbell_geometry.jpg
 
 where *r* is the radius of the cylinder. All other parameters are as defined in the diagram.
@@ -71 +71 @@
 **The requirement that** *R* >= *r* **is not enforced in the model!** It is up to you to restrict this during analysis.
 
-This example dataset is produced by running the Macro PlotBarbell(), using 200 data points, *qmin* = 0.001 |Ang^-1|,
-*qmax* = 0.7 |Ang^-1| and the following default values
+This example dataset is produced by running the Macro PlotBarbell(),
+using 200 data points, *qmin* = 0.001 |Ang^-1|, *qmax* = 0.7 |Ang^-1|,
+*sld* = 4e-6 |Ang^-2| and the default model values.
 
-==============  ========  =============
-Parameter name  Units     Default value
-==============  ========  =============
-scale           None      1.0
-len_bar         |Ang|     400.0
-rad_bar         |Ang|     20.0
-rad_bell        |Ang|     40.0
-sld_barbell     |Ang^-2|  1.0e-006
-sld_solv        |Ang^-2|  6.3e-006
-background      |cm^-1|   0
-==============  ========  =============
-
-.. image:: img/image110.jpg
+.. image:: img/barbell_1d.jpg
 
 *Figure. 1D plot using the default values (w/256 data point).*
@@ -93 +82 @@
 |theta| = 45 deg and |phi| = 0 deg with default values for other parameters
 
-.. image:: img/image111.jpg
+.. image:: img/barbell_2d.jpg
 
 *Figure. 2D plot (w/(256X265) data points).*
@@ -106 +95 @@
 
 REFERENCE
+---------
 
 H Kaya, *J. Appl. Cryst.*, 37 (2004) 37 223-230
@@ -122 +112 @@
                 It must be that rad_bar <(=) rad_bell.
 """
+category = "shape:cylinder"
 
 parameters = [