Changeset c1e44e5 in sasmodels


Ignore:
Timestamp:
Mar 30, 2019 1:59:45 AM (8 weeks ago)
Author:
Paul Kienzle <pkienzle@…>
Branches:
master
Children:
a42b091
Parents:
663d2a8
Message:

Add local link to source files. Refs #1263.

Files:
78 edited

Legend:

Unmodified
Added
Removed
  • doc/conf.py

    r30b60d2 rc1e44e5  
    3636              #'only_directives', 
    3737              #'matplotlib.sphinxext.mathmpl', 
    38               'matplotlib.sphinxext.only_directives', 
     38              #'matplotlib.sphinxext.only_directives', 
    3939              'matplotlib.sphinxext.plot_directive', 
    4040              'dollarmath', 
  • doc/genmodel.py

    rb866abf rc1e44e5  
    77import matplotlib.pyplot as plt 
    88sys.path.insert(0, os.path.abspath('..')) 
     9import sasmodels 
    910from sasmodels import generate, core 
    1011from sasmodels.direct_model import DirectModel, call_profile 
     
    127128    #print("figure saved in",path) 
    128129 
     130def copy_if_newer(src, dst): 
     131    from os.path import dirname, exists, getmtime 
     132    import shutil 
     133    if not exists(dst): 
     134        path = dirname(dst) 
     135        if not exists(path): 
     136            os.makedirs(path) 
     137        shutil.copy2(src, dst) 
     138    elif getmtime(src) > getmtime(dst): 
     139        shutil.copy2(src, dst) 
     140 
     141def link_sources(model_info): 
     142    from os.path import basename, dirname, realpath, join as joinpath 
     143 
     144    # List source files in reverse order of dependency. 
     145    model_file = basename(model_info.filename) 
     146    sources = list(reversed(model_info.source + [model_file])) 
     147 
     148    # Copy files to src dir under models directory.  Need to do this 
     149    # because sphinx can't link to an absolute path. 
     150    root = dirname(dirname(realpath(__file__))) 
     151    src = joinpath(root, "sasmodels", "models") 
     152    dst = joinpath(root, "doc", "model", "src") 
     153    for path in sources: 
     154        copy_if_newer(joinpath(src, path), joinpath(dst, path)) 
     155 
     156    # Link to local copy of the files 
     157    downloads = [":download:`%s <src/%s>`"%(path, path) for path in sources] 
     158 
     159    # Link to github repo (either the tagged sasmodels version or master) 
     160    url = "https://github.com/SasView/sasmodels/blob/v%s"%sasmodels.__version__ 
     161    #url = "https://github.com/SasView/sasmodels/blob/master"%sasmodels.__version__ 
     162    links = ["`%s <%s/sasmodels/models/%s>`_"%(path, url, path) for path in sources] 
     163 
     164    sep = u"\n\\ \u25E6 \\ "  # bullet 
     165    body = "\n**Source**\n" 
     166    #body += "\n\\ " + sep.join(links) + "\n\n" 
     167    body += "\n\\ " + sep.join(downloads) + "\n\n" 
     168    return body 
     169 
    129170def gen_docs(model_info): 
    130171    # type: (ModelInfo) -> None 
     
    150191    match = re.search(pattern, docstr.upper()) 
    151192 
     193    sources = link_sources(model_info) 
     194 
     195    insertion = captionstr + sources 
     196 
    152197    if match: 
    153198        docstr1 = docstr[:match.start()] 
    154199        docstr2 = docstr[match.start():] 
    155         docstr = docstr1 + captionstr + docstr2 
     200        docstr = docstr1 + insertion + docstr2 
    156201    else: 
    157202        print('------------------------------------------------------------------') 
    158203        print('References NOT FOUND for model: ', model_info.id) 
    159204        print('------------------------------------------------------------------') 
    160         docstr += captionstr 
     205        docstr += insertion 
    161206 
    162207    open(sys.argv[2],'w').write(docstr) 
  • sasmodels/models/_spherepy.py

    r0507e09 rc1e44e5  
    3939John Wiley and Sons, New York, (1955) 
    4040 
    41 Source 
    42 ------ 
    43  
    44 `_spherepy.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/_spherepy.py>`_ 
    45 `sphere.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sphere.c>`_ 
    46  
    4741Authorship and Verification 
    4842---------------------------- 
    4943 
    50 * **Author: P Kienzle**  
    51 * **Last Modified by:**  
     44* **Author: P Kienzle** 
     45* **Last Modified by:** 
    5246* **Last Reviewed by:** S King and P Parker **Date:** 2013/09/09 and 2014/01/06 
    53 * **Source added by :** Steve King **Date:** March 25, 2019 
    5447""" 
    5548 
  • sasmodels/models/adsorbed_layer.py

    r0507e09 rc1e44e5  
    4949   Layers*, *Macromol. Symp.*, 190 (2002) 33-42. 
    5050 
    51 Source 
    52 ------ 
    53  
    54 `adsorbed_layer.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/adsorbed_layer.py>`_ 
    55  
    5651Authorship and Verification 
    5752---------------------------- 
     
    6055* **Last Modified by:** Paul Kienzle **Date:** April 14, 2016 
    6156* **Last Reviewed by:** Steve King **Date:** March 18, 2016 
    62 * **Source added by :** Steve King **Date:** March 25, 2019 
    6357""" 
    6458 
  • sasmodels/models/barbell.py

    r0507e09 rc1e44e5  
    8181.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    8282 
    83 Source 
    84 ------ 
    85  
    86 `barbell.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/barbell.py>`_ 
    87  
    88 `barbell.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/barbell.c>`_ 
    89  
    9083Authorship and Verification 
    9184---------------------------- 
     
    9487* **Last Modified by:** Paul Butler **Date:** March 20, 2016 
    9588* **Last Reviewed by:** Richard Heenan **Date:** January 4, 2017 
    96 * **Source added by :** Steve King **Date:** March 25, 2019 
    9789""" 
    9890 
  • sasmodels/models/bcc_paracrystal.py

    r0507e09 rc1e44e5  
    100100   (Corrections to FCC and BCC lattice structure calculation) 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `bcc_paracrystal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/bcc_paracrystal.py>`_ 
    106  
    107 `bcc_paracrystal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/bcc_paracrystal.c>`_ 
    108  
    109102Authorship and Verification 
    110103--------------------------- 
     
    113106* **Last Modified by:** Paul Butler **Date:** September 29, 2016 
    114107* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016 
    115 * **Source added by :** Steve King **Date:** March 25, 2019 
    116108""" 
    117109 
  • sasmodels/models/be_polyelectrolyte.py

    r0507e09 rc1e44e5  
    9191.. [#] E Raphael, J F Joanny, *Europhysics Letters*, 11 (1990) 179 
    9292 
    93 Source 
    94 ------ 
    95  
    96 `be_polyelectrolyte.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/be_polyelectrolyte.py>`_ 
    97  
    9893Authorship and Verification 
    9994---------------------------- 
     
    10297* **Last Modified by:** Paul Butler **Date:** September 25, 2018 
    10398* **Last Reviewed by:** Paul Butler **Date:** September 25, 2018 
    104 * **Source added by :** Steve King **Date:** March 25, 2019 
    10599""" 
    106100 
  • sasmodels/models/binary_hard_sphere.py

    r0507e09 rc1e44e5  
    6565.. [#] S R Kline, *J Appl. Cryst.*, 39 (2006) 895 
    6666 
    67 Source 
    68 ------ 
    69  
    70 `binary_hard_sphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/binary_hard_sphere.py>`_ 
    71  
    72 `binary_hard_sphere.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/binary_hard_sphere.c>`_ 
    73  
    7467Authorship and Verification 
    7568---------------------------- 
     
    7871* **Last Modified by:** Paul Butler **Date:** March 20, 2016 
    7972* **Last Reviewed by:** Paul Butler **Date:** March 20, 2016 
    80 * **Source added by :** Steve King **Date:** March 25, 2019 
    8173""" 
    8274 
  • sasmodels/models/broad_peak.py

    r0507e09 rc1e44e5  
    3333None. 
    3434 
    35 Source 
    36 ------ 
    37  
    38 `broad_peak.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/broad_peak.py>`_ 
    39  
    4035Authorship and Verification 
    4136---------------------------- 
     
    4439* **Last Modified by:** Paul kienle **Date:** July 24, 2016 
    4540* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016 
    46 * **Source added by :** Steve King **Date:** March 25, 2019 
    4741""" 
    4842 
  • sasmodels/models/capped_cylinder.py

    r0507e09 rc1e44e5  
    8484.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    8585 
    86 Source 
    87 ------ 
    88  
    89 `capped_cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/capped_cylinder.py>`_ 
    90  
    91 `capped_cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/capped_cylinder.c>`_ 
    92  
    9386Authorship and Verification 
    9487---------------------------- 
     
    9790* **Last Modified by:** Paul Butler **Date:** September 30, 2016 
    9891* **Last Reviewed by:** Richard Heenan **Date:** January 4, 2017 
    99 * **Source added by :** Steve King **Date:** March 25, 2019 
    10092""" 
    10193 
  • sasmodels/models/core_multi_shell.py

    r0507e09 rc1e44e5  
    3939   Neutron Scattering*, Plenum Press, New York, 1987. 
    4040 
    41 Source 
    42 ------ 
    43  
    44 `core_multi_shell.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_multi_shell.py>`_ 
    45  
    46 `core_multi_shell.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_multi_shell.c>`_ 
    47  
    4841Authorship and Verification 
    4942---------------------------- 
     
    5245* **Last Modified by:** Paul Kienzle **Date:** September 12, 2016 
    5346* **Last Reviewed by:** Paul Kienzle **Date:** September 12, 2016 
    54 * **Source added by :** Steve King **Date:** March 25, 2019 
    5547""" 
    5648from __future__ import division 
  • sasmodels/models/core_shell_bicelle.py

    r0507e09 rc1e44e5  
    9292.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    9393 
    94 Source 
    95 ------ 
    96  
    97 `core_shell_bicelle.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle.py>`_ 
    98  
    99 `core_shell_bicelle.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle.c>`_ 
    100  
    10194Authorship and Verification 
    10295---------------------------- 
     
    10598* **Last Modified by:** Paul Butler **Date:** September 30, 2016 
    10699* **Last Reviewed by:** Richard Heenan **Date:** January 4, 2017 
    107 * **Source added by :** Steve King **Date:** March 25, 2019 
    108100""" 
    109101 
  • sasmodels/models/core_shell_bicelle_elliptical.py

    r0507e09 rc1e44e5  
    101101.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    102102 
    103 Source 
    104 ------ 
    105  
    106 `core_shell_bicelle_elliptical.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle_elliptical.py>`_ 
    107  
    108 `core_shell_bicelle_elliptical.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle_elliptical.c>`_ 
    109  
    110103Authorship and Verification 
    111104---------------------------- 
     
    114107* **Last Modified by:**  Richard Heenan **Date:** December 14, 2016 
    115108* **Last Reviewed by:**  Paul Kienzle **Date:** Feb 28, 2018 
    116 * **Source added by :**  Steve King **Date:** March 25, 2019 
    117109""" 
    118110 
  • sasmodels/models/core_shell_bicelle_elliptical_belt_rough.py

    r0507e09 rc1e44e5  
    113113.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    114114 
    115 Source 
    116 ------ 
    117  
    118 `core_shell_bicelle_elliptical_belt_rough.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle_elliptical_belt_rough.py>`_ 
    119  
    120 `core_shell_bicelle_elliptical_belt_rough.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_bicelle_elliptical_belt_rough.c>`_ 
    121  
    122115Authorship and Verification 
    123116---------------------------- 
     
    126119* **Last Modified by:**  Richard Heenan new 2d orientation **Date:** October 5, 2017 
    127120* **Last Reviewed by:**  Richard Heenan 2d calc seems agree with 1d **Date:** Nov 2, 2017 
    128 * **Source added by :**  Steve King **Date:** March 25, 2019 
    129121""" 
    130122 
  • sasmodels/models/core_shell_cylinder.py

    r81d0b9b rc1e44e5  
    7272.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    7373 
    74 Source 
    75 ------ 
    76  
    77 `core_shell_cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_cylinder.py>`_ 
    78  
    79 `core_shell_cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_cylinder.c>`_ 
    80  
    8174Authorship and Verification 
    8275---------------------------- 
     
    8578* **Last Modified by:** Paul Kienzle **Date:** Aug 8, 2016 
    8679* **Last Reviewed by:** Richard Heenan **Date:** March 18, 2016 
    87 * **Source added by :** Steve King **Date:** March 25, 2019 
    8880""" 
    8981 
  • sasmodels/models/core_shell_ellipsoid.py

    re5a8f33 rc1e44e5  
    33---------- 
    44 
    5 Parameters for this model are the core axial ratio $X_{core}$ and a shell  
    6 thickness $t_{shell}$, which are more often what we would like to determine  
    7 and make the model better behaved, particularly when polydispersity is  
    8 applied, than the four independent radii used in the original parameterization  
     5Parameters for this model are the core axial ratio $X_{core}$ and a shell 
     6thickness $t_{shell}$, which are more often what we would like to determine 
     7and make the model better behaved, particularly when polydispersity is 
     8applied, than the four independent radii used in the original parameterization 
    99of this model. 
    1010 
     
    1919$X_{core}$ = 1 is a spherical core. 
    2020 
    21 For a fixed shell thickness $X_{polar shell}$ = 1, to scale $t_{shell}$  
     21For a fixed shell thickness $X_{polar shell}$ = 1, to scale $t_{shell}$ 
    2222pro-rata with the radius set or constrain $X_{polar shell}$ = $X_{core}$. 
    2323 
     
    4747 
    4848.. In following equation SK changed radius\_equat\_core to R_e 
    49    
     49 
    5050.. math:: 
    5151    :nowrap: 
     
    7676$V = (4/3)\pi R_pR_e^2$ is the volume of the ellipsoid , $R_p$ is the 
    7777polar radius along the rotational axis of the ellipsoid, $R_e$ is the 
    78 equatorial radius perpendicular to the rotational axis of the ellipsoid,  
    79 $t_{shell}$ is the thickness of the shell at the equator,  
     78equatorial radius perpendicular to the rotational axis of the ellipsoid, 
     79$t_{shell}$ is the thickness of the shell at the equator, 
    8080and $\Delta \rho$ (the contrast) is the scattering length density difference, 
    8181either $(\rho_{core} - \rho_{shell})$ or $(\rho_{shell} - \rho_{solvent})$. 
     
    9898.. [#] Berr, S. *J. Phys. Chem.*, 1987, 91, 4760 
    9999 
    100 Source 
    101 ------ 
    102  
    103 `core_shell_ellipsoid.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_ellipsoid.py>`_ 
    104  
    105 `core_shell_ellipsoid.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_ellipsoid.c>`_ 
    106  
    107100Authorship and Verification 
    108101---------------------------- 
     
    111104* **Last Modified by:** Richard Heenan (reparametrised model) **Date:** 2015 
    112105* **Last Reviewed by:** Steve King **Date:** March 27, 2019 
    113 * **Source added by :** Steve King **Date:** March 25, 2019 
    114106""" 
    115107 
  • sasmodels/models/core_shell_parallelepiped.py

    r0507e09 rc1e44e5  
    175175.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    176176 
    177 Source 
    178 ------ 
    179  
    180 `core_shell_parallelepiped.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_parallelepiped.py>`_ 
    181  
    182 `core_shell_parallelepiped.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_parallelepiped.c>`_ 
    183  
    184177Authorship and Verification 
    185178---------------------------- 
     
    190183* **Last Reviewed by:** Paul Butler **Date:** May 24, 2018 - documentation 
    191184  updated 
    192 * **Source added by :** Steve King **Date:** March 25, 2019 
    193185""" 
    194186 
  • sasmodels/models/core_shell_sphere.py

    r0507e09 rc1e44e5  
    5050.. [#] A Guinier and G Fournet, *Small-Angle Scattering of X-Rays*, John Wiley and Sons, New York, (1955) 
    5151 
    52 Source 
    53 ------ 
    54  
    55 `core_shell_sphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_sphere.py>`_ 
    56  
    57 `core_shell_sphere.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/core_shell_sphere.c>`_ 
    58  
    5952Authorship and Verification 
    6053---------------------------- 
    6154 
    62 * **Author:**  
    63 * **Last Modified by:**  
    64 * **Last Reviewed by:**  
    65 * **Source added by :** Steve King **Date:** March 25, 2019 
     55* **Author:** 
     56* **Last Modified by:** 
     57* **Last Reviewed by:** 
    6658""" 
    6759 
  • sasmodels/models/correlation_length.py

    r0507e09 rc1e44e5  
    3232.. [#] B Hammouda, D L Ho and S R Kline, Insight into Clustering in Poly(ethylene oxide) Solutions, Macromolecules, 37 (2004) 6932-6937 
    3333 
    34 Source 
    35 ------ 
    36  
    37 `correlation_length.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/correlation_length.py>`_ 
    38  
    3934Authorship and Verification 
    4035---------------------------- 
    4136 
    42 * **Author:**  
    43 * **Last Modified by:**  
    44 * **Last Reviewed by:**  
    45 * **Source added by :** Steve King **Date:** March 25, 2019 
     37* **Author:** 
     38* **Last Modified by:** 
     39* **Last Reviewed by:** 
    4640""" 
    4741 
  • sasmodels/models/cylinder.py

    r0507e09 rc1e44e5  
    100100.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/cylinder.py>`_ 
    106  
    107 `cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/cylinder.c>`_ 
    108  
    109102Authorship and Verification 
    110103---------------------------- 
    111104 
    112 * **Author:**  
    113 * **Last Modified by:**  
    114 * **Last Reviewed by:**  
    115 * **Source added by :** Steve King **Date:** March 25, 2019 
     105* **Author:** 
     106* **Last Modified by:** 
     107* **Last Reviewed by:** 
    116108""" 
    117109 
  • sasmodels/models/ellipsoid.py

    r0507e09 rc1e44e5  
    109109.. [#] A. Isihara. *J. Chem. Phys.*, 18 (1950) 1446-1449 
    110110 
    111 Source 
    112 ------ 
    113  
    114 `ellipsoid.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/ellipsoid.py>`_ 
    115  
    116 `ellipsoid.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/ellipsoid.c>`_ 
    117  
    118111Authorship and Verification 
    119112---------------------------- 
     
    122115* **Converted to sasmodels by:** Helen Park **Date:** July 9, 2014 
    123116* **Last Modified by:** Paul Kienzle **Date:** March 22, 2017 
    124 * **Source added by :** Steve King **Date:** March 25, 2019 
    125117""" 
    126118from __future__ import division 
  • sasmodels/models/elliptical_cylinder.py

    r0507e09 rc1e44e5  
    8989.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    9090 
    91 Source 
    92 ------ 
    93  
    94 `elliptical_cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/elliptical_cylinder.py>`_ 
    95  
    96 `elliptical_cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/elliptical_cylinder.c>`_ 
    97  
    9891Authorship and Verification 
    9992---------------------------- 
     
    10295* **Last Modified by:** 
    10396* **Last Reviewed by:**  Richard Heenan - corrected equation in docs **Date:** December 21, 2016 
    104 * **Source added by :** Steve King **Date:** March 25, 2019 
    10597""" 
    10698 
  • sasmodels/models/fcc_paracrystal.py

    r0507e09 rc1e44e5  
    9999   (Corrections to FCC and BCC lattice structure calculation) 
    100100 
    101 Source 
    102 ------ 
    103  
    104 `fcc_paracrystal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fcc_paracrystal.py>`_ 
    105  
    106 `fcc_paracrystal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fcc_paracrystal.c>`_ 
    107  
    108101Authorship and Verification 
    109102--------------------------- 
     
    112105* **Last Modified by:** Paul Butler **Date:** September 29, 2016 
    113106* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016 
    114 * **Source added by :** Steve King **Date:** March 25, 2019 
    115107""" 
    116108 
  • sasmodels/models/flexible_cylinder.py

    r40c9825 rc1e44e5  
    3333and solvent respectively. 
    3434 
    35 Our model uses the form factor calculations in reference [1] as implemented in a  
     35Our model uses the form factor calculations in reference [1] as implemented in a 
    3636c-library provided by the NIST Center for Neutron Research (Kline, 2006). This states: 
    3737 
     
    4141    pseudocontinuous limit. 
    4242    See equations (13,26-27) in the original reference for the details. 
    43      
     43 
    4444.. note:: 
    4545 
     
    6161 
    6262 
    63 **This is a model with complex behaviour depending on the ratio of** $L/b$ **and the  
     63**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the 
    6464reader is strongly encouraged to read reference [1] before use.** 
    6565 
     
    7373.. [#] W R Chen, P D Butler and L J Magid, *Incorporating Intermicellar Interactions in the Fitting of SANS Data from Cationic Wormlike Micelles.* Langmuir, 22(15) 2006 6539-6548 
    7474 
    75 Source 
    76 ------ 
    77  
    78 `flexible_cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/flexible_cylinder.py>`_ 
    79  
    80 `flexible_cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/flexible_cylinder.c>`_ 
    81  
    82 `wrc_cyl.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lib/wrc_cyl.c>`_ 
    83  
    8475Authorship and Verification 
    8576---------------------------- 
    8677 
    87 * **Author:**  
    88 * **Last Modified by:**  
     78* **Author:** 
     79* **Last Modified by:** 
    8980* **Last Reviewed by:** Steve King **Date:** March 26, 2019 
    90 * **Source added by :** Steve King **Date:** March 25, 2019 
    9181""" 
    9282 
  • sasmodels/models/flexible_cylinder_elliptical.py

    r40c9825 rc1e44e5  
    2626----------- 
    2727 
    28 The function is calculated in a similar way to that for the  
    29 :ref:`flexible-cylinder` model in reference [1] below using the author's  
     28The function is calculated in a similar way to that for the 
     29:ref:`flexible-cylinder` model in reference [1] below using the author's 
    3030"Method 3 With Excluded Volume". 
    3131 
     
    7171these parameters must be held fixed during model fitting. 
    7272 
    73 **This is a model with complex behaviour depending on the ratio of** $L/b$ **and the  
     73**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the 
    7474reader is strongly encouraged to read reference [1] before use.** 
    7575 
     
    8383.. [#] W R Chen, P D Butler and L J Magid, *Incorporating Intermicellar Interactions in the Fitting of SANS Data from Cationic Wormlike Micelles.* Langmuir, 22(15) 2006 6539-6548 
    8484 
    85 Source 
    86 ------ 
    87  
    88 `flexible_cylinder_elliptical.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/flexible_cylinder_elliptical.py>`_ 
    89  
    90 `flexible_cylinder_elliptical.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/flexible_cylinder_elliptical.c>`_ 
    91  
    92 `wrc_cyl.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lib/wrc_cyl.c>`_ 
    93  
    9485Authorship and Verification 
    9586---------------------------- 
    9687 
    97 * **Author:**  
     88* **Author:** 
    9889* **Last Modified by:** Richard Heenan **Date:** December, 2016 
    9990* **Last Reviewed by:** Steve King **Date:** March 26, 2019 
    100 * **Source added by :** Steve King **Date:** March 25, 2019 
    10191""" 
    10292 
  • sasmodels/models/fractal.py

    r0507e09 rc1e44e5  
    4646.. [#] J Teixeira, *J. Appl. Cryst.*, 21 (1988) 781-785 
    4747 
    48 Source 
    49 ------ 
    50  
    51 `fractal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fractal.py>`_ 
    52  
    53 `fractal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fractal.c>`_ 
    54  
    5548Authorship and Verification 
    5649---------------------------- 
     
    6053* **Last Modified by:** Paul Butler **Date:** March 12, 2017 
    6154* **Last Reviewed by:** Paul Butler **Date:** March 12, 2017 
    62 * **Source added by :** Steve King **Date:** March 25, 2019 
    6355""" 
    6456from __future__ import division 
  • sasmodels/models/fractal_core_shell.py

    r0507e09 rc1e44e5  
    5151.. [#Kline]  S R Kline, *J Appl. Cryst.*, 39 (2006) 895 
    5252 
    53 Source 
    54 ------ 
    55  
    56 `fractal_core_shell.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fractal_core_shell.py>`_ 
    57  
    58 `fractal_core_shell.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fractal_core_shell.c>`_ 
    59  
    6053Authorship and Verification 
    6154---------------------------- 
     
    6457* **Last Modified by:** Paul Butler and Paul Kienzle **Date:** November 27, 2016 
    6558* **Last Reviewed by:** Paul Butler and Paul Kienzle **Date:** November 27, 2016 
    66 * **Source added by :** Steve King **Date:** March 25, 2019 
    6759""" 
    6860 
  • sasmodels/models/fuzzy_sphere.py

    r0507e09 rc1e44e5  
    5353.. [#] M Stieger, J. S Pedersen, P Lindner, W Richtering, *Langmuir*, 20 (2004) 7283-7292 
    5454 
    55 Source 
    56 ------ 
    57  
    58 `fuzzy_sphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fuzzy_sphere.py>`_ 
    59  
    60 `fuzzy_sphere.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/fuzzy_sphere.c>`_ 
    61  
    6255Authorship and Verification 
    6356---------------------------- 
    6457 
    65 * **Author:**  
    66 * **Last Modified by:**  
    67 * **Last Reviewed by:**  
    68 * **Source added by :** Steve King **Date:** March 25, 2019 
     58* **Author:** 
     59* **Last Modified by:** 
     60* **Last Reviewed by:** 
    6961""" 
    7062 
  • sasmodels/models/gauss_lorentz_gel.py

    r0507e09 rc1e44e5  
    3434.. [#] G Evmenenko, E Theunissen, K Mortensen, H Reynaers, *Polymer*, 42 (2001) 2907-2913 
    3535 
    36 Source 
    37 ------ 
    38  
    39 `gauss_lorentz_gel.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/gauss_lorentz_gel.py>`_ 
    40  
    4136Authorship and Verification 
    4237---------------------------- 
    4338 
    44 * **Author:**  
    45 * **Last Modified by:**  
    46 * **Last Reviewed by:**  
    47 * **Source added by :** Steve King **Date:** March 25, 2019 
     39* **Author:** 
     40* **Last Modified by:** 
     41* **Last Reviewed by:** 
    4842""" 
    4943 
  • sasmodels/models/gaussian_peak.py

    r0507e09 rc1e44e5  
    2727None. 
    2828 
    29 Source 
    30 ------ 
    31  
    32 `gaussian_peak.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/gaussian_peak.py>`_ 
    33  
    3429Authorship and Verification 
    3530---------------------------- 
    3631 
    37 * **Author:**  
    38 * **Last Modified by:**  
    39 * **Last Reviewed by:**  
    40 * **Source added by :** Steve King **Date:** March 25, 2019 
     32* **Author:** 
     33* **Last Modified by:** 
     34* **Last Reviewed by:** 
    4135""" 
    4236 
  • sasmodels/models/gel_fit.py

    r0507e09 rc1e44e5  
    4141.. [#] Simon Mallam, Ferenc Horkay, Anne-Marie Hecht, Adrian R Rennie, Erik Geissler, *Macromolecules* 1991, 24, 543-548 
    4242 
    43 Source 
    44 ------ 
    45  
    46 `gel_fit.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/gel_fit.py>`_ 
    47  
    48 `gel_fit.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/gel_fit.c>`_ 
    49  
    5043Authorship and Verification 
    5144---------------------------- 
    5245 
    53 * **Author:**  
    54 * **Last Modified by:**  
    55 * **Last Reviewed by:**  
    56 * **Source added by :** Steve King **Date:** March 25, 2019 
     46* **Author:** 
     47* **Last Modified by:** 
     48* **Last Reviewed by:** 
    5749""" 
    5850 
  • sasmodels/models/guinier.py

    r0507e09 rc1e44e5  
    4848.. [#] A Guinier and G Fournet, *Small-Angle Scattering of X-Rays*, John Wiley & Sons, New York (1955) 
    4949 
    50 Source 
    51 ------ 
    52  
    53 `guinier.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/guinier.py>`_ 
    54  
    5550Authorship and Verification 
    5651---------------------------- 
    5752 
    58 * **Author:**  
    59 * **Last Modified by:**  
    60 * **Last Reviewed by:**  
    61 * **Source added by :** Steve King **Date:** March 25, 2019 
     53* **Author:** 
     54* **Last Modified by:** 
     55* **Last Reviewed by:** 
    6256""" 
    6357 
  • sasmodels/models/guinier_porod.py

    r7a5f8af rc1e44e5  
    6363.. [#] B Hammouda, *Analysis of the Beaucage model, J. Appl. Cryst.*, (2010), 43, 1474-1478 
    6464 
    65 Source 
    66 ------ 
    67  
    68 `guinier_porod.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/guinier_porod.py>`_ 
    69  
    7065Authorship and Verification 
    7166---------------------------- 
    7267 
    73 * **Author:**  
    74 * **Last Modified by:**  
    75 * **Last Reviewed by:**  
    76 * **Source added by :** Steve King **Date:** March 25, 2019 
     68* **Author:** 
     69* **Last Modified by:** 
     70* **Last Reviewed by:** 
    7771""" 
    7872 
  • sasmodels/models/hardsphere.py

    r5f3c534 rc1e44e5  
    33Calculates the interparticle structure factor for monodisperse 
    44spherical particles interacting through hard sphere (excluded volume) 
    5 interactions. This $S(q)$ may also be a reasonable approximation for  
    6 other particle shapes that freely rotate (but see the note below),  
     5interactions. This $S(q)$ may also be a reasonable approximation for 
     6other particle shapes that freely rotate (but see the note below), 
    77and for moderately polydisperse systems. 
    88 
    99.. note:: 
    1010 
    11    This routine is intended for uncharged particles! For charged  
     11   This routine is intended for uncharged particles! For charged 
    1212   particles try using the :ref:`hayter-msa` $S(q)$ instead. 
    13     
     13 
    1414.. note:: 
    1515 
    16    Earlier versions of SasView did not incorporate the so-called  
    17    $\beta(q)$ ("beta") correction [1] for polydispersity and non-sphericity.  
     16   Earlier versions of SasView did not incorporate the so-called 
     17   $\beta(q)$ ("beta") correction [1] for polydispersity and non-sphericity. 
    1818   This is only available in SasView versions 4.2.2 and higher. 
    1919 
     
    2525 
    2626For numerical stability the computation uses a Taylor series expansion 
    27 at very small $qR$, but there may be a very minor glitch at the  
     27at very small $qR$, but there may be a very minor glitch at the 
    2828transition point in some circumstances. 
    2929 
    30 This S(q) uses the Percus-Yevick closure relationship [2] where the  
     30This S(q) uses the Percus-Yevick closure relationship [2] where the 
    3131interparticle potential $U(r)$ is 
    3232 
     
    5454.. [#] J K Percus, J Yevick, *J. Phys. Rev.*, 110, (1958) 1 
    5555 
    56 Source 
    57 ------ 
    58  
    59 `hardsphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hardsphere.py>`_ 
    60  
    6156Authorship and Verification 
    6257---------------------------- 
    6358 
    64 * **Author:**  
    65 * **Last Modified by:**  
    66 * **Last Reviewed by:**  
    67 * **Source added by :** Steve King **Date:** March 25, 2019 
     59* **Author:** 
     60* **Last Modified by:** 
     61* **Last Reviewed by:** 
    6862""" 
    6963 
  • sasmodels/models/hayter_msa.py

    r9947865 rc1e44e5  
    11# Note: model title and parameter table are inserted automatically 
    22r""" 
    3 Calculates the interparticle structure factor for a system of charged,  
    4 spheroidal, objects in a dielectric medium [1,2]. When combined with an  
    5 appropriate form factor $P(q)$, this allows for inclusion of the  
    6 interparticle interference effects due to screened Coulombic  
     3Calculates the interparticle structure factor for a system of charged, 
     4spheroidal, objects in a dielectric medium [1,2]. When combined with an 
     5appropriate form factor $P(q)$, this allows for inclusion of the 
     6interparticle interference effects due to screened Coulombic 
    77repulsion between the charged particles. 
    88 
    99.. note:: 
    1010 
    11    This routine only works for charged particles! If the charge is set  
    12    to zero the routine may self-destruct! For uncharged particles use  
     11   This routine only works for charged particles! If the charge is set 
     12   to zero the routine may self-destruct! For uncharged particles use 
    1313   the :ref:`hardsphere` $S(q)$ instead. The upper limit for the charge 
    1414   is limited to 200e to avoid numerical instabilities. 
    15     
     15 
    1616.. note:: 
    1717 
    18    Earlier versions of SasView did not incorporate the so-called  
    19    $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity.  
     18   Earlier versions of SasView did not incorporate the so-called 
     19   $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity. 
    2020   This is only available in SasView versions 4.2.2 and higher. 
    2121 
    2222The salt concentration is used to compute the ionic strength of the solution 
    23 which in turn is used to compute the Debye screening length. There is no  
    24 provision for entering the ionic strength directly. **At present the  
    25 counterions are assumed to be monovalent**, though it should be possible  
    26 to simulate the effect of multivalent counterions by increasing the salt  
     23which in turn is used to compute the Debye screening length. There is no 
     24provision for entering the ionic strength directly. **At present the 
     25counterions are assumed to be monovalent**, though it should be possible 
     26to simulate the effect of multivalent counterions by increasing the salt 
    2727concentration. 
    2828 
    29 Over the range 0 - 100 C the dielectric constant $\kappa$ of water may be  
    30 approximated with a maximum deviation of 0.01 units by the empirical  
     29Over the range 0 - 100 C the dielectric constant $\kappa$ of water may be 
     30approximated with a maximum deviation of 0.01 units by the empirical 
    3131formula [4] 
    3232 
     
    3434 
    3535    \kappa = 87.740 - 0.40008 T + 9.398x10^{-4} T^2 - 1.410x10^{-6} T^3 
    36      
     36 
    3737where $T$ is the temperature in celsius. 
    3838 
     
    6363.. [#] C G Malmberg and A A Maryott, *J. Res. Nat. Bureau Standards*, 56 (1956) 2641 
    6464 
    65 Source 
    66 ------ 
    67  
    68 `hayter_msa.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hayter_msa.py>`_ 
    69  
    70 `hayter_msa.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hayter_msa.c>`_ 
    71  
    7265Authorship and Verification 
    7366---------------------------- 
    7467 
    75 * **Author:**  
    76 * **Last Modified by:**  
     68* **Author:** 
     69* **Last Modified by:** 
    7770* **Last Reviewed by:** Steve King **Date:** March 28, 2019 
    78 * **Source added by :** Steve King **Date:** March 25, 2019 
    7971""" 
    8072 
     
    10193    [Hayter-Penfold RMSA charged sphere interparticle S(Q) structure factor] 
    10294        Interparticle structure factor S(Q) for charged hard spheres. 
    103     This routine only works for charged particles! For uncharged particles  
    104     use the hardsphere S(q) instead. The "beta(q)" correction is available  
     95    This routine only works for charged particles! For uncharged particles 
     96    use the hardsphere S(q) instead. The "beta(q)" correction is available 
    10597    in versions 4.2.2 and higher. 
    10698""" 
     
    110102#             [ "name", "units", default, [lower, upper], "type", "description" ], 
    111103# 
    112 # NOTE: SMK, 28Mar19 The upper limit for charge is set to 200 to avoid instabilities noted by PK in  
    113 #       Ticket #1152. Also see the thread in Ticket 859. The docs above also note that charge=0 will  
     104# NOTE: SMK, 28Mar19 The upper limit for charge is set to 200 to avoid instabilities noted by PK in 
     105#       Ticket #1152. Also see the thread in Ticket 859. The docs above also note that charge=0 will 
    114106#       cause problems, yet the default parameters allowed it! After discussions with PK I have 
    115 #       changed it to (an arbitarily) small but non-zero value.  But I haven't changed the low limit  
     107#       changed it to (an arbitarily) small but non-zero value.  But I haven't changed the low limit 
    116108#       in function random() below. 
    117109# 
  • sasmodels/models/hollow_cylinder.py

    r0507e09 rc1e44e5  
    6262.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    6363 
    64 Source 
    65 ------ 
    66  
    67 `hollow_cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_cylinder.py>`_ 
    68  
    69 `hollow_cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_cylinder.c>`_ 
    70  
    7164Authorship and Verification 
    7265---------------------------- 
     
    7669   (corrected VR calculation) 
    7770* **Last Reviewed by:** Paul Butler **Date:** September 06, 2018 
    78 * **Source added by :** Steve King **Date:** March 25, 2019 
    7971""" 
    8072from __future__ import division 
  • sasmodels/models/hollow_rectangular_prism.py

    r0507e09 rc1e44e5  
    100100.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `hollow_rectangular_prism.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_rectangular_prism.py>`_ 
    106  
    107 `hollow_rectangular_prism.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_rectangular_prism.c>`_ 
    108  
    109102Authorship and Verification 
    110103---------------------------- 
     
    113106* **Last Modified by:** Paul Kienzle **Date:** December 14, 2017 
    114107* **Last Reviewed by:** Paul Butler **Date:** September 06, 2018 
    115 * **Source added by :** Steve King **Date:** March 25, 2019 
    116108""" 
    117109 
  • sasmodels/models/hollow_rectangular_prism_thin_walls.py

    r0507e09 rc1e44e5  
    7474.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    7575 
    76 Source 
    77 ------ 
    78  
    79 `hollow_rectangular_prism_thin_walls.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_rectangular_prism_thin_walls.py>`_ 
    80  
    81 `hollow_rectangular_prism_thin_walls.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/hollow_rectangular_prism_thin_walls.c>`_ 
    82  
    8376Authorship and Verification 
    8477---------------------------- 
     
    8780* **Last Modified by:** Paul Kienzle **Date:** October 15, 2016 
    8881* **Last Reviewed by:** Paul Butler **Date:** September 07, 2018 
    89 * **Source added by :** Steve King **Date:** March 25, 2019 
    9082""" 
    9183 
  • sasmodels/models/lamellar.py

    r0507e09 rc1e44e5  
    4343.. [#] J Berghausen, J Zipfel, P Lindner, W Richtering, *J. Phys. Chem. B*, 105, (2001) 11081-11088 
    4444 
    45 Source 
    46 ------ 
    47  
    48 `lamellar.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar.py>`_ 
    49  
    5045Authorship and Verification 
    5146---------------------------- 
    5247 
    53 * **Author:**  
    54 * **Last Modified by:**  
    55 * **Last Reviewed by:**  
    56 * **Source added by :** Steve King **Date:** March 25, 2019 
     48* **Author:** 
     49* **Last Modified by:** 
     50* **Last Reviewed by:** 
    5751""" 
    5852 
  • sasmodels/models/lamellar_hg.py

    r0507e09 rc1e44e5  
    4545.. [#] J Berghausen, J Zipfel, P Lindner, W Richtering, *J. Phys. Chem. B*, 105, (2001) 11081-11088 
    4646 
    47 Source 
    48 ------ 
    49  
    50 `lamellar_hg.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_hg.py>`_ 
    51  
    5247Authorship and Verification 
    5348---------------------------- 
    5449 
    55 * **Author:**  
    56 * **Last Modified by:**  
     50* **Author:** 
     51* **Last Modified by:** 
    5752* **Last Reviewed by:** S King and P Butler **Date** April 17, 2014 
    58 * **Source added by :** Steve King **Date:** March 25, 2019 
    5953""" 
    6054 
  • sasmodels/models/lamellar_hg_stack_caille.py

    r0507e09 rc1e44e5  
    7272.. [#] J Berghausen, J Zipfel, P Lindner, W Richtering, *J. Phys. Chem. B*, 105, (2001) 11081-11088 
    7373 
    74 Source 
    75 ------ 
    76  
    77 `lamellar_hg_stack_caille.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_hg_stack_caille.py>`_ 
    78  
    79 `lamellar_hg_stack_caille.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_hg_stack_caille.c>`_ 
    80  
    8174Authorship and Verification 
    8275---------------------------- 
    8376 
    84 * **Author:**  
    85 * **Last Modified by:**  
    86 * **Last Reviewed by:**  
    87 * **Source added by :** Steve King **Date:** March 25, 2019 
     77* **Author:** 
     78* **Last Modified by:** 
     79* **Last Reviewed by:** 
    8880""" 
    8981 
  • sasmodels/models/lamellar_stack_caille.py

    r0507e09 rc1e44e5  
    6868.. [#] J Berghausen, J Zipfel, P Lindner, W Richtering, *J. Phys. Chem. B*, 105, (2001) 11081-11088 
    6969 
    70 Source 
    71 ------ 
    72  
    73 `lamellar_stack_caille.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_stack_caille.py>`_ 
    74  
    75 `lamellar_stack_caille.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_stack_caille.c>`_ 
    76  
    7770Authorship and Verification 
    7871---------------------------- 
    7972 
    80 * **Author:**  
    81 * **Last Modified by:**  
    82 * **Last Reviewed by:**  
    83 * **Source added by :** Steve King **Date:** March 25, 2019 
     73* **Author:** 
     74* **Last Modified by:** 
     75* **Last Reviewed by:** 
    8476""" 
    8577 
  • sasmodels/models/lamellar_stack_paracrystal.py

    r0507e09 rc1e44e5  
    9090.. [#] M Bergstrom, J S Pedersen, P Schurtenberger, S U Egelhaaf, *J. Phys. Chem. B*, 103 (1999) 9888-9897 
    9191 
    92 Source 
    93 ------ 
    94  
    95 `lamellar_stack_paracrystal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_stack_paracrystal.py>`_ 
    96  
    97 `lamellar_stack_paracrystal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lamellar_stack_paracrystal.c>`_ 
    98  
    9992Authorship and Verification 
    10093---------------------------- 
    10194 
    102 * **Author:**  
    103 * **Last Modified by:**  
    104 * **Last Reviewed by:**  
    105 * **Source added by :** Steve King **Date:** March 25, 2019 
     95* **Author:** 
     96* **Last Modified by:** 
     97* **Last Reviewed by:** 
    10698""" 
    10799import numpy as np 
  • sasmodels/models/line.py

    r0507e09 rc1e44e5  
    2323None. 
    2424 
    25 Source 
    26 ------ 
    27  
    28 `line.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/line.py>`_ 
    29  
    3025Authorship and Verification 
    3126---------------------------- 
    3227 
    33 * **Author:**  
    34 * **Last Modified by:**  
    35 * **Last Reviewed by:**  
    36 * **Source added by :** Steve King **Date:** March 25, 2019""" 
     28* **Author:** 
     29* **Last Modified by:** 
     30* **Last Reviewed by:** 
     31""" 
    3732 
    3833import numpy as np 
  • sasmodels/models/linear_pearls.py

    r0507e09 rc1e44e5  
    3131.. [#] A V Dobrynin, M Rubinstein and S P Obukhov, *Macromol.*, 29 (1996) 2974-2979 
    3232 
    33 Source 
    34 ------ 
    35  
    36 `linear_pearls.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/linear_pearls.py>`_ 
    37  
    38 `linear_pearls.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/linear_pearls.c>`_ 
    39  
    4033Authorship and Verification 
    4134---------------------------- 
    4235 
    43 * **Author:**  
    44 * **Last Modified by:**  
    45 * **Last Reviewed by:**  
    46 * **Source added by :** Steve King **Date:** March 25, 2019""" 
     36* **Author:** 
     37* **Last Modified by:** 
     38* **Last Reviewed by:** 
     39""" 
    4740 
    4841import numpy as np 
  • sasmodels/models/lorentz.py

    r0507e09 rc1e44e5  
    2222.. [#] L.S. Qrnstein and F. Zernike, *Proc. Acad. Sci. Amsterdam* 17, 793 (1914), and *Z. Phys.* 19, 134 (1918), and 27, 761 {1926); referred to as QZ. 
    2323 
    24 Source 
    25 ------ 
    26  
    27 `lorentz.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/lorentz.py>`_ 
    28  
    2924Authorship and Verification 
    3025---------------------------- 
    3126 
    32 * **Author:**  
    33 * **Last Modified by:**  
    34 * **Last Reviewed by:**  
    35 * **Source added by :** Steve King **Date:** March 25, 2019""" 
     27* **Author:** 
     28* **Last Modified by:** 
     29* **Last Reviewed by:** 
     30""" 
    3631 
    3732import numpy as np 
  • sasmodels/models/mass_fractal.py

    r0507e09 rc1e44e5  
    5151.. [#] D Mildner and P Hall, *J. Phys. D: Appl. Phys.*, 19 (1986) 1535-1545 Equation(9) 
    5252 
    53 Source 
    54 ------ 
    55  
    56 `mass_fractal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mass_fractal.py>`_ 
    57  
    58 `mass_fractal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mass_fractal.c>`_ 
    59  
    6053Authorship and Verification 
    6154---------------------------- 
    6255 
    63 * **Author:**  
    64 * **Last Modified by:**  
    65 * **Last Reviewed by:**  
    66 * **Source added by :** Steve King **Date:** March 25, 2019""" 
     56* **Author:** 
     57* **Last Modified by:** 
     58* **Last Reviewed by:** 
     59""" 
    6760 
    6861import numpy as np 
  • sasmodels/models/mass_surface_fractal.py

    r0507e09 rc1e44e5  
    5555   35 (1987) 2361-2364 Equation(2) 
    5656 
    57 Source 
    58 ------ 
    59  
    60 `mass_surface_fractal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mass_surface_fractal.py>`_ 
    61  
    62 `mass_surface_fractal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mass_surface_fractal.c>`_ 
    63  
    6457Authorship and Verification 
    6558---------------------------- 
    6659 
    6760* **Author:** Piotr Rozyczko **Date:** Jan 20, 2016 
    68 * **Last Modified by:**  
     61* **Last Modified by:** 
    6962* **Last Reviewed by:** Richard Heenan **Date:** May 30, 2018 
    70 * **Source added by :** Steve King **Date:** March 25, 2019 
    7163""" 
    7264 
  • sasmodels/models/mono_gauss_coil.py

    r0507e09 rc1e44e5  
    4949.. [#] http://www.ncnr.nist.gov/staff/hammouda/distance_learning/chapter_28.pdf 
    5050 
    51 Source 
    52 ------ 
    53  
    54 `mono_gauss_coil.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mono_gauss_coil.py>`_ 
    55  
    56 `mono_gauss_coil.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/mono_gauss_coil.c>`_ 
    57  
    5851Authorship and Verification 
    5952---------------------------- 
    6053 
    61 * **Author:**  
    62 * **Last Modified by:**  
    63 * **Last Reviewed by:**  
    64 * **Source added by :** Steve King **Date:** March 25, 2019""" 
     54* **Author:** 
     55* **Last Modified by:** 
     56* **Last Reviewed by:** 
     57""" 
    6558 
    6659import numpy as np 
  • sasmodels/models/multilayer_vesicle.py

    r6607260 rc1e44e5  
    100100   R Zana and M Dekker, New York, (1987). 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `multilayer_vesicle.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/multilayer_vesicle.py>`_ 
    106  
    107 `multilayer_vesicle.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/multilayer_vesicle.c>`_ 
    108  
    109102Authorship and Verification 
    110103---------------------------- 
     
    114107* **Last Modified by:** Paul Kienzle **Date:** Feb 7, 2017 
    115108* **Last Reviewed by:** Steve King **Date:** March 28, 2019 
    116 * **Source added by :** Steve King **Date:** March 25, 2019 
    117109""" 
    118110 
  • sasmodels/models/onion.py

    r62dc889 rc1e44e5  
    88.. note:: 
    99 
    10     *radius* represents the core radius $r_0$ and *thickness[k]* represents  
     10    *radius* represents the core radius $r_0$ and *thickness[k]* represents 
    1111    the thickness of the shell, $r_{k+1} - r_k$. 
    1212 
     
    6060and the volume is $V(r) = \frac{4\pi}{3}r^3$. 
    6161 
    62 The volume of the particle is determined by the radius of the outer  
     62The volume of the particle is determined by the radius of the outer 
    6363shell, so $V_\text{particle} = V(r_N)$. 
    6464 
     
    104104    B&=\frac{\rho_\text{out} - \rho_\text{in}}{e^A-1} 
    105105         & C &= \frac{\rho_\text{in}e^A - \rho_\text{out}}{e^A-1} \\ 
    106           
     106 
    107107    \alpha_\text{in} &= A\frac{r_{\text{shell}-1}}{\Delta t_\text{shell}} 
    108108         & \alpha_\text{out} &= A\frac{r_\text{shell}}{\Delta t_\text{shell}} \\ 
    109           
     109 
    110110    \beta_\text{in} &= qr_{\text{shell}-1} 
    111111        & \beta_\text{out} &= qr_\text{shell} \\ 
     
    123123**Linear SLD profile** ($A \sim 0$): 
    124124 
    125 For small $A$, say, $A = -0.0001$, the function converges to that of of a linear  
     125For small $A$, say, $A = -0.0001$, the function converges to that of of a linear 
    126126SLD profile with 
    127127 
     
    159159**Constant SLD** ($A = 0$): 
    160160 
    161 When $A = 0$ the exponential function has no dependence on the radius (meaning  
     161When $A = 0$ the exponential function has no dependence on the radius (meaning 
    162162$\rho_\text{out}$ is ignored in this case) and becomes flat. We set the constant 
    163163to $\rho_\text{in}$ for convenience, and thus the form factor contributed by 
     
    187187.. [#] L A Feigin and D I Svergun, *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum Press, New York, 1987. 
    188188 
    189 Source 
    190 ------ 
    191  
    192 `onion.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/onion.py>`_ 
    193  
    194 `onion.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/onion.c>`_ 
    195  
    196189Authorship and Verification 
    197190---------------------------- 
    198191 
    199 * **Author:**  
    200 * **Last Modified by:**  
     192* **Author:** 
     193* **Last Modified by:** 
    201194* **Last Reviewed by:** Steve King **Date:** March 28, 2019 
    202 * **Source added by :** Steve King **Date:** March 25, 2019 
    203195""" 
    204196 
  • sasmodels/models/parallelepiped.py

    r0507e09 rc1e44e5  
    182182.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    183183 
    184 Source 
    185 ------ 
    186  
    187 `parallelepiped.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/parallelepiped.py>`_ 
    188  
    189 `parallelepiped.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/parallelepiped.c>`_ 
    190  
    191184Authorship and Verification 
    192185---------------------------- 
     
    196189* **Last Reviewed by:**  Miguel Gonzales and Paul Butler **Date:** May 24, 
    197190  2018 - documentation updated 
    198 * **Source added by :** Steve King **Date:** March 25, 2019 
    199191""" 
    200192 
  • sasmodels/models/peak_lorentz.py

    r0507e09 rc1e44e5  
    2727None. 
    2828 
    29 Source 
    30 ------ 
    31  
    32 `peak_lorentz.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/peak_lorentz.py>`_ 
    33  
    34 `peak_lorentz.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/peak_lorentz.c>`_ 
    35  
    3629Authorship and Verification 
    3730---------------------------- 
    3831 
    39 * **Author:**  
    40 * **Last Modified by:**  
    41 * **Last Reviewed by:**  
    42 * **Source added by :** Steve King **Date:** March 25, 2019 
     32* **Author:** 
     33* **Last Modified by:** 
     34* **Last Reviewed by:** 
    4335""" 
    4436 
  • sasmodels/models/pearl_necklace.py

    rc0136c72 rc1e44e5  
    5555.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    5656 
    57 Source 
    58 ------ 
    59  
    60 `pearl_necklace.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/pearl_necklace.py>`_ 
    61  
    62 `pearl_necklace.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/pearl_necklace.c>`_ 
    63  
    6457Authorship and Verification 
    6558---------------------------- 
     
    6861* **Last Modified by:** Andrew Jackson **Date:** March 28, 2019 
    6962* **Last Reviewed by:** Steve King **Date:** March 28, 2019 
    70 * **Source added by :** Steve King **Date:** March 25, 2019 
    7163""" 
    7264 
  • sasmodels/models/poly_gauss_coil.py

    r0507e09 rc1e44e5  
    4848.. [#] http://www.ncnr.nist.gov/staff/hammouda/distance_learning/chapter_28.pdf 
    4949 
    50 Source 
    51 ------ 
    52  
    53 `poly_gauss_coil.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/poly_gauss_coil.py>`_ 
    54  
    55 `poly_gauss_coil.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/poly_gauss_coil.c>`_ 
    56  
    5750Authorship and Verification 
    5851---------------------------- 
    5952 
    60 * **Author:**  
    61 * **Last Modified by:**  
    62 * **Last Reviewed by:**  
    63 * **Source added by :** Steve King **Date:** March 25, 2019 
     53* **Author:** 
     54* **Last Modified by:** 
     55* **Last Reviewed by:** 
    6456""" 
    6557 
  • sasmodels/models/polymer_excl_volume.py

    r0507e09 rc1e44e5  
    113113.. [#] B Hammouda & M-H Kim, *The empirical core-chain model* 247 (2017) 434-440 
    114114 
    115 Source 
    116 ------ 
    117  
    118 `polymer_excl_volume.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/polymer_excl_volume.py>`_ 
    119  
    120 `polymer_excl_volume.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/polymer_excl_volume.c>`_ 
    121  
    122115Authorship and Verification 
    123116---------------------------- 
    124117 
    125 * **Author:**  
    126 * **Last Modified by:**  
    127 * **Last Reviewed by:**  
    128 * **Source added by :** Steve King **Date:** March 25, 2019 
     118* **Author:** 
     119* **Last Modified by:** 
     120* **Last Reviewed by:** 
    129121""" 
    130122 
  • sasmodels/models/polymer_micelle.py

    r0507e09 rc1e44e5  
    7070.. [#] J Pedersen, *J. Appl. Cryst.*, 33 (2000) 637-640 
    7171 
    72 Source 
    73 ------ 
    74  
    75 `polymer_micelle.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/polymer_micelle.py>`_ 
    76  
    77 `polymer_micelle.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/polymer_micelle.c>`_ 
    78  
    7972Authorship and Verification 
    8073---------------------------- 
     
    8376* **Last modified by:** Paul Kienzle **Date:** November 29, 2017 
    8477* **Last reviewed by:** Steve King **Date:** November 30, 2017 
    85 * **Source added by :** Steve King **Date:** March 25, 2019 
    8678""" 
    8779 
  • sasmodels/models/porod.py

    r0507e09 rc1e44e5  
    2121.. [#] L A Feigin, D I Svergun, G W Taylor. *Structure Analysis by Small-Angle X-ray and Neutron Scattering*. Springer. (1987) 
    2222 
    23 Source 
    24 ------ 
    25  
    26 `porod.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/porod.py>`_ 
    27  
    2823Authorship and Verification 
    2924---------------------------- 
    3025 
    31 * **Author:**  
    32 * **Last Modified by:**  
    33 * **Last Reviewed by:**  
    34 * **Source added by :** Steve King **Date:** March 25, 2019 
     26* **Author:** 
     27* **Last Modified by:** 
     28* **Last Reviewed by:** 
    3529""" 
    3630 
  • sasmodels/models/power_law.py

    r0507e09 rc1e44e5  
    2626None. 
    2727 
    28 Source 
    29 ------ 
    30  
    31 `power_law.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/power_law.py>`_ 
    32  
    3328Authorship and Verification 
    3429---------------------------- 
    3530 
    36 * **Author:**  
    37 * **Last Modified by:**  
    38 * **Last Reviewed by:**  
    39 * **Source added by :** Steve King **Date:** March 25, 2019 
     31* **Author:** 
     32* **Last Modified by:** 
     33* **Last Reviewed by:** 
    4034""" 
    4135 
  • sasmodels/models/pringle.py

    r0507e09 rc1e44e5  
    4343.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    4444 
    45 Source 
    46 ------ 
    47  
    48 `pringle.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/pringle.py>`_ 
    49  
    50 `pringle.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/pringle.c>`_ 
    51  
    5245Authorship and Verification 
    5346---------------------------- 
     
    5649* **Last Modified by:** Wojciech Wpotrzebowski **Date:** March 20, 2016 
    5750* **Last Reviewed by:** Andrew Jackson **Date:** September 26, 2016 
    58 * **Source added by :** Steve King **Date:** March 25, 2019 
    5951""" 
    6052 
  • sasmodels/models/raspberry.py

    r0507e09 rc1e44e5  
    100100.. [#] K Larson-Smith, A Jackson, and D C Pozzo, *Small angle scattering model for Pickering emulsions and raspberry particles*, *Journal of Colloid and Interface Science*, 343(1) (2010) 36-41 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `raspberry.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/raspberry.py>`_ 
    106  
    107 `raspberry.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/raspberry.c>`_ 
    108  
    109102Authorship and Verification 
    110103---------------------------- 
     
    113106* **Last Modified by:** Andrew Jackson **Date:** March 20, 2016 
    114107* **Last Reviewed by:** Andrew Jackson **Date:** March 20, 2016 
    115 * **Source added by :** Steve King **Date:** March 25, 2019 
    116108""" 
    117109 
  • sasmodels/models/rectangular_prism.py

    r0507e09 rc1e44e5  
    100100.. [#] L. Onsager, *Ann. New York Acad. Sci.*, 51 (1949) 627-659 
    101101 
    102 Source 
    103 ------ 
    104  
    105 `rectangular_prism.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/rectangular_prism.py>`_ 
    106  
    107 `rectangular_prism.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/rectangular_prism.c>`_ 
    108  
    109102Authorship and Verification 
    110103---------------------------- 
    111104 
    112 * **Author:**  
    113 * **Last Modified by:**  
    114 * **Last Reviewed by:**  
    115 * **Source added by :** Steve King **Date:** March 25, 2019 
     105* **Author:** 
     106* **Last Modified by:** 
     107* **Last Reviewed by:** 
    116108""" 
    117109 
  • sasmodels/models/rpa.py

    r055ec4f rc1e44e5  
    3434that $R_g^2 = n b^2/6$ where $b$ is the statistical segment length and $n$ is 
    3535the number of statistical segment lengths. A nice tutorial on how these are 
    36 constructed and implemented can be found in chapters 28, 31 and 34, and Part H,  
     36constructed and implemented can be found in chapters 28, 31 and 34, and Part H, 
    3737of Hammouda's 'SANS Toolbox' [3]. 
    3838 
     
    6767.. [#] B. Hammouda, *SANS Toolbox* https://www.ncnr.nist.gov/staff/hammouda/the_sans_toolbox.pdf. 
    6868 
    69 Source 
    70 ------ 
    71  
    72 `rpa.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/rpa.py>`_ 
    73  
    74 `rpa.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/rpa.c>`_ 
    75  
    7669Authorship and Verification 
    7770---------------------------- 
     
    8174* **Last Modified by:** Paul Butler **Date:** March 12, 2017 
    8275* **Last Reviewed by:** Steve King **Date:** March 27, 2019 
    83 * **Source added by :** Steve King **Date:** March 25, 2019 
    8476""" 
    8577 
  • sasmodels/models/sc_paracrystal.py

    r0507e09 rc1e44e5  
    101101.. [#CIT1990] Hideki Matsuoka et. al. *Physical Review B*, 41 (1990) 3854 -3856 (Corrections to FCC and BCC lattice structure calculation) 
    102102 
    103 Source 
    104 ------ 
    105  
    106 `sc_paracrystal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sc_paracrystal.py>`_ 
    107  
    108 `sc_paracrystal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sc_paracrystal.c>`_ 
    109  
    110103Authorship and Verification 
    111104--------------------------- 
     
    114107* **Last Modified by:** Steve King **Date:** March 25, 2019 
    115108* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016 
    116 * **Source added by :** Steve King **Date:** March 25, 2019 
    117109""" 
    118110 
  • sasmodels/models/sphere.py

    r0507e09 rc1e44e5  
    3939.. [#] A Guinier and G. Fournet, *Small-Angle Scattering of X-Rays*, John Wiley and Sons, New York, (1955) 
    4040 
    41 Source 
    42 ------ 
    43  
    44 `sphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sphere.py>`_ 
    45  
    46 `sphere.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sphere.c>`_ 
    47  
    4841Authorship and Verification 
    4942---------------------------- 
    5043 
    51 * **Author:**  
    52 * **Last Modified by:**  
     44* **Author:** 
     45* **Last Modified by:** 
    5346* **Last Reviewed by:** S King and P Parker **Date:** 2013/09/09 and 2014/01/06 
    54 * **Source added by :** Steve King **Date:** March 25, 2019 
    5547""" 
    5648 
  • sasmodels/models/spherical_sld.py

    r0507e09 rc1e44e5  
    186186   and Neutron Scattering, Plenum Press, New York, (1987) 
    187187 
    188 Source 
    189 ------ 
    190  
    191 `spherical_sld.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/spherical_sld.py>`_ 
    192  
    193 `spherical_sld.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/spherical_sld.c>`_ 
    194  
    195188Authorship and Verification 
    196189---------------------------- 
     
    199192* **Last Modified by:** Paul Kienzle **Date:** Dec 20, 2016 
    200193* **Last Reviewed by:** Paul Butler **Date:** September 8, 2018 
    201 * **Source added by :** Steve King **Date:** March 25, 2019 
    202194""" 
    203195 
  • sasmodels/models/spinodal.py

    r0507e09 rc1e44e5  
    4444.. [#] T. Hashimoto, M. Takenaka & H. Jinnai. Scattering Studies of Self-Assembling Processes of Polymer Blends in Spinodal Decomposition. J. Appl. Cryst. 24, 457-466 (1991). 
    4545 
    46 Source 
    47 ------ 
    48  
    49 `spinodal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/spinodal.py>`_ 
    50  
    5146Authorship and Verification 
    5247---------------------------- 
     
    5550* **Last Modified by:** Steve King **Date:** Oct 25, 2018 
    5651* **Last Reviewed by:** Steve King **Date:** Oct 25, 2018 
    57 * **Source added by :** Steve King **Date:** March 25, 2019 
    5852""" 
    5953 
  • sasmodels/models/squarewell.py

    r5f3c534 rc1e44e5  
    11# Note: model title and parameter table are inserted automatically 
    22r""" 
    3 Calculates the interparticle structure factor for a hard sphere fluid  
    4 with a narrow, attractive, square well potential. **The Mean Spherical  
    5 Approximation (MSA) closure relationship is used, but it is not the most  
    6 appropriate closure for an attractive interparticle potential.** However,  
    7 the solution has been compared to Monte Carlo simulations for a square  
    8 well fluid and these show the MSA calculation to be limited to well  
     3Calculates the interparticle structure factor for a hard sphere fluid 
     4with a narrow, attractive, square well potential. **The Mean Spherical 
     5Approximation (MSA) closure relationship is used, but it is not the most 
     6appropriate closure for an attractive interparticle potential.** However, 
     7the solution has been compared to Monte Carlo simulations for a square 
     8well fluid and these show the MSA calculation to be limited to well 
    99depths $\epsilon < 1.5$ kT and volume fractions $\phi < 0.08$. 
    1010 
    1111Positive well depths correspond to an attractive potential well. Negative 
    1212well depths correspond to a potential "shoulder", which may or may not be 
    13 physically reasonable. The :ref:`stickyhardsphere` model may be a better  
     13physically reasonable. The :ref:`stickyhardsphere` model may be a better 
    1414choice in some circumstances. 
    1515 
     
    1818.. note:: 
    1919 
    20    Earlier versions of SasView did not incorporate the so-called  
    21    $\beta(q)$ ("beta") correction [2] for polydispersity and non-sphericity.  
     20   Earlier versions of SasView did not incorporate the so-called 
     21   $\beta(q)$ ("beta") correction [2] for polydispersity and non-sphericity. 
    2222   This is only available in SasView versions 4.2.2 and higher. 
    2323 
     
    5454.. [#] M Kotlarchyk and S-H Chen, *J. Chem. Phys.*, 79 (1983) 2461-2469 
    5555 
    56 Source 
    57 ------ 
    58  
    59 `squarewell.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/squarewell.py>`_ 
    60  
    6156Authorship and Verification 
    6257---------------------------- 
    6358 
    64 * **Author:**  
    65 * **Last Modified by:**  
     59* **Author:** 
     60* **Last Modified by:** 
    6661* **Last Reviewed by:** Steve King **Date:** March 27, 2019 
    67 * **Source added by :** Steve King **Date:** March 25, 2019 
    6862""" 
    6963 
     
    7569description = """\ 
    7670    [Square well structure factor, with MSA closure] 
    77         Interparticle structure factor S(Q) for a hard sphere fluid  
     71        Interparticle structure factor S(Q) for a hard sphere fluid 
    7872    with a narrow attractive well. Fits are prone to deliver non- 
    79     physical parameters; use with care and read the references in  
    80     the model documentation.The "beta(q)" correction is available  
     73    physical parameters; use with care and read the references in 
     74    the model documentation.The "beta(q)" correction is available 
    8175    in versions 4.2.2 and higher. 
    8276""" 
  • sasmodels/models/stacked_disks.py

    r0507e09 rc1e44e5  
    102102   John Wiley and Sons, New York, 1955 
    103103 
    104 Source 
    105 ------ 
    106  
    107 `stacked_disks.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/stacked_disks.py>`_ 
    108  
    109 `stacked_disks.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/stacked_disks.c>`_ 
    110  
    111104Authorship and Verification 
    112105---------------------------- 
     
    115108* **Last Modified by:** Paul Butler and Paul Kienzle **Date:** November 26, 2016 
    116109* **Last Reviewed by:** Paul Butler and Paul Kienzle **Date:** November 26, 2016 
    117 * **Source added by :** Steve King **Date:** March 25, 2019 
    118110""" 
    119111 
  • sasmodels/models/star_polymer.py

    r0507e09 rc1e44e5  
    5050   B Ewen *Macromolecules*, 22, 468-472 (1989) 
    5151 
    52 Source 
    53 ------ 
    54  
    55 `star_polymer.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/star_polymer.py>`_ 
    56  
    57 `star_polymer.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/star_polymer.c>`_ 
    58  
    5952Authorship and Verification 
    6053---------------------------- 
     
    6356* **Last Modified by:** Paul Butler **Date:** Auguts 26, 2017 
    6457* **Last Reviewed by:** Ziang Li and Richard Heenan **Date:** May 17, 2017 
    65 * **Source added by :** Steve King **Date:** March 25, 2019 
    6658""" 
    6759 
  • sasmodels/models/stickyhardsphere.py

    r5f3c534 rc1e44e5  
    11# Note: model title and parameter table are inserted automatically 
    22r""" 
    3 Calculates the interparticle structure factor for a hard sphere fluid  
    4 with a narrow, attractive, potential well. Unlike the :ref:`squarewell`  
    5 model, here a perturbative solution of the Percus-Yevick closure  
    6 relationship is used. The strength of the attractive well is described  
     3Calculates the interparticle structure factor for a hard sphere fluid 
     4with a narrow, attractive, potential well. Unlike the :ref:`squarewell` 
     5model, here a perturbative solution of the Percus-Yevick closure 
     6relationship is used. The strength of the attractive well is described 
    77in terms of "stickiness" as defined below. 
    88 
    99The perturbation parameter (perturb), $\tau$, should be fixed between 0.01 
    10 and 0.1 and the "stickiness", $\epsilon$, allowed to vary to adjust the  
    11 interaction strength. The "stickiness" is defined in the equation below and is  
    12 a function of both the perturbation parameter and the interaction strength.  
    13 $\epsilon$ and $\tau$ are defined in terms of the hard sphere diameter $(\sigma = 2 R)$,  
    14 the width of the square well, $\Delta$ (having the same units as $R$\ ),  
    15 and the depth of the well, $U_o$, in units of $kT$. From the definition, it  
     10and 0.1 and the "stickiness", $\epsilon$, allowed to vary to adjust the 
     11interaction strength. The "stickiness" is defined in the equation below and is 
     12a function of both the perturbation parameter and the interaction strength. 
     13$\epsilon$ and $\tau$ are defined in terms of the hard sphere diameter $(\sigma = 2 R)$, 
     14the width of the square well, $\Delta$ (having the same units as $R$\ ), 
     15and the depth of the well, $U_o$, in units of $kT$. From the definition, it 
    1616is clear that smaller $\epsilon$ means a stronger attraction. 
    1717 
     
    3737 
    3838The true particle volume fraction, $\phi$, is not equal to $h$ which appears 
    39 in most of reference [1]. The two are related in equation (24). Reference  
    40 [1] also describes the relationship between this perturbative solution and  
     39in most of reference [1]. The two are related in equation (24). Reference 
     40[1] also describes the relationship between this perturbative solution and 
    4141the original sticky hard sphere (or "adhesive sphere") model of Baxter [2]. 
    4242 
     
    4747   reported to the command window and $S(q)$ is set to -1 (so it will 
    4848   disappear on a log-log plot!). 
    49     
    50    Use tight bounds to keep the parameters to values that you know are  
    51    physical (test them), and keep nudging them until the optimization  
     49 
     50   Use tight bounds to keep the parameters to values that you know are 
     51   physical (test them), and keep nudging them until the optimization 
    5252   does not hit the constraints. 
    5353 
    5454.. note:: 
    5555 
    56    Earlier versions of SasView did not incorporate the so-called  
    57    $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity.  
     56   Earlier versions of SasView did not incorporate the so-called 
     57   $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity. 
    5858   This is only available in SasView versions 4.2.2 and higher. 
    59     
     59 
    6060In SasView the effective radius may be calculated from the parameters 
    6161used in the form factor $P(q)$ that this $S(q)$ is combined with. 
     
    7878.. [#] M Kotlarchyk and S-H Chen, *J. Chem. Phys.*, 79 (1983) 2461-2469 
    7979 
    80 Source 
    81 ------ 
    82  
    83 `stickyhardsphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/stickyhardsphere.py>`_ 
    84  
    8580Authorship and Verification 
    8681---------------------------- 
    8782 
    88 * **Author:**  
    89 * **Last Modified by:**  
     83* **Author:** 
     84* **Last Modified by:** 
    9085* **Last Reviewed by:** Steve King **Date:** March 27, 2019 
    91 * **Source added by :** Steve King **Date:** March 25, 2019 
    9286""" 
    9387 
     
    10195description = """\ 
    10296    [Sticky hard sphere structure factor, with Percus-Yevick closure] 
    103         Interparticle structure factor S(Q) for a hard sphere fluid  
     97        Interparticle structure factor S(Q) for a hard sphere fluid 
    10498    with a narrow attractive well. Fits are prone to deliver non- 
    105     physical parameters; use with care and read the references in  
    106     the model documentation.The "beta(q)" correction is available  
     99    physical parameters; use with care and read the references in 
     100    the model documentation.The "beta(q)" correction is available 
    107101    in versions 4.2.2 and higher. 
    108102""" 
  • sasmodels/models/surface_fractal.py

    r0507e09 rc1e44e5  
    3838.. [#] D Mildner and P Hall, *J. Phys. D: Appl. Phys.*, 19 (1986) 1535-1545 
    3939 
    40 Source 
    41 ------ 
    42  
    43 `surface_fractal.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/surface_fractal.py>`_ 
    44  
    45 `surface_fractal.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/surface_fractal.c>`_ 
    46  
    4740Authorship and Verification 
    4841---------------------------- 
    4942 
    50 * **Author:**  
    51 * **Last Modified by:**  
    52 * **Last Reviewed by:**  
    53 * **Source added by :** Steve King **Date:** March 25, 2019 
     43* **Author:** 
     44* **Last Modified by:** 
     45* **Last Reviewed by:** 
    5446""" 
    5547 
  • sasmodels/models/teubner_strey.py

    r0507e09 rc1e44e5  
    6565.. [#] H Endo, M Mihailescu, M. Monkenbusch, J Allgaier, G Gompper, D Richter, B Jakobs, T Sottmann, R Strey, and I Grillo, *J. Chem. Phys.*, 115 (2001), 580 
    6666 
    67 Source 
    68 ------ 
    69  
    70 `teubner_strey.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/teubner_strey.py>`_ 
    71  
    72 `teubner_strey.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/teubner_strey.c>`_ 
    73  
    7467Authorship and Verification 
    7568---------------------------- 
    7669 
    77 * **Author:**  
    78 * **Last Modified by:**  
    79 * **Last Reviewed by:**  
    80 * **Source added by :** Steve King **Date:** March 25, 2019 
     70* **Author:** 
     71* **Last Modified by:** 
     72* **Last Reviewed by:** 
    8173""" 
    8274from __future__ import division 
  • sasmodels/models/triaxial_ellipsoid.py

    r0507e09 rc1e44e5  
    116116.. [#] Finnigan, J.A., Jacobs, D.J., 1971. *Light scattering by ellipsoidal particles in solution*, J. Phys. D: Appl. Phys. 4, 72-77. doi:10.1088/0022-3727/4/1/310 
    117117 
    118 Source 
    119 ------ 
    120  
    121 `triaxial_ellipsoid.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/triaxial_ellipsoid.py>`_ 
    122  
    123 `triaxial_ellipsoid.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/triaxial_ellipsoid.c>`_ 
    124  
    125118Authorship and Verification 
    126119---------------------------- 
     
    129122* **Last Modified by:** Paul Kienzle (improved calculation) **Date:** April 4, 2017 
    130123* **Last Reviewed by:** Paul Kienzle & Richard Heenan **Date:**  April 4, 2017 
    131 * **Source added by :** Steve King **Date:** March 25, 2019 
    132124""" 
    133125 
  • sasmodels/models/two_lorentzian.py

    r0507e09 rc1e44e5  
    2727None. 
    2828 
    29 Source 
    30 ------ 
    31  
    32 `two_lorentzian.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/two_lorentzian.py>`_ 
    33  
    3429Authorship and Verification 
    3530---------------------------- 
     
    3833* **Last Modified by:** Piotr rozyczko **Date:** January 29, 2016 
    3934* **Last Reviewed by:** Paul Butler **Date:** March 21, 2016 
    40 * **Source added by :** Steve King **Date:** March 25, 2019 
    4135""" 
    4236 
  • sasmodels/models/two_power_law.py

    r0507e09 rc1e44e5  
    3737None. 
    3838 
    39 Source 
    40 ------ 
    41  
    42 `two_power_law.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/two_power_law.py>`_ 
    43  
    4439Authorship and Verification 
    4540---------------------------- 
     
    4843* **Last Modified by:** Wojciech Wpotrzebowski **Date:** February 18, 2016 
    4944* **Last Reviewed by:** Paul Butler **Date:** March 21, 2016 
    50 * **Source added by :** Steve King **Date:** March 25, 2019 
    5145""" 
    5246 
  • sasmodels/models/unified_power_rg.py

    r7a5f8af rc1e44e5  
    6767.. [#] B Hammouda, *Analysis of the Beaucage model, J. Appl. Cryst.*, (2010), 43, 1474-1478 
    6868 
    69 Source 
    70 ------ 
    71  
    72 `unified_power_rg.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/unified_power_rg.py>`_ 
    73  
    7469Authorship and Verification 
    7570---------------------------- 
    7671 
    77 * **Author:**  
    78 * **Last Modified by:**  
    79 * **Last Reviewed by:**  
    80 * **Source added by :** Steve King **Date:** March 25, 2019 
     72* **Author:** 
     73* **Last Modified by:** 
     74* **Last Reviewed by:** 
    8175""" 
    8276 
  • sasmodels/models/vesicle.py

    r0507e09 rc1e44e5  
    6060   Sons, New York, (1955) 
    6161 
    62 Source 
    63 ------ 
    64  
    65 `vesicle.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/vesicle.py>`_ 
    66  
    67 `vesicle.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/vesicle.c>`_ 
    68  
    6962Authorship and Verification 
    7063---------------------------- 
     
    7366* **Last Modified by:** Paul Butler **Date:** March 20, 2016 
    7467* **Last Reviewed by:** Paul Butler **Date:** September 7, 2018 
    75 * **Source added by :** Steve King **Date:** March 25, 2019 
    7668""" 
    7769 
Note: See TracChangeset for help on using the changeset viewer.