deploy: 49af3ef

Author: sbillinge

_modules/diffpy/labpdfproc/functions.html

@@ -106,16 +106,6 @@ <h1>Source code for diffpy.labpdfproc.functions</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="p">{(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">xs</span> <span class="k">for</span> <span class="n">y</span> <span class="ow">in</span> <span class="n">ys</span> <span class="k">if</span> <span class="n">x</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="n">y</span><span class="o">**</span><span class="mi">2</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">radius</span><span class="o">**</span><span class="mi">2</span><span class="p">}</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">total_points_in_grid</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="p">)</span>
 
-    <span class="c1"># def get_coordinate_index(self, coordinate):  # I think we probably dont need this function?</span>
-    <span class="c1">#     count = 0</span>
-    <span class="c1">#     for i, target in enumerate(self.grid):</span>
-    <span class="c1">#         if coordinate == target:</span>
-    <span class="c1">#             return i</span>
-    <span class="c1">#         else:</span>
-    <span class="c1">#             count += 1</span>
-    <span class="c1">#     if count &gt;= len(self.grid):</span>
-    <span class="c1">#         raise IndexError(f&quot;WARNING: no coordinate {coordinate} found in coordinates list&quot;)</span>
-
 <div class="viewcode-block" id="Gridded_circle.set_distances_at_angle">
 <a class="viewcode-back" href="../../../api/diffpy.labpdfproc.html#diffpy.labpdfproc.functions.Gridded_circle.set_distances_at_angle">[docs]</a>
     <span class="k">def</span> <span class="nf">set_distances_at_angle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">angle</span><span class="p">):</span>

_modules/diffpy/labpdfproc/labpdfprocapp.html

@@ -93,14 +93,14 @@ <h1>Source code for diffpy.labpdfproc.labpdfprocapp</h1><div class="highlight"><
         <span class="s2">&quot;input&quot;</span><span class="p">,</span>
         <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;+&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The filename(s) or folder(s) of the datafile(s) to load.  &quot;</span>
-        <span class="s2">&quot;Required.</span><span class="se">\n</span><span class="s2">Supply a space-separated list of files or directories.&quot;</span>
+        <span class="s2">&quot;Required.</span><span class="se">\n</span><span class="s2">Supply a space-separated list of files or directories. &quot;</span>
         <span class="s2">&quot;Long lists can be supplied, one per line, in a file with name &quot;</span>
         <span class="s2">&quot;file_list.txt. If one or more directory is provided, all valid &quot;</span>
         <span class="s2">&quot;data-files in that directory will be processed. Examples of valid &quot;</span>
         <span class="s2">&quot;inputs are &#39;file.xy&#39;, &#39;data/file.xy&#39;, &#39;file.xy, data/file.xy&#39;, &quot;</span>
-        <span class="s2">&quot;&#39;.&#39; (load everything in the current directory), &#39;data&#39; (load&quot;</span>
-        <span class="s2">&quot;everything in the folder ./data), &#39;data/file_list.txt&#39; (load&quot;</span>
-        <span class="s2">&quot; the list of files contained in the text-file called &quot;</span>
+        <span class="s2">&quot;&#39;.&#39; (load everything in the current directory), &#39;data&#39; (load &quot;</span>
+        <span class="s2">&quot;everything in the folder ./data), &#39;data/file_list.txt&#39; (load &quot;</span>
+        <span class="s2">&quot;the list of files contained in the text-file called &quot;</span>
         <span class="s2">&quot;file_list.txt that can be found in the folder ./data), &quot;</span>
         <span class="s2">&quot;&#39;./*.chi&#39;, &#39;data/*.chi&#39; (load all files with extension .chi in the &quot;</span>
         <span class="s2">&quot;folder ./data).&quot;</span><span class="p">,</span>
@@ -124,7 +124,7 @@ <h1>Source code for diffpy.labpdfproc.labpdfprocapp</h1><div class="highlight"><
         <span class="s2">&quot;-o&quot;</span><span class="p">,</span>
         <span class="s2">&quot;--output-directory&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The name of the output directory. If not specified &quot;</span>
-        <span class="s2">&quot;then corrected files will be written to the current directory.&quot;</span>
+        <span class="s2">&quot;then corrected files will be written to the current directory. &quot;</span>
         <span class="s2">&quot;If the specified directory doesn&#39;t exist it will be created.&quot;</span><span class="p">,</span>
         <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="p">)</span>
@@ -143,7 +143,6 @@ <h1>Source code for diffpy.labpdfproc.labpdfprocapp</h1><div class="highlight"><
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store_true&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The absorption correction will be output to a file if this &quot;</span>
         <span class="s2">&quot;flag is set. Default is that it is not output.&quot;</span><span class="p">,</span>
-        <span class="n">default</span><span class="o">=</span><span class="s2">&quot;tth&quot;</span><span class="p">,</span>
     <span class="p">)</span>
     <span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
         <span class="s2">&quot;-f&quot;</span><span class="p">,</span>

_modules/diffpy/labpdfproc/tools.html

@@ -195,13 +195,12 @@ <h1>Source code for diffpy.labpdfproc.tools</h1><div class="highlight"><pre>
 <span class="sd">    args argparse.Namespace</span>
 <span class="sd">        the arguments from the parser</span>
 
+<span class="sd">    we raise a ValueError if the input wavelength is non-positive</span>
+<span class="sd">    or if the input anode_type is not one of the known sources</span>
+
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
 <span class="sd">    args argparse.Namespace</span>
-
-<span class="sd">    we raise an ValueError if the input wavelength is non-positive</span>
-<span class="sd">    or if the input anode_type is not one of the known sources</span>
-
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">wavelength</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">args</span><span class="o">.</span><span class="n">wavelength</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>

api/diffpy.labpdfproc.html

@@ -296,15 +296,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd><p>Set the wavelength based on the given input arguments</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>argparse.Namespace</strong> (<em>args</em>) – the arguments from the parser</p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><ul class="simple">
-<li><p><em>args argparse.Namespace</em></p></li>
-<li><p><em>we raise an ValueError if the input wavelength is non-positive</em></p></li>
-<li><p><em>or if the input anode_type is not one of the known sources</em></p></li>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>argparse.Namespace</strong> (<em>args</em>) – the arguments from the parser</p></li>
+<li><p><strong>non-positive</strong> (<em>we raise a ValueError if the input wavelength is</em>)</p></li>
+<li><p><strong>sources</strong> (<em>or if the input anode_type is not one</em><em> of </em><em>the known</em>)</p></li>
 </ul>
-</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>args argparse.Namespace</p>
 </dd>
 </dl>
 </dd></dl>

index.html

@@ -81,7 +81,7 @@ <h1>diffpy.labpdfproc documentation<a class="headerlink" href="#title" title="Li
 <p>diffpy.labpdfproc - Tools for processing x-ray powder diffraction data from laboratory sources.</p>
 <div class="line-block">
 <div class="line">Software version 0.1.1.</div>
-<div class="line">Last updated September 04, 2024.</div>
+<div class="line">Last updated September 05, 2024.</div>
 </div>
 <section id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h2>