source: sasview/pr_inversion/__init__.py @ dfb58f8

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 dfb58f8 was 9a11937, checked in by Mathieu Doucet <doucetm@…>, 16 years ago

Added documentation

  • Property mode set to 100644
File size: 1.5 KB
Line 
1"""
2    P(r) inversion for SANS
3"""
4## \mainpage P(r) inversion for SANS
5#
6# \section intro_sec Introduction
7# This module provides calculations to transform scattering intensity data
8# I(q) into distance distribution function P(r). A description of the
9# technique can be found elsewhere [1-5]. The module is useable as a
10# standalone application but its functionality is meant to be presented
11# to end-users through the user interface developed as part of the SANS
12# flagship application.
13#
14# Procedure: We will follow the procedure of Moore [1].
15#
16# [1] P.B. Moore, J.Appl. Cryst (1980) 13, 168-175.
17# [2] O. Glatter, J.Appl. Cryst (1977) 10, 415-421.
18# [3] D.I. Svergun, J.Appl. Cryst (1991) 24, 485-492.
19# [4] D.I. Svergun, J.Appl. Cryst (1992) 25, 495-503.
20# [5] S. Hansen and J. Skov Pedersen, J.Appl. Cryst (1991) 24, 541-548.
21#
22#
23# \section install_sec Installation
24#
25# \subsection obtain Obtaining the Code
26#
27# The code is available here:
28# \verbatim
29#$ svn co svn://danse.us/sans/pr_inversion
30# \endverbatim
31#
32# \subsection depends External Dependencies
33# scipy, numpy, pylab
34#
35# \subsection build Building the code
36# The standard python package can be built with distutils.
37# \verbatim
38#$ python setup.py build
39#$ python setup.py install
40# \endverbatim
41#
42#
43# Examples are available as unit tests under sans.pr_inversion.test.
44#
45# \section help_sec Contact Info
46# Code and Documentation produced as part of the DANSE project.
47
48__author__ = 'University of Tennessee'
Note: See TracBrowser for help on using the repository browser.