deploy: 89c1322

Author: sbillinge

_modules/diffpy/labpdfproc/tools.html

@@ -84,134 +84,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <section id="diffpy-labpdfproc-functions-module">
 <h3>diffpy.labpdfproc.functions module<a class="headerlink" href="#diffpy-labpdfproc-functions-module" title="Link to this heading"></a></h3>
 </section>
-<section id="module-diffpy.labpdfproc.tools">
-<span id="diffpy-labpdfproc-tools-module"></span><h3>diffpy.labpdfproc.tools module<a class="headerlink" href="#module-diffpy.labpdfproc.tools" title="Link to this heading"></a></h3>
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.load_metadata">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">load_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#load_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.load_metadata" title="Link to this definition"></a></dt>
-<dd><p>Load relevant metadata from args</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">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>A dictionary with relevant arguments from the parser</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.load_package_info">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">load_package_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#load_package_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.load_package_info" title="Link to this definition"></a></dt>
-<dd><p>Load diffpy.labpdfproc package name and version into args using get_package_info function from diffpy.utils</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, default is None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>the updated argparse Namespace with diffpy.labpdfproc name and version inserted</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.load_user_info">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">load_user_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#load_user_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.load_user_info" title="Link to this definition"></a></dt>
-<dd><p>Update username and email using get_user_info function from diffpy.utils</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, default is None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>the updated argparse Namespace with username and email inserted</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.load_user_metadata">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">load_user_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#load_user_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.load_user_metadata" title="Link to this definition"></a></dt>
-<dd><p>Load user metadata into the provided argparse Namespace, raise ValueError if in incorrect format</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">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>the updated argparse Namespace with user metadata inserted as key-value pairs</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.preprocessing_args">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">preprocessing_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#preprocessing_args"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.preprocessing_args" title="Link to this definition"></a></dt>
-<dd><p>Perform preprocessing on the provided argparse Namespace</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, default is None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>the updated argparse Namespace with arguments preprocessed</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.set_input_lists">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">set_input_lists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#set_input_lists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.set_input_lists" title="Link to this definition"></a></dt>
-<dd><p>Set input directory and files.</p>
-<p>It takes cli inputs, checks if they are files or directories and creates
-a list of files to be processed which is stored in the args Namespace.</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">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>args argparse.Namespace</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.set_output_directory">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">set_output_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#set_output_directory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.set_output_directory" title="Link to this definition"></a></dt>
-<dd><p>set the output directory 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"><ul class="simple">
-<li><p><strong>argparse.Namespace</strong> (<em>args</em>) – the arguments from the parser</p></li>
-<li><p><strong>follows</strong> (<em>it is determined as</em>)</p></li>
-<li><p><strong>directory</strong> (<em>If user provides an output</em>)</p></li>
-<li><p><strong>it.</strong> (<em>use</em>)</p></li>
-<li><p><strong>Otherwise</strong></p></li>
-<li><p><strong>provided.</strong> (<em>we set it to the current directory if nothing is</em>)</p></li>
-<li><p><strong>exist.</strong> (<em>We then create the directory if it does not</em>)</p></li>
-</ul>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>a Path object that contains the full path of the output directory</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="diffpy.labpdfproc.tools.set_wavelength">
-<span class="sig-prename descclassname"><span class="pre">diffpy.labpdfproc.tools.</span></span><span class="sig-name descname"><span class="pre">set_wavelength</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/labpdfproc/tools.html#set_wavelength"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.labpdfproc.tools.set_wavelength" title="Link to this definition"></a></dt>
-<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"><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>
-</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>
-
+<section id="diffpy-labpdfproc-tools-module">
+<h3>diffpy.labpdfproc.tools module<a class="headerlink" href="#diffpy-labpdfproc-tools-module" title="Link to this heading"></a></h3>
 </section>
 <section id="diffpy-labpdfproc-labpdfprocapp-module">
 <h3>diffpy.labpdfproc.labpdfprocapp module<a class="headerlink" href="#diffpy-labpdfproc-labpdfprocapp-module" title="Link to this heading"></a></h3>

_modules/index.html

@@ -80,9 +80,7 @@ <h1 id="index">Index</h1>
  <a href="#D"><strong>D</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
- | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
- | <a href="#S"><strong>S</strong></a>
 
 </div>
 <h2 id="D">D</h2>
@@ -93,15 +91,6 @@ <h2 id="D">D</h2>
 
       <ul>
         <li><a href="api/diffpy.labpdfproc.html#module-diffpy.labpdfproc">module</a>
-</li>
-      </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    diffpy.labpdfproc.tools
-
-      <ul>
-        <li><a href="api/diffpy.labpdfproc.html#module-diffpy.labpdfproc.tools">module</a>
 </li>
       </ul></li>
   </ul></td>
@@ -111,16 +100,6 @@ <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="license.html#index-0">license</a>
-</li>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.load_metadata">load_metadata() (in module diffpy.labpdfproc.tools)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.load_package_info">load_package_info() (in module diffpy.labpdfproc.tools)</a>
-</li>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.load_user_info">load_user_info() (in module diffpy.labpdfproc.tools)</a>
-</li>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.load_user_metadata">load_user_metadata() (in module diffpy.labpdfproc.tools)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -133,21 +112,11 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="api/diffpy.labpdfproc.html#module-diffpy.labpdfproc">diffpy.labpdfproc</a>
-</li>
-        <li><a href="api/diffpy.labpdfproc.html#module-diffpy.labpdfproc.tools">diffpy.labpdfproc.tools</a>
 </li>
       </ul></li>
   </ul></td>
 </tr></table>
 
-<h2 id="P">P</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.preprocessing_args">preprocessing_args() (in module diffpy.labpdfproc.tools)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -156,20 +125,6 @@ <h2 id="R">R</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="S">S</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.set_input_lists">set_input_lists() (in module diffpy.labpdfproc.tools)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.set_output_directory">set_output_directory() (in module diffpy.labpdfproc.tools)</a>
-</li>
-      <li><a href="api/diffpy.labpdfproc.html#diffpy.labpdfproc.tools.set_wavelength">set_wavelength() (in module diffpy.labpdfproc.tools)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 
 
            </div>

api/diffpy.labpdfproc.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 13, 2024.</div>
+<div class="line">Last updated September 14, 2024.</div>
 </div>
 <section id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h2>

genindex.html

@@ -80,20 +80,11 @@
    <h1>Python Module Index</h1>
 
    <div class="modindex-jumpbox">
-   <a href="#cap-."><strong>.</strong></a> | 
    <a href="#cap-d"><strong>d</strong></a>
    </div>
 
    <table class="indextable modindextable">
      <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
-     <tr class="cap" id="cap-."><td></td><td>
-       <strong>.</strong></td><td></td></tr>
-     <tr class="cg-0">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="api/diffpy.labpdfproc.html#module-diffpy.labpdfproc.tools"><code class="xref">diffpy.labpdfproc.tools</code></a></td><td>
-       <em></em></td></tr>
-     <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
      <tr class="cap" id="cap-d"><td></td><td>
        <strong>d</strong></td><td></td></tr>
      <tr>