Changeset 14e9eb3 in sasview for calculator/docs/sphinx

Timestamp:

May 28, 2010 1:24:47 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

25a2ee3

Parents:

2882fb5

Message:

working on documentation

Location:

calculator/docs/sphinx

Files:

• _build/doctrees/api/index.doctree (modified) (previous)
• _build/doctrees/api/sld_calculator.doctree (modified) (previous)
• _build/doctrees/api/slit_length_calculator.doctree (added)
• _build/doctrees/environment.pickle (modified) (previous)
• _build/html/_sources/api/index.txt (modified) (1 diff)
• _build/html/_sources/api/slit_length_calculator.txt (added)
• _build/html/api/index.html (modified) (2 diffs)
• _build/html/api/sld_calculator.html (modified) (7 diffs)
• _build/html/api/slit_length_calculator.html (added)
• _build/html/genindex.html (modified) (2 diffs)
• _build/html/index.html (modified) (1 diff)
• _build/html/objects.inv (modified) (previous)
• _build/html/py-modindex.html (modified) (1 diff)
• _build/html/searchindex.js (modified) (1 diff)
• api/index.rst (modified) (1 diff)
• api/slit_length_calculator.rst (added)
• genmods.py (modified) (1 diff)

calculator/docs/sphinx/_build/html/_sources/api/index.txt

@@ -15 +15 @@
 
    sld_calculator.rst
+   slit_length_calculator.rst

calculator/docs/sphinx/_build/html/api/index.html

@@ -60 +60 @@
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">0.1</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">May 27, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">May 28, 2010</td>
 </tr>
 </tbody>
@@ -68 +68 @@
 <li class="toctree-l1"><a class="reference internal" href="sld_calculator.html">Sld Calculator</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="sld_calculator.html#module-sans.calculator.sld_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.sld_calculator</span></tt></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="slit_length_calculator.html">Slit Length Calculator</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="slit_length_calculator.html#module-sans.calculator.slit_length_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li>
 </ul>
 </li>

calculator/docs/sphinx/_build/html/api/sld_calculator.html

@@ -25 +25 @@
     <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />
     <link rel="up" title="Reference" href="index.html" />
+    <link rel="next" title="Slit Length Calculator" href="slit_length_calculator.html" />
     <link rel="prev" title="Reference" href="index.html" /> 
   </head>
@@ -37 +38 @@
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="slit_length_calculator.html" title="Slit Length Calculator"
+             accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="index.html" title="Reference"
@@ -54 +58 @@
 <div class="section" id="module-sans.calculator.sld_calculator">
 <span id="sans-calculator-sld-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.sld_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.sld_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.sld_calculator" title="Permalink to this headline">¶</a></h2>
-<p>This module intends to compute the neutron scattering length density of molecule
-&#64;author: Gervaise B. Alina</p>
+<p>This module intends to compute the neutron scattering length density 
+of a molecule.It uses methods of the periodictable package to provide 
+easy user interface for  Sld calculator applications.</p>
 <dl class="class">
 <dt id="sans.calculator.sld_calculator.SldCalculator">
 <em class="property">class </em><tt class="descclassname">sans.calculator.sld_calculator.</tt><tt class="descname">SldCalculator</tt><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
-<p>compute neutron SLD and related parameters</p>
-<dl class="method">
-<dt id="sans.calculator.sld_calculator.SldCalculator.calculate_coherence_im">
-<tt class="descname">calculate_coherence_im</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.calculate_coherence_im" title="Permalink to this definition">¶</a></dt>
-<dd>Compute imaginary part of the absorption</dd></dl>
-
+<p>Given a molecule, a density and a wavelength, this class 
+determine scattering length density.</p>
+<p>Example: To get the sld value and the length 1/e the following 
+methods need to be called in this later order:</p>
+<div class="highlight-python"><pre>formula = "H2O"
+density = 1.0
+wavelength = 6.0
+sld_calculator = SldCalculator()
+sld_calculator.set_value(formula, density, wavelength) 
+sld_real, sld_im, _ = sld_calculator.calculate_neutron_sld()
+result : sld = sld_real +i sld_im</pre>
+</div>
+<p>Note: <strong>set_value()</strong> and <strong>calculate_neutron_sld()</strong> methods must
+be called in this order prior calling <strong>calculate_length()</strong> to get 
+the proper result.</p>
 <dl class="method">
 <dt id="sans.calculator.sld_calculator.SldCalculator.calculate_length">
@@ -75 +89 @@
 <tt class="descname">calculate_neutron_sld</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.calculate_neutron_sld" title="Permalink to this definition">¶</a></dt>
 <dd>Compute the neutron SLD for a given molecule
-&#64;return absorp: absorption
-&#64;return coh: coherence cross section
+&#64;return sld_real : real part of the sld value
+&#64;return sld_im: imaginary part of the sld value
 &#64;return inc: incoherence cross section</dd></dl>
 
