Changeset 755ecc2 in sasmodels


Ignore:
Timestamp:
Nov 26, 2016 8:26:38 PM (3 years ago)
Author:
butler
Branches:
master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests
Children:
5810f00
Parents:
2d73a53
Message:

Update documentation to meet standards. addresses #646

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sasmodels/models/core_shell_cylinder.py

    r40a87fa r755ecc2  
    1 # core shell cylinder model 
    2 # Note: model title and parameter table are inserted automatically 
    31r""" 
    4 The form factor is normalized by the particle volume. 
    5  
    62Definition 
    73---------- 
    84 
    95The output of the 2D scattering intensity function for oriented core-shell 
    10 cylinders is given by (Kline, 2006) 
     6cylinders is given by (Kline, 2006 [#kline]_). The form factor is normalized 
     7by the particle volume. 
    118 
    129.. math:: 
     
    6158The $\theta$ and $\phi$ parameters are not used for the 1D output. 
    6259 
    63 Validation 
    64 ---------- 
    65  
    66 Validation of our code was done by comparing the output of the 1D model to 
    67 the output of the software provided by the NIST (Kline, 2006). 
    68  
    69 Averaging over a distribution of orientation is done by evaluating the 
    70 equation above. Since we have no other software to compare the 
    71 implementation of the intensity for fully oriented cylinders, we 
    72 compared the result of averaging our 2D output using a uniform 
    73 distribution $p(\theta,\phi) = 1.0$. 
    74  
    7560Reference 
    7661--------- 
    77 see, for example, Ian Livsey  J. Chem. Soc., Faraday Trans. 2, 1987,83, 1445-1452 
    7862 
    79 2016/03/18 - Description reviewed by RKH 
     63.. [#] see, for example, Ian Livsey  J. Chem. Soc., Faraday Trans. 2, 1987,83, 
     64   1445-1452 
     65.. [#kline] S R Kline, *J Appl. Cryst.*, 39 (2006) 895 
     66 
     67Authorship and Verification 
     68---------------------------- 
     69 
     70* **Author:** NIST IGOR/DANSE **Date:** pre 2010 
     71* **Last Modified by:** Paul Kienzle **Date:** Aug 8, 2016 
     72* **Last Reviewed by:** Richard Heenan **Date:** March 18, 2016 
    8073""" 
    8174 
     
    158151            theta_pd=15, theta_pd_n=45, 
    159152            phi_pd=15, phi_pd_n=1) 
    160 # ADDED by:  RKH  ON: 18Mar2016 renamed sld's etc 
     153 
Note: See TracChangeset for help on using the changeset viewer.