| 1 | """ |
|---|
| 2 | Real-Space Modeling for SANS |
|---|
| 3 | """ |
|---|
| 4 | ## \mainpage Real-Space Modeling for SANS |
|---|
| 5 | # |
|---|
| 6 | # \section intro_sec Introduction |
|---|
| 7 | # This module provides SANS scattering intensity simulation |
|---|
| 8 | # based on real-space modeling. |
|---|
| 9 | # |
|---|
| 10 | # Documentation can be found here: |
|---|
| 11 | # http://danse.us/trac/sans/wiki/RealSpaceModeling |
|---|
| 12 | # |
|---|
| 13 | # \section install_sec Installation |
|---|
| 14 | # |
|---|
| 15 | # \subsection obtain Obtaining the Code |
|---|
| 16 | # |
|---|
| 17 | # The code is available here: |
|---|
| 18 | # \verbatim |
|---|
| 19 | #$ svn co svn://danse.us/sans/realSpaceModeling |
|---|
| 20 | #$ svn co svn://danse.us/sans/RealSpaceTopLayer |
|---|
| 21 | # \endverbatim |
|---|
| 22 | # |
|---|
| 23 | # \subsection depends External Dependencies |
|---|
| 24 | # None |
|---|
| 25 | # |
|---|
| 26 | # \subsection build Building the code |
|---|
| 27 | # The standard python package can be built with distutils. |
|---|
| 28 | # From the realSpaceModeling directory: |
|---|
| 29 | # \verbatim |
|---|
| 30 | #$ python setup.py install |
|---|
| 31 | # \endverbatim |
|---|
| 32 | # |
|---|
| 33 | # From the RealSpaceTopLayer/src directory: |
|---|
| 34 | # \verbatim |
|---|
| 35 | #$ python setup.py install |
|---|
| 36 | # \endverbatim |
|---|
| 37 | # |
|---|
| 38 | # \section overview_sec Package Overview |
|---|
| 39 | # |
|---|
| 40 | # \subsection class Class Diagram: |
|---|
| 41 | # \image html real-space-class-diagram.png |
|---|
| 42 | # |
|---|
| 43 | # \subsection behav Behavior Enumeration: |
|---|
| 44 | # \image html enum.gif |
|---|
| 45 | # |
|---|
| 46 | # \subsection Tutorial |
|---|
| 47 | # To create an empty canvas: |
|---|
| 48 | # \verbatim |
|---|
| 49 | #import sans.realspace.VolumeCanvas as VolumeCanvas |
|---|
| 50 | # canvas = VolumeCanvas.VolumeCanvas() |
|---|
| 51 | # \endverbatim |
|---|
| 52 | # |
|---|
| 53 | # To set the simulation point density: |
|---|
| 54 | # \verbatim |
|---|
| 55 | # canvas.setParam('lores_density', 0.01) |
|---|
| 56 | # \endverbatim |
|---|
| 57 | # |
|---|
| 58 | # To add an object: |
|---|
| 59 | # \verbatim |
|---|
| 60 | # sphare = VolumeCanvas.SphereDescriptor() |
|---|
| 61 | # handle = canvas.addObject(sphere) |
|---|
| 62 | # canvas.setParam('%s.radius' % handle, 15.0) |
|---|
| 63 | # \endverbatim |
|---|
| 64 | # |
|---|
| 65 | # To evaluate the scattering intensity at a given q: |
|---|
| 66 | # \verbatim |
|---|
| 67 | # output, error = canvas.getIqError(q=0.1) |
|---|
| 68 | # output, error = canvas.getIq2DError(qx=0.1, qy=0.1) |
|---|
| 69 | # \endverbatim |
|---|
| 70 | # |
|---|
| 71 | # To get the value of a parameter: |
|---|
| 72 | # \verbatim |
|---|
| 73 | # canvas.getParam('scale') |
|---|
| 74 | # \endverbatim |
|---|
| 75 | # |
|---|
| 76 | # Examples are available as unit tests under sans.realspace.test. |
|---|
| 77 | # |
|---|
| 78 | # \section help_sec Contact Info |
|---|
| 79 | # Code and Documentation by Jing Zhou as part of the DANSE project. |
|---|
| 80 | |
|---|