@@ -87 +101 @@
 <dl class="method">
 <dt id="sans.calculator.sld_calculator.SldCalculator.set_value">
-<tt class="descname">set_value</tt><big>(</big><em>user_formula</em>, <em>density</em>, <em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.set_value" title="Permalink to this definition">¶</a></dt>
-<dd>Store values of density and wavelength into the calculator 
-and compute the volume</dd></dl>
+<tt class="descname">set_value</tt><big>(</big><em>formula</em>, <em>density</em>, <em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.set_value" title="Permalink to this definition">¶</a></dt>
+<dd>Store values into the sld calculator and compute the corresponding
+volume.</dd></dl>
 
 </dd></dl>
@@ -113 +127 @@
   <p class="topless"><a href="index.html"
                         title="previous chapter">Reference</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="slit_length_calculator.html"
+                        title="next chapter">Slit Length Calculator</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
@@ -145 +162 @@
              >modules</a> |</li>
         <li class="right" >
+          <a href="slit_length_calculator.html" title="Slit Length Calculator"
+             >next</a> |</li>
+        <li class="right" >
           <a href="index.html" title="Reference"
              >previous</a> |</li>

calculator/docs/sphinx/_build/html/genindex.html

@@ -48 +48 @@
 
    <div class="genindex-jumpbox">
-   <a href="#C"><strong>C</strong></a> | <a href="#S"><strong>S</strong></a> 
+   <a href="#C"><strong>C</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#S"><strong>S</strong></a> 
    </div>
 <h2 id="C">C</h2>
 <table width="100%" class="indextable genindextable"><tr>
   <td width="33%" valign="top"><dl>
-    <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.calculate_coherence_im">calculate_coherence_im() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
     <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.calculate_length">calculate_length() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
+    <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.calculate_neutron_sld">calculate_neutron_sld() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
 </dl></td>
   <td width="33%" valign="top"><dl>
-    <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.calculate_neutron_sld">calculate_neutron_sld() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
+    <dt><a href="api/slit_length_calculator.html#sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">calculate_slit_length() (sans.calculator.slit_length_calculator.SlitlengthCalculator method)</a></dt>
     <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.calculate_xray_sld">calculate_xray_sld() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
+</dl></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table width="100%" class="indextable genindextable"><tr>
+  <td width="33%" valign="top"><dl>
+    <dt><a href="api/slit_length_calculator.html#sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">get_slit_length_unit() (sans.calculator.slit_length_calculator.SlitlengthCalculator method)</a></dt>
 </dl></td>
 </tr></table>
@@ -66 +73 @@
   <td width="33%" valign="top"><dl>
     <dt><a href="api/sld_calculator.html#module-sans.calculator.sld_calculator">sans.calculator.sld_calculator (module)</a></dt>
-    <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.set_value">set_value() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
+    <dt><a href="api/slit_length_calculator.html#module-sans.calculator.slit_length_calculator">sans.calculator.slit_length_calculator (module)</a></dt>
+    <dt><a href="api/slit_length_calculator.html#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">set_data() (sans.calculator.slit_length_calculator.SlitlengthCalculator method)</a></dt>
 </dl></td>
   <td width="33%" valign="top"><dl>
+    <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator.set_value">set_value() (sans.calculator.sld_calculator.SldCalculator method)</a></dt>
     <dt><a href="api/sld_calculator.html#sans.calculator.sld_calculator.SldCalculator">SldCalculator (class in sans.calculator.sld_calculator)</a></dt>
+    <dt><a href="api/slit_length_calculator.html#sans.calculator.slit_length_calculator.SlitlengthCalculator">SlitlengthCalculator (class in sans.calculator.slit_length_calculator)</a></dt>
 </dl></td>
 </tr></table>

calculator/docs/sphinx/_build/html/index.html

@@ -67 +67 @@
 <li class="toctree-l1"><a class="reference internal" href="api/index.html">Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="api/sld_calculator.html">Sld Calculator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/slit_length_calculator.html">Slit Length Calculator</a></li>
 </ul>
 </li>

calculator/docs/sphinx/_build/html/py-modindex.html

@@ -69 +69 @@
        <a href="api/sld_calculator.html#module-sans.calculator.sld_calculator"><tt class="xref">sans.calculator.sld_calculator</tt></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&nbsp;&nbsp;&nbsp;
+       <a href="api/slit_length_calculator.html#module-sans.calculator.slit_length_calculator"><tt class="xref">sans.calculator.slit_length_calculator</tt></a></td><td>
+       <em></em></td></tr>
    </table>
 

calculator/docs/sphinx/_build/html/searchindex.js

@@ -1 @@
-Search.setIndex({objects:{"sans.calculator.sld_calculator":{SldCalculator:[2,1,1]},"sans.calculator":{sld_calculator:[2,0,0]},"sans.calculator.sld_calculator.SldCalculator":{calculate_neutron_sld:[2,2,1],calculate_coherence_im:[2,2,1],calculate_xray_sld:[2,2,1],calculate_length:[2,2,1],set_value:[2,2,1]}},terms:{comput:[1,2],san:[0,2],sld_calcul:[0,2],thi:2,modul:[1,2],independ:1,calcul:[0,1,2],indic:1,correspond:2,each:1,packag:1,slit:[],exist:2,coher:2,tabl:1,sansview:1,follow:1,gervais:2,paramet:2,index:1,given:2,absorpt:2,sub:1,author:2,titl:[],section:2,releas:[0,1],cross:2,param:2,content:[],other:1,densiti:2,formula:2,page:1,document:[],intend:2,tool:1,neutron:2,refer:[0,1],calculate_xray_sld:2,applic:1,alina:2,relat:2,"return":2,string:2,get:2,wavelength:2,imaginari:2,object:2,molecul:2,sld:[0,1,2],calculate_length:2,volum:2,date:[0,1],atom:2,mai:[0,1],elementi:2,part:2,absorp:2,"class":2,valu:2,welcom:[],search:1,contain:1,calculate_coherence_im:2,current:1,sldcalcul:2,element:2,length:2,base:2,necessari:1,store:2,user_formula:2,calculate_neutron_sld:2,small:1,coh:2,incoher:2,inc:2,scatter:2,set_valu:2},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Reference","Calculator","Sld Calculator"],objnames:{"0":"Python module","1":"Python class","2":"Python method"},filenames:["api/index","index","api/sld_calculator"]})
+Search.setIndex({objects:{"sans.calculator.sld_calculator":{SldCalculator:[3,1,1]},"sans.calculator":{sld_calculator:[3,0,0],slit_length_calculator:[2,0,0]},"sans.calculator.slit_length_calculator.SlitlengthCalculator":{get_slit_length_unit:[2,2,1],calculate_slit_length:[2,2,1],set_data:[2,2,1]},"sans.calculator.sld_calculator.SldCalculator":{calculate_neutron_sld:[3,2,1],calculate_length:[3,2,1],calculate_xray_sld:[3,2,1],set_value:[3,2,1]},"sans.calculator.slit_length_calculator":{SlitlengthCalculator:[2,1,1]}},terms:{thi:[2,3],follow:[1,3],paramet:[],get_slit_length_unit:2,easi:3,param:[2,3],should:[],better:[],densiti:3,arrai:2,real:3,applic:[1,3],"return":[2,3],string:3,get:3,molecul:3,beam:2,calculate_sld_im:[],volum:3,method:3,necessari:1,user_formula:[],each:1,small:[1,2],page:1,set:2,sld_calcul:[0,3],sldcalcul:3,result:3,proper:3,wavelength:3,todo:[],index:1,absorpt:[],sub:1,"3rd":2,section:3,slit_length_calcul:[0,2],content:[],formula:3,imaginari:3,slitlengthcalcul:2,refer:[0,1],alina:[],sansview:1,contain:1,calculate_slit_length:2,calculate_length:3,set_data:2,releas:[0,1],valu:[2,3],search:1,current:1,prior:3,length:[0,1,2,3],base:[2,3],calculate_neutron_sld:3,coh:[],col:2,point:[],modul:[2,1,3],independ:1,"2nd":2,saxsess:2,"1st":2,unit:2,given:3,from:2,call:3,sld_real:3,interfac:3,store:3,quickli:2,tool:[1,2],factor:[],part:3,atom:3,set_valu:3,must:3,none:2,provid:3,calcul:[0,1,2,3],sld:[0,1,3],scatter:3,later:3,comput:[2,1,3],san:[0,2,3],indic:1,packag:[1,3],slit:[0,1,2],exist:3,coher:[],tabl:1,need:[2,3],gervais:[],inc:3,date:[0,1],welcom:[],calculate_xray_sld:3,titl:[],cross:3,note:3,other:1,futur:[],document:[],neutron:3,incoher:3,sld_im:3,relat:[],intend:3,allow:2,max:[],object:[2,3],periodict:3,user:[2,3],mai:[0,1],elementi:3,absorp:[],data:2,"class":[2,3],don:2,calculate_coherence_im:[],author:[],correspond:3,element:3,h2o:3,exampl:3,determin:[2,3],profil:2,order:3},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Reference","Calculator","Slit Length Calculator","Sld Calculator"],objnames:{"0":"Python module","1":"Python class","2":"Python method"},filenames:["api/index","index","api/slit_length_calculator","api/sld_calculator"]})

calculator/docs/sphinx/api/index.rst

@@ -15 +15 @@
 
    sld_calculator.rst
+   slit_length_calculator.rst

calculator/docs/sphinx/genmods.py

@@ -54 +54 @@
 modules=[
     ('sld_calculator', 'Sld Calculator'),
+    ('slit_length_calculator', 'Slit Length Calculator'),
 ]
 package='sans.calculator'