source: sasmodels/index.html @ 68532f3

gh-pages
Last change on this file since 68532f3 was 68532f3, checked in by ajj, 8 years ago

Adding docs
  • Property mode set to 100644
File size: 12.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>Introduction &mdash; Sasmodels</title>
10   
11    <link rel="stylesheet" href="_static/haiku-site.css" type="text/css" />
12    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    './',
17        VERSION:     '0.9',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="_static/jquery.js"></script>
24    <script type="text/javascript" src="_static/underscore.js"></script>
25    <script type="text/javascript" src="_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="Sasmodels" href="#" />
28    <link rel="next" title="1. SAS Model Organization" href="guide/index.html" /> 
29  </head>
30  <body>
31      <div class="header"><h1 class="heading"><a href="#">
32          <span>Home</span></a></h1>
33        <h2 class="heading"><span>Introduction</span></h2>
34      </div>
35      <div class="topnav">
36     
37        <p>
38        <a class="uplink" href="#">Contents</a>
39        &#160;&#160;::&#160;&#160;
40        <a href="guide/index.html">1. SAS Model Organization</a>&#160;&#160;»
41        </p>
42
43      </div>
44      <div class="content">
45       
46       
47  <div class="section" id="introduction">
48<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
49<p>The sasmodels package provides theory functions for small angle scattering
50calculations.</p>
51<table class="docutils field-list" frame="void" rules="none">
52<col class="field-name" />
53<col class="field-body" />
54<tbody valign="top">
55<tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">0.9</td>
56</tr>
57<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">November 01, 2015</td>
58</tr>
59</tbody>
60</table>
61<p>Download pdf version <a class="reference external" href="SASModels.pdf">here</a></p>
62<div class="toctree-wrapper compound">
63<ul>
64<li class="toctree-l1"><a class="reference internal" href="guide/index.html">1. SAS Model Organization</a></li>
65<li class="toctree-l1"><a class="reference internal" href="ref/index.html">2. SAS Model Reference</a><ul>
66<li class="toctree-l2"><a class="reference internal" href="ref/intro.html">1. Introduction</a></li>
67<li class="toctree-l2"><a class="reference internal" href="ref/models/index.html">2. Model Functions</a><ul>
68<li class="toctree-l3"><a class="reference internal" href="ref/models/shape.html">2.1. Shape Functions</a><ul>
69<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-cylinder.html">2.1.1. Cylinder Functions</a><ul>
70<li class="toctree-l5"><a class="reference internal" href="model/barbell.html">2.1.1.1. Barbell</a></li>
71<li class="toctree-l5"><a class="reference internal" href="model/capped_cylinder.html">2.1.1.2. Capped cylinder</a></li>
72<li class="toctree-l5"><a class="reference internal" href="model/core_shell_cylinder.html">2.1.1.3. Core shell cylinder</a></li>
73<li class="toctree-l5"><a class="reference internal" href="model/cylinder.html">2.1.1.4. Cylinder</a></li>
74</ul>
75</li>
76<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-ellipsoid.html">2.1.2. Ellipsoid Functions</a><ul>
77<li class="toctree-l5"><a class="reference internal" href="model/ellipsoid.html">2.1.2.1. Ellipsoid</a></li>
78<li class="toctree-l5"><a class="reference internal" href="model/triaxial_ellipsoid.html">2.1.2.2. Triaxial ellipsoid</a></li>
79</ul>
80</li>
81<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-lamellae.html">2.1.3. Lamellae Functions</a><ul>
82<li class="toctree-l5"><a class="reference internal" href="model/lamellar.html">2.1.3.1. Lamellar</a></li>
83<li class="toctree-l5"><a class="reference internal" href="model/lamellarCaille.html">2.1.3.2. Lamellarps</a></li>
84<li class="toctree-l5"><a class="reference internal" href="model/lamellarCailleHG.html">2.1.3.3. Lamellarcaillehg</a></li>
85<li class="toctree-l5"><a class="reference internal" href="model/lamellarFFHG.html">2.1.3.4. Lamellar ffhg</a></li>
86<li class="toctree-l5"><a class="reference internal" href="model/lamellarPC.html">2.1.3.5. Lamellarpc</a></li>
87</ul>
88</li>
89<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-paracrystal.html">2.1.4. Paracrystal Functions</a><ul>
90<li class="toctree-l5"><a class="reference internal" href="model/bcc.html">2.1.4.1. Bcc paracrystal</a></li>
91<li class="toctree-l5"><a class="reference internal" href="model/fcc.html">2.1.4.2. Fcc paracrystal</a></li>
92</ul>
93</li>
94<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-parallelpiped.html">2.1.5. Parallelpiped Functions</a><ul>
95<li class="toctree-l5"><a class="reference internal" href="model/parallelepiped.html">2.1.5.1. Parallelepiped</a></li>
96</ul>
97</li>
98<li class="toctree-l4"><a class="reference internal" href="ref/models/shape-sphere.html">2.1.6. Sphere Functions</a><ul>
99<li class="toctree-l5"><a class="reference internal" href="model/sphere.html">2.1.6.1. Sphere</a></li>
100<li class="toctree-l5"><a class="reference internal" href="model/spherepy.html">2.1.6.2. Sphere</a></li>
101</ul>
102</li>
103</ul>
104</li>
105<li class="toctree-l3"><a class="reference internal" href="ref/models/shape-independent.html">2.2. Shape-Independent Functions</a><ul>
106<li class="toctree-l4"><a class="reference internal" href="model/broad_peak.html">2.2.1. Broad peak</a><ul>
107<li class="toctree-l5"><a class="reference internal" href="model/broad_peak.html#definition">2.2.1.1. Definition</a></li>
108<li class="toctree-l5"><a class="reference internal" href="model/broad_peak.html#reference">2.2.1.2. REFERENCE</a></li>
109</ul>
110</li>
111<li class="toctree-l4"><a class="reference internal" href="model/dab.html">2.2.2. Dab</a><ul>
112<li class="toctree-l5"><a class="reference internal" href="model/dab.html#definition">2.2.2.1. Definition</a></li>
113<li class="toctree-l5"><a class="reference internal" href="model/dab.html#reference">2.2.2.2. Reference</a></li>
114</ul>
115</li>
116<li class="toctree-l4"><a class="reference internal" href="model/gaussian_peak.html">2.2.3. Gaussian peak</a><ul>
117<li class="toctree-l5"><a class="reference internal" href="model/gaussian_peak.html#reference">2.2.3.1. REFERENCE</a></li>
118</ul>
119</li>
120</ul>
121</li>
122<li class="toctree-l3"><a class="reference internal" href="ref/models/structure-factor.html">2.3. Structure Factors</a><ul>
123<li class="toctree-l4"><a class="reference internal" href="model/hardsphere.html">2.3.1. Hardsphere</a></li>
124<li class="toctree-l4"><a class="reference internal" href="model/stickyhardsphere.html">2.3.2. Stickyhardsphere</a></li>
125</ul>
126</li>
127<li class="toctree-l3"><a class="reference internal" href="ref/models/custom-models.html">2.4. Custom Models</a><ul class="simple">
128</ul>
129</li>
130</ul>
131</li>
132<li class="toctree-l2"><a class="reference internal" href="ref/refs.html">3. References</a></li>
133</ul>
134</li>
135<li class="toctree-l1"><a class="reference internal" href="api/index.html">3. Reference</a><ul>
136<li class="toctree-l2"><a class="reference internal" href="api/bumps_model.html">3.1. Bumps interface</a><ul>
137<li class="toctree-l3"><a class="reference internal" href="api/bumps_model.html#module-sasmodels.bumps_model">3.1.1. <tt class="docutils literal"><span class="pre">sasmodels.bumps_model</span></tt></a></li>
138</ul>
139</li>
140<li class="toctree-l2"><a class="reference internal" href="api/convert.html">3.2. Sasview to sasmodel converter</a><ul>
141<li class="toctree-l3"><a class="reference internal" href="api/convert.html#module-sasmodels.convert">3.2.1. <tt class="docutils literal"><span class="pre">sasmodels.convert</span></tt></a></li>
142</ul>
143</li>
144<li class="toctree-l2"><a class="reference internal" href="api/core.html">3.3. Model access</a><ul>
145<li class="toctree-l3"><a class="reference internal" href="api/core.html#module-sasmodels.core">3.3.1. <tt class="docutils literal"><span class="pre">sasmodels.core</span></tt></a></li>
146</ul>
147</li>
148<li class="toctree-l2"><a class="reference internal" href="api/direct_model.html">3.4. Simple interface</a><ul>
149<li class="toctree-l3"><a class="reference internal" href="api/direct_model.html#module-sasmodels.direct_model">3.4.1. <tt class="docutils literal"><span class="pre">sasmodels.direct_model</span></tt></a></li>
150</ul>
151</li>
152<li class="toctree-l2"><a class="reference internal" href="api/exception.html">3.5. Annotate exceptions</a><ul>
153<li class="toctree-l3"><a class="reference internal" href="api/exception.html#module-sasmodels.exception">3.5.1. <tt class="docutils literal"><span class="pre">sasmodels.exception</span></tt></a></li>
154</ul>
155</li>
156<li class="toctree-l2"><a class="reference internal" href="api/generate.html">3.6. Model parser</a><ul>
157<li class="toctree-l3"><a class="reference internal" href="api/generate.html#module-sasmodels.generate">3.6.1. <tt class="docutils literal"><span class="pre">sasmodels.generate</span></tt></a></li>
158</ul>
159</li>
160<li class="toctree-l2"><a class="reference internal" href="api/kernelcl.html">3.7. OpenCL model evaluator</a><ul>
161<li class="toctree-l3"><a class="reference internal" href="api/kernelcl.html#module-sasmodels.kernelcl">3.7.1. <tt class="docutils literal"><span class="pre">sasmodels.kernelcl</span></tt></a></li>
162</ul>
163</li>
164<li class="toctree-l2"><a class="reference internal" href="api/kerneldll.html">3.8. Ctypes model evaluator</a><ul>
165<li class="toctree-l3"><a class="reference internal" href="api/kerneldll.html#module-sasmodels.kerneldll">3.8.1. <tt class="docutils literal"><span class="pre">sasmodels.kerneldll</span></tt></a></li>
166</ul>
167</li>
168<li class="toctree-l2"><a class="reference internal" href="api/kernelpy.html">3.9. Python model evaluator</a><ul>
169<li class="toctree-l3"><a class="reference internal" href="api/kernelpy.html#module-sasmodels.kernelpy">3.9.1. <tt class="docutils literal"><span class="pre">sasmodels.kernelpy</span></tt></a></li>
170</ul>
171</li>
172<li class="toctree-l2"><a class="reference internal" href="api/model_test.html">3.10. Unit test support</a><ul>
173<li class="toctree-l3"><a class="reference internal" href="api/model_test.html#module-sasmodels.model_test">3.10.1. <tt class="docutils literal"><span class="pre">sasmodels.model_test</span></tt></a></li>
174</ul>
175</li>
176<li class="toctree-l2"><a class="reference internal" href="api/resolution.html">3.11. 1-D resolution functions</a><ul>
177<li class="toctree-l3"><a class="reference internal" href="api/resolution.html#module-sasmodels.resolution">3.11.1. <tt class="docutils literal"><span class="pre">sasmodels.resolution</span></tt></a></li>
178</ul>
179</li>
180<li class="toctree-l2"><a class="reference internal" href="api/resolution2d.html">3.12. 2-D resolution functions</a><ul>
181<li class="toctree-l3"><a class="reference internal" href="api/resolution2d.html#module-sasmodels.resolution2d">3.12.1. <tt class="docutils literal"><span class="pre">sasmodels.resolution2d</span></tt></a></li>
182</ul>
183</li>
184<li class="toctree-l2"><a class="reference internal" href="api/sasview_model.html">3.13. Sasview interface</a><ul>
185<li class="toctree-l3"><a class="reference internal" href="api/sasview_model.html#module-sasmodels.sasview_model">3.13.1. <tt class="docutils literal"><span class="pre">sasmodels.sasview_model</span></tt></a></li>
186</ul>
187</li>
188<li class="toctree-l2"><a class="reference internal" href="api/sesans.html">3.14. SESANS model evaluator</a><ul>
189<li class="toctree-l3"><a class="reference internal" href="api/sesans.html#module-sasmodels.sesans">3.14.1. <tt class="docutils literal"><span class="pre">sasmodels.sesans</span></tt></a></li>
190</ul>
191</li>
192<li class="toctree-l2"><a class="reference internal" href="api/weights.html">3.15. Distribution functions</a><ul>
193<li class="toctree-l3"><a class="reference internal" href="api/weights.html#module-sasmodels.weights">3.15.1. <tt class="docutils literal"><span class="pre">sasmodels.weights</span></tt></a></li>
194</ul>
195</li>
196</ul>
197</li>
198</ul>
199</div>
200</div>
201<div class="section" id="indices-and-tables">
202<h1>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
203<ul class="simple">
204<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
205<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
206</ul>
207<ul class="simple">
208<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
209</ul>
210</div>
211
212
213      </div>
214      <div class="bottomnav">
215     
216        <p>
217        <a class="uplink" href="#">Contents</a>
218        &#160;&#160;::&#160;&#160;
219        <a href="guide/index.html">1. SAS Model Organization</a>&#160;&#160;»
220        </p>
221
222      </div>
223
224    <div class="footer">
225        &copy; Copyright 2014, sasview team.
226      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
227    </div>
228  </body>
229</html>
Note: See TracBrowser for help on using the repository browser.