Changeset 68532f3 in sasmodels for _sources/model/bcc.txt

Timestamp:

Nov 1, 2015 2:10:22 PM (8 years ago)

Author:

ajj

Branches:

gh-pages

Children:

4a9a316

Parents:

d1fe925

Message:

Adding docs

File:

• _sources/model/bcc.txt (moved) (moved from sasmodels/models/bcc.py) (2 diffs)

_sources/model/bcc.txt

@@ -1 @@
-#bcc paracrystal model
-#note model title and parameter table are automatically inserted
-#note - calculation requires double precision
-r"""
+.. _bcc-paracrystal:
+
+Bcc paracrystal
+=======================================================
+
+Body-centred cubic lattic with paracrystalline distortion
+
+=========== ================================== ============ =============
+Parameter   Description                        Units        Default value
+=========== ================================== ============ =============
+scale       Source intensity                   None                     1
+background  Source background                  |cm^-1|                  0
+dnn         Nearest neighbour distance         |Ang|                  220
+d_factor    Paracrystal distortion factor      None                  0.06
+radius      Particle radius                    |Ang|                   40
+sld         Particle scattering length density |1e-6Ang^-2|             4
+solvent_sld Solvent scattering length density  |1e-6Ang^-2|             1
+theta       In plane angle                     degree                  60
+phi         Out of plane angle                 degree                  60
+psi         Out of plane angle                 degree                  60
+=========== ================================== ============ =============
+
+The returned value is scaled to units of |cm^-1|.
+
+
 Calculates the scattering from a **body-centered cubic lattice** with
 paracrystalline distortion. Thermal vibrations are considered to be negligible,
@@ -102 +123 @@
 Hideki Matsuoka et. al. *Physical Review B*, 41 (1990) 3854 -3856
 (Corrections to FCC and BCC lattice structure calculation)
-"""
 
-from numpy import inf
-
-name = "bcc_paracrystal"
-title = "Body-centred cubic lattic with paracrystalline distortion"
-description = """
-    Calculates the scattering from a **body-centered cubic lattice** with paracrystalline distortion. Thermal vibrations
-    are considered to be negligible, and the size of the paracrystal is infinitely large. Paracrystalline distortion is
-    assumed to be isotropic and characterized by a Gaussian distribution.
-    """
-category = "shape:paracrystal"
-
-#             ["name", "units", default, [lower, upper], "type","description" ],
-parameters = [["dnn", "Ang", 220, [-inf, inf], "", "Nearest neighbour distance"],
-              ["d_factor", "", 0.06, [-inf, inf], "", "Paracrystal distortion factor"],
-              ["radius", "Ang", 40, [0, inf], "volume", "Particle radius"],
-              ["sld", "1e-6/Ang^2", 4, [-inf, inf], "", "Particle scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "", "Solvent scattering length density"],
-              ["theta", "degrees", 60, [-inf, inf], "orientation", "In plane angle"],
-              ["phi", "degrees", 60, [-inf, inf], "orientation", "Out of plane angle"],
-              ["psi", "degrees", 60, [-inf, inf], "orientation", "Out of plane angle"]
-             ]
-
-source = ["lib/J1.c", "lib/gauss150.c", "bcc.c"]
-
-# parameters for demo
-demo = dict(
-    scale=1, background=0,
-    dnn=220, d_factor=0.06, sld=4, solvent_sld=1,
-    radius=40,
-    theta=60, phi=60, psi=60,
-    radius_pd=.2, radius_pd_n=0.2,
-    theta_pd=15, theta_pd_n=0,
-    phi_pd=15, phi_pd_n=0,
-    psi_pd=15, psi_pd_n=0,
-    )
-
-# For testing against the old sasview models, include the converted parameter
-# names and the target sasview model name.
-oldname = 'BCCrystalModel'
-oldpars = dict(sld='sldSph', solvent_sld='sldSolv')