source: sasview/sansrealspace/src/realspace/__init__.py @ 8c050c1

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 8c050c1 was 1141c5d, checked in by Mathieu Doucet <doucetm@…>, 17 years ago

SVN commit test

  • Property mode set to 100644
File size: 2.0 KB
Line 
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# You have to have the DANSE distutils-adpt package installed:
25# \verbatime
26#$ svn co svn://danse.us/distutils-adpt
27# \endverbatim
28#
29# \subsection build Building the code
30# The standard python package can be built with distutils.
31# From the realSpaceModeling directory:
32# \verbatim
33#$ python setup.py install
34# \endverbatim
35#
36# From the RealSpaceTopLayer/src directory:
37# \verbatim
38#$ python setup.py install
39# \endverbatim
40#
41# \section overview_sec Package Overview
42#
43# \subsection class Class Diagram:
44# \image html real-space-class-diagram.png
45#
46# \subsection behav Behavior Enumeration:
47# \image html enum.gif
48#
49# \subsection Tutorial
50# To create an empty canvas:
51# \verbatim
52#import sans.realspace.VolumeCanvas as VolumeCanvas
53#    canvas = VolumeCanvas.VolumeCanvas()
54# \endverbatim
55#
56# To set the simulation point density:
57# \verbatim
58#    canvas.setParam('lores_density', 0.01)
59# \endverbatim
60#
61# To add an object:
62# \verbatim
63#    handle = canvas.add('sphere')
64#    canvas.setParam('%s.radius' % handle, 15.0)
65# \endverbatim
66#
67# To evaluate the scattering intensity at a given q:
68# \verbatim
69#    output, error = canvas.getIqError(q=0.1)
70# \endverbatim
71#
72# To get the value of a parameter:
73# \verbatim
74#    canvas.getParam('scale')
75# \endverbatim
76#
77# Examples are available as unit tests under sans.realspace.test.
78#
79# \section help_sec Contact Info
80# Code and Documentation by Jing Zhou as part of the DANSE project.
81
Note: See TracBrowser for help on using the repository browser.