source: sasview/sansmodels/docs/sphinx/html/index.html @ 5548954

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 5548954 was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 15.2 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>Welcome to sansmodels’s documentation! &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="#" />
29    <link rel="next" title="Reference" href="api/index.html" /> 
30  </head>
31  <body>
32    <div class="related">
33      <h3>Navigation</h3>
34      <ul>
35        <li class="right" style="margin-right: 10px">
36          <a href="genindex.html" title="General Index"
37             accesskey="I">index</a></li>
38        <li class="right" >
39          <a href="py-modindex.html" title="Python Module Index"
40             >modules</a> |</li>
41        <li class="right" >
42          <a href="api/index.html" title="Reference"
43             accesskey="N">next</a> |</li>
44        <li><a href="#">sansmodels 0.1.0 documentation</a> &raquo;</li> 
45      </ul>
46    </div> 
47
48    <div class="document">
49      <div class="documentwrapper">
50        <div class="bodywrapper">
51          <div class="body">
52           
53  <div class="section" id="welcome-to-sansmodels-s-documentation">
54<h1>Welcome to sansmodels&#8217;s documentation!<a class="headerlink" href="#welcome-to-sansmodels-s-documentation" title="Permalink to this headline">¶</a></h1>
55<p>Contents:</p>
56<div class="toctree-wrapper compound">
57<ul>
58<li class="toctree-l1"><a class="reference internal" href="api/index.html">Reference</a><ul>
59<li class="toctree-l2"><a class="reference internal" href="api/AddComponent.html">AddComponent</a></li>
60<li class="toctree-l2"><a class="reference internal" href="api/BarBellModel.html">BarBellModel</a></li>
61<li class="toctree-l2"><a class="reference internal" href="api/BaseComponent.html">BaseComponent</a></li>
62<li class="toctree-l2"><a class="reference internal" href="api/BaseModel.html">BaseModel</a></li>
63<li class="toctree-l2"><a class="reference internal" href="api/BCCrystalModel.html">BCCrystalModel</a></li>
64<li class="toctree-l2"><a class="reference internal" href="api/BEPolyelectrolyte.html">BEPolyelectrolyte</a></li>
65<li class="toctree-l2"><a class="reference internal" href="api/BinaryHSModel.html">BinaryHSModel</a></li>
66<li class="toctree-l2"><a class="reference internal" href="api/BinaryHSPSF11Model.html">BinaryHSPSF11Model</a></li>
67<li class="toctree-l2"><a class="reference internal" href="api/BroadPeakModel.html">BroadPeakModel</a></li>
68<li class="toctree-l2"><a class="reference internal" href="api/CappedCylinderModel.html">CappedCylinderModel</a></li>
69<li class="toctree-l2"><a class="reference internal" href="api/Constant.html">Constant</a></li>
70<li class="toctree-l2"><a class="reference internal" href="api/CoreFourShellModel.html">CoreFourShellModel</a></li>
71<li class="toctree-l2"><a class="reference internal" href="api/CoreMultiShellModel.html">CoreMultiShellModel</a></li>
72<li class="toctree-l2"><a class="reference internal" href="api/CoreShellCylinderModel.html">CoreShellCylinderModel</a></li>
73<li class="toctree-l2"><a class="reference internal" href="api/CoreShellEllipsoidModel.html">CoreShellEllipsoidModel</a></li>
74<li class="toctree-l2"><a class="reference internal" href="api/CoreShellModel.html">CoreShellModel</a></li>
75<li class="toctree-l2"><a class="reference internal" href="api/CorrLengthModel.html">CorrLengthModel</a></li>
76<li class="toctree-l2"><a class="reference internal" href="api/Cos.html">Cos</a></li>
77<li class="toctree-l2"><a class="reference internal" href="api/CSParallelepipedModel.html">CSParallelepipedModel</a></li>
78<li class="toctree-l2"><a class="reference internal" href="api/CylinderModel.html">CylinderModel</a></li>
79<li class="toctree-l2"><a class="reference internal" href="api/DABModel.html">DABModel</a></li>
80<li class="toctree-l2"><a class="reference internal" href="api/DebyeModel.html">DebyeModel</a></li>
81<li class="toctree-l2"><a class="reference internal" href="api/DiamCylFunc.html">DiamCylFunc</a></li>
82<li class="toctree-l2"><a class="reference internal" href="api/DiamEllipFunc.html">DiamEllipFunc</a></li>
83<li class="toctree-l2"><a class="reference internal" href="api/DisperseModel.html">DisperseModel</a></li>
84<li class="toctree-l2"><a class="reference internal" href="api/dispersion_models.html">dispersion_models</a></li>
85<li class="toctree-l2"><a class="reference internal" href="api/DivComponent.html">DivComponent</a></li>
86<li class="toctree-l2"><a class="reference internal" href="api/EllipsoidModel.html">EllipsoidModel</a></li>
87<li class="toctree-l2"><a class="reference internal" href="api/EllipticalCylinderModel.html">EllipticalCylinderModel</a></li>
88<li class="toctree-l2"><a class="reference internal" href="api/FCCrystalModel.html">FCCrystalModel</a></li>
89<li class="toctree-l2"><a class="reference internal" href="api/FlexCylEllipXModel.html">FlexCylEllipXModel</a></li>
90<li class="toctree-l2"><a class="reference internal" href="api/FlexibleCylinderModel.html">FlexibleCylinderModel</a></li>
91<li class="toctree-l2"><a class="reference internal" href="api/FractalAbsModel.html">FractalAbsModel</a></li>
92<li class="toctree-l2"><a class="reference internal" href="api/FractalCoreShellModel.html">FractalCoreShellModel</a></li>
93<li class="toctree-l2"><a class="reference internal" href="api/FractalModel.html">FractalModel</a></li>
94<li class="toctree-l2"><a class="reference internal" href="api/FractalMode_pymodell.html">FractalMode_pymodell</a></li>
95<li class="toctree-l2"><a class="reference internal" href="api/FuzzySphereModel.html">FuzzySphereModel</a></li>
96<li class="toctree-l2"><a class="reference internal" href="api/Gaussian.html">Gaussian</a></li>
97<li class="toctree-l2"><a class="reference internal" href="api/GaussLorentzGelModel.html">GaussLorentzGelModel</a></li>
98<li class="toctree-l2"><a class="reference internal" href="api/GuinierModel.html">GuinierModel</a></li>
99<li class="toctree-l2"><a class="reference internal" href="api/GuinierPorodModel.html">GuinierPorodModel</a></li>
100<li class="toctree-l2"><a class="reference internal" href="api/HardsphereStructure.html">HardsphereStructure</a></li>
101<li class="toctree-l2"><a class="reference internal" href="api/HayterMSAStructure.html">HayterMSAStructure</a></li>
102<li class="toctree-l2"><a class="reference internal" href="api/HollowCylinderModel.html">HollowCylinderModel</a></li>
103<li class="toctree-l2"><a class="reference internal" href="api/LamellarFFHGModel.html">LamellarFFHGModel</a></li>
104<li class="toctree-l2"><a class="reference internal" href="api/LamellarModel.html">LamellarModel</a></li>
105<li class="toctree-l2"><a class="reference internal" href="api/LamellarPCrystalModel.html">LamellarPCrystalModel</a></li>
106<li class="toctree-l2"><a class="reference internal" href="api/LamellarPSHGModel.html">LamellarPSHGModel</a></li>
107<li class="toctree-l2"><a class="reference internal" href="api/LamellarPSModel.html">LamellarPSModel</a></li>
108<li class="toctree-l2"><a class="reference internal" href="api/LineModel.html">LineModel</a></li>
109<li class="toctree-l2"><a class="reference internal" href="api/LogNormal.html">LogNormal</a></li>
110<li class="toctree-l2"><a class="reference internal" href="api/Lorentzian.html">Lorentzian</a></li>
111<li class="toctree-l2"><a class="reference internal" href="api/LorentzModel.html">LorentzModel</a></li>
112<li class="toctree-l2"><a class="reference internal" href="api/ModelAdaptor.html">ModelAdaptor</a></li>
113<li class="toctree-l2"><a class="reference internal" href="api/ModelFactory.html">ModelFactory</a></li>
114<li class="toctree-l2"><a class="reference internal" href="api/ModelIO.html">ModelIO</a></li>
115<li class="toctree-l2"><a class="reference internal" href="api/MulComponent.html">MulComponent</a></li>
116<li class="toctree-l2"><a class="reference internal" href="api/MultiplicationModel.html">MultiplicationModel</a></li>
117<li class="toctree-l2"><a class="reference internal" href="api/MultiShellModel.html">MultiShellModel</a></li>
118<li class="toctree-l2"><a class="reference internal" href="api/NewCylinderModel.html">NewCylinderModel</a></li>
119<li class="toctree-l2"><a class="reference internal" href="api/NoStructure.html">NoStructure</a></li>
120<li class="toctree-l2"><a class="reference internal" href="api/NullModel.html">NullModel</a></li>
121<li class="toctree-l2"><a class="reference internal" href="api/OblateModel.html">OblateModel</a></li>
122<li class="toctree-l2"><a class="reference internal" href="api/OnionExpShellModel.html">OnionExpShellModel</a></li>
123<li class="toctree-l2"><a class="reference internal" href="api/OnionModel.html">OnionModel</a></li>
124<li class="toctree-l2"><a class="reference internal" href="api/ParallelepipedModel.html">ParallelepipedModel</a></li>
125<li class="toctree-l2"><a class="reference internal" href="api/PeakGaussModel.html">PeakGaussModel</a></li>
126<li class="toctree-l2"><a class="reference internal" href="api/PeakLorentzModel.html">PeakLorentzModel</a></li>
127<li class="toctree-l2"><a class="reference internal" href="api/PearlNecklaceModel.html">PearlNecklaceModel</a></li>
128<li class="toctree-l2"><a class="reference internal" href="api/pluginmodel.html">pluginmodel</a></li>
129<li class="toctree-l2"><a class="reference internal" href="api/PolymerExclVolume.html">PolymerExclVolume</a></li>
130<li class="toctree-l2"><a class="reference internal" href="api/Poly_GaussCoil.html">Poly_GaussCoil</a></li>
131<li class="toctree-l2"><a class="reference internal" href="api/PorodModel.html">PorodModel</a></li>
132<li class="toctree-l2"><a class="reference internal" href="api/PowerLawAbsModel.html">PowerLawAbsModel</a></li>
133<li class="toctree-l2"><a class="reference internal" href="api/PowerLawModel.html">PowerLawModel</a></li>
134<li class="toctree-l2"><a class="reference internal" href="api/ProlateModel.html">ProlateModel</a></li>
135<li class="toctree-l2"><a class="reference internal" href="api/qsmearing.html">qsmearing</a></li>
136<li class="toctree-l2"><a class="reference internal" href="api/ReflAdvModel.html">ReflAdvModel</a></li>
137<li class="toctree-l2"><a class="reference internal" href="api/ReflectivityIIModel.html">ReflectivityIIModel</a></li>
138<li class="toctree-l2"><a class="reference internal" href="api/ReflectivityModel.html">ReflectivityModel</a></li>
139<li class="toctree-l2"><a class="reference internal" href="api/ReflModel.html">ReflModel</a></li>
140<li class="toctree-l2"><a class="reference internal" href="api/RPA10Model.html">RPA10Model</a></li>
141<li class="toctree-l2"><a class="reference internal" href="api/RPAModel.html">RPAModel</a></li>
142<li class="toctree-l2"><a class="reference internal" href="api/SCCrystalModel.html">SCCrystalModel</a></li>
143<li class="toctree-l2"><a class="reference internal" href="api/Schulz.html">Schulz</a></li>
144<li class="toctree-l2"><a class="reference internal" href="api/Sin.html">Sin</a></li>
145<li class="toctree-l2"><a class="reference internal" href="api/SLDCalFunc.html">SLDCalFunc</a></li>
146<li class="toctree-l2"><a class="reference internal" href="api/smearing_2d.html">smearing_2d</a></li>
147<li class="toctree-l2"><a class="reference internal" href="api/SphereModel.html">SphereModel</a></li>
148<li class="toctree-l2"><a class="reference internal" href="api/SphereSLDModel.html">SphereSLDModel</a></li>
149<li class="toctree-l2"><a class="reference internal" href="api/SphericalSLDModel.html">SphericalSLDModel</a></li>
150<li class="toctree-l2"><a class="reference internal" href="api/SquareWellStructure.html">SquareWellStructure</a></li>
151<li class="toctree-l2"><a class="reference internal" href="api/StackedDisksModel.html">StackedDisksModel</a></li>
152<li class="toctree-l2"><a class="reference internal" href="api/StickyHSStructure.html">StickyHSStructure</a></li>
153<li class="toctree-l2"><a class="reference internal" href="api/SubComponent.html">SubComponent</a></li>
154<li class="toctree-l2"><a class="reference internal" href="api/TeubnerStreyModel.html">TeubnerStreyModel</a></li>
155<li class="toctree-l2"><a class="reference internal" href="api/TriaxialEllipsoidModel.html">TriaxialEllipsoidModel</a></li>
156<li class="toctree-l2"><a class="reference internal" href="api/TwoLorentzianModel.html">TwoLorentzianModel</a></li>
157<li class="toctree-l2"><a class="reference internal" href="api/TwoPowerLawModel.html">TwoPowerLawModel</a></li>
158<li class="toctree-l2"><a class="reference internal" href="api/UnifiedPowerRgModel.html">UnifiedPowerRgModel</a></li>
159<li class="toctree-l2"><a class="reference internal" href="api/VesicleModel.html">VesicleModel</a></li>
160</ul>
161</li>
162</ul>
163</div>
164</div>
165<div class="section" id="indices-and-tables">
166<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
167<ul class="simple">
168<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
169<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
170<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
171</ul>
172</div>
173
174
175          </div>
176        </div>
177      </div>
178      <div class="sphinxsidebar">
179        <div class="sphinxsidebarwrapper">
180  <h3><a href="#">Table Of Contents</a></h3>
181  <ul>
182<li><a class="reference internal" href="#">Welcome to sansmodels&#8217;s documentation!</a><ul>
183</ul>
184</li>
185<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
186</ul>
187
188  <h4>Next topic</h4>
189  <p class="topless"><a href="api/index.html"
190                        title="next chapter">Reference</a></p>
191  <h3>This Page</h3>
192  <ul class="this-page-menu">
193    <li><a href="_sources/index.txt"
194           rel="nofollow">Show Source</a></li>
195  </ul>
196<div id="searchbox" style="display: none">
197  <h3>Quick search</h3>
198    <form class="search" action="search.html" method="get">
199      <input type="text" name="q" />
200      <input type="submit" value="Go" />
201      <input type="hidden" name="check_keywords" value="yes" />
202      <input type="hidden" name="area" value="default" />
203    </form>
204    <p class="searchtip" style="font-size: 90%">
205    Enter search terms or a module, class or function name.
206    </p>
207</div>
208<script type="text/javascript">$('#searchbox').show(0);</script>
209        </div>
210      </div>
211      <div class="clearer"></div>
212    </div>
213    <div class="related">
214      <h3>Navigation</h3>
215      <ul>
216        <li class="right" style="margin-right: 10px">
217          <a href="genindex.html" title="General Index"
218             >index</a></li>
219        <li class="right" >
220          <a href="py-modindex.html" title="Python Module Index"
221             >modules</a> |</li>
222        <li class="right" >
223          <a href="api/index.html" title="Reference"
224             >next</a> |</li>
225        <li><a href="#">sansmodels 0.1.0 documentation</a> &raquo;</li> 
226      </ul>
227    </div>
228    <div class="footer">
229        &copy; Copyright 2010, sans group.
230      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
231    </div>
232  </body>
233</html>
Note: See TracBrowser for help on using the repository browser.