source: sasview/sansmodels/src/sans/models/__init__.py @ fb8d4050

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 fb8d4050 was ae3ce4e, checked in by Mathieu Doucet <doucetm@…>, 17 years ago

Moving sansmodels to trunk

  • Property mode set to 100644
File size: 1.9 KB
Line 
1"""
2    1D Modeling for SANS
3"""
4## \mainpage Analytical Modeling for SANS
5#
6# \section intro_sec Introduction
7# This module provides theoretical models for the scattering
8# intensity for SANS.
9#
10# Documentation can be found here:
11#    http://danse.us/trac/sans/wiki/8_2_2_1DModelFitting
12#    http://danse.us/trac/sans/wiki/8_2_3_2DModeling
13#
14# \section install_sec Installation
15#
16# \subsection obtain Obtaining the Code
17#
18# The code is available here:
19# \verbatim
20#$ svn co svn://danse.us/sans/sansmodels
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# \verbatim
29#$ python setup.py build
30#$ python setup.py install
31# \endverbatim
32#
33# \section overview_sec Package Overview
34#
35# \subsection class Class Diagram:
36# \image html class_diag.png
37# Note that the CCylinderModel is written as C code.
38# CylinderModel acts as an adaptor class for the C extension.
39# Most model classes will be written that way.
40#
41# \subsection behav Behavior enumeration for pyre-level architecture:
42# \image html behavior_pyre.png
43#
44# \subsection behav Behavior enumeration for under-lying architecture:
45# \image html behavior.jpg
46#
47# \subsection Tutorial
48# To create a model:
49# \verbatim
50#from sans.models.ModelFactory import ModelFactory
51#    cyl = ModelFactory().getModel('CylinderModel')
52# \endverbatim
53#
54# To evaluate a model (at x=0.1 in this example):
55# \verbatim
56#    output = cyl.run(0.1)
57# \endverbatim
58#
59# To change a parameter:
60# \verbatim
61#    cyl.setParam('scale', 0.1)
62# \endverbatim
63#
64# To get the value of a parameter:
65# \verbatim
66#    cyl.getParam('scale')
67# \endverbatim
68#
69# Other examples are available as unit tests under sans.models.test.
70#
71# \section help_sec Contact Info
72# Code and Documentation by Mathieu Doucet as part of the DANSE project.
73
74__author__ = 'Mathieu Doucet'
Note: See TracBrowser for help on using the repository browser.