Update documentation

logsdail · Apr 15, 2024 · 226730a · 226730a
1 parent b421538
commit 226730a
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 4 deletions.
diff --git a/docs/_sources/carmm.analyse.rst.txt b/docs/_sources/carmm.analyse.rst.txt
@@ -68,6 +68,14 @@ carmm.analyse.graphs module
    :undoc-members:
    :show-inheritance:
 
+carmm.analyse.hirshfeld module
+------------------------------
+
+.. automodule:: carmm.analyse.hirshfeld
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 carmm.analyse.images module
 ---------------------------
 

diff --git a/docs/carmm.analyse.html b/docs/carmm.analyse.html
@@ -624,6 +624,55 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 </dl>
 </dd></dl>
 
+</section>
+<section id="module-carmm.analyse.hirshfeld">
+<span id="carmm-analyse-hirshfeld-module"></span><h2>carmm.analyse.hirshfeld module<a class="headerlink" href="#module-carmm.analyse.hirshfeld" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="carmm.analyse.hirshfeld.extract_hirshfeld">
+<span class="sig-prename descclassname"><span class="pre">carmm.analyse.hirshfeld.</span></span><span class="sig-name descname"><span class="pre">extract_hirshfeld</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">natoms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">write</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hirshfeld.txt'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#carmm.analyse.hirshfeld.extract_hirshfeld" title="Link to this definition">¶</a></dt>
+<dd><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>fname</strong> – Input file name, usually aims.out. str</p></li>
+<li><p><strong>natoms</strong> – number of atoms to extract charge from. int</p></li>
+<li><p><strong>data</strong> – type of output requested. str
+Can be ‘charge’, ‘volume’, ‘volume f’, ‘dipole vector’, ‘dipole moment’ or ‘second’</p></li>
+<li><p><strong>write</strong> – bool of whether to write the hirshfeld data to a new file called hirshfeld.txt</p></li>
+</ul>
+</dd>
+</dl>
+<p>Returns: hirsh. List of requested data</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="carmm.analyse.hirshfeld.get_hirshfeld_line">
+<span class="sig-prename descclassname"><span class="pre">carmm.analyse.hirshfeld.</span></span><span class="sig-name descname"><span class="pre">get_hirshfeld_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#carmm.analyse.hirshfeld.get_hirshfeld_line" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="carmm.analyse.hirshfeld.read_hirshfeld">
+<span class="sig-prename descclassname"><span class="pre">carmm.analyse.hirshfeld.</span></span><span class="sig-name descname"><span class="pre">read_hirshfeld</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#carmm.analyse.hirshfeld.read_hirshfeld" title="Link to this definition">¶</a></dt>
+<dd><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>fname</strong> – Input filename. str</p></li>
+<li><p><strong>identifier</strong> – regex to pull data from file. str</p></li>
+</ul>
+</dd>
+</dl>
+<p>Returns: label. list of data</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="carmm.analyse.hirshfeld.vmd_out">
+<span class="sig-prename descclassname"><span class="pre">carmm.analyse.hirshfeld.</span></span><span class="sig-name descname"><span class="pre">vmd_out</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'vmd_chrgs.txt'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#carmm.analyse.hirshfeld.vmd_out" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="carmm.analyse.hirshfeld.write_hirshfeld">
+<span class="sig-prename descclassname"><span class="pre">carmm.analyse.hirshfeld.</span></span><span class="sig-name descname"><span class="pre">write_hirshfeld</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">natoms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#carmm.analyse.hirshfeld.write_hirshfeld" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </section>
 <section id="module-carmm.analyse.images">
 <span id="carmm-analyse-images-module"></span><h2>carmm.analyse.images module<a class="headerlink" href="#module-carmm.analyse.images" title="Link to this heading">¶</a></h2>

diff --git a/docs/carmm.html b/docs/carmm.html
@@ -99,6 +99,14 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.graphs.set_graph_axes_mulliken"><code class="docutils literal notranslate"><span class="pre">set_graph_axes_mulliken()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.hirshfeld">carmm.analyse.hirshfeld module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.hirshfeld.extract_hirshfeld"><code class="docutils literal notranslate"><span class="pre">extract_hirshfeld()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.hirshfeld.get_hirshfeld_line"><code class="docutils literal notranslate"><span class="pre">get_hirshfeld_line()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.hirshfeld.read_hirshfeld"><code class="docutils literal notranslate"><span class="pre">read_hirshfeld()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.hirshfeld.vmd_out"><code class="docutils literal notranslate"><span class="pre">vmd_out()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.hirshfeld.write_hirshfeld"><code class="docutils literal notranslate"><span class="pre">write_hirshfeld()</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.images">carmm.analyse.images module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="carmm.analyse.html#carmm.analyse.images.write_to_povray"><code class="docutils literal notranslate"><span class="pre">write_to_povray()</span></code></a></li>
 </ul>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -155,6 +155,13 @@ <h2 id="C">C</h2>
 
       <ul>
         <li><a href="carmm.analyse.html#module-carmm.analyse.graphs">module</a>
+</li>
+      </ul></li>
+      <li>
+    carmm.analyse.hirshfeld
+
+      <ul>
+        <li><a href="carmm.analyse.html#module-carmm.analyse.hirshfeld">module</a>
 </li>
       </ul></li>
       <li>
@@ -390,6 +397,8 @@ <h2 id="E">E</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="carmm.analyse.html#carmm.analyse.hirshfeld.extract_hirshfeld">extract_hirshfeld() (in module carmm.analyse.hirshfeld)</a>
+</li>
       <li><a href="carmm.analyse.html#carmm.analyse.mulliken.extract_mulliken_charge">extract_mulliken_charge() (in module carmm.analyse.mulliken)</a>
 </li>
       <li><a href="carmm.analyse.html#carmm.analyse.mulliken.extract_mulliken_spin">extract_mulliken_spin() (in module carmm.analyse.mulliken)</a>
@@ -440,10 +449,12 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="carmm.analyse.html#carmm.analyse.mulliken.MullikenData.get_graph_xlabel">get_graph_xlabel() (carmm.analyse.mulliken.MullikenData method)</a>
 </li>
-      <li><a href="carmm.analyse.html#carmm.analyse.mulliken.MullikenData.get_homo">get_homo() (carmm.analyse.mulliken.MullikenData method)</a>
+      <li><a href="carmm.analyse.html#carmm.analyse.hirshfeld.get_hirshfeld_line">get_hirshfeld_line() (in module carmm.analyse.hirshfeld)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="carmm.analyse.html#carmm.analyse.mulliken.MullikenData.get_homo">get_homo() (carmm.analyse.mulliken.MullikenData method)</a>
+</li>
       <li><a href="carmm.analyse.html#carmm.analyse.bonds.get_indices_of_elements">get_indices_of_elements() (in module carmm.analyse.bonds)</a>
 </li>
       <li><a href="carmm.analyse.html#carmm.analyse.planes.get_interplane_distances">get_interplane_distances() (in module carmm.analyse.planes)</a>
@@ -533,6 +544,8 @@ <h2 id="M">M</h2>
         <li><a href="carmm.analyse.html#module-carmm.analyse.forces">carmm.analyse.forces</a>
 </li>
         <li><a href="carmm.analyse.html#module-carmm.analyse.graphs">carmm.analyse.graphs</a>
+</li>
+        <li><a href="carmm.analyse.html#module-carmm.analyse.hirshfeld">carmm.analyse.hirshfeld</a>
 </li>
         <li><a href="carmm.analyse.html#module-carmm.analyse.images">carmm.analyse.images</a>
 </li>
@@ -651,10 +664,12 @@ <h2 id="R">R</h2>
 </li>
       <li><a href="carmm.analyse.html#carmm.analyse.pickle_dos.read_dos_from_old_pickle">read_dos_from_old_pickle() (in module carmm.analyse.pickle_dos)</a>
 </li>
-      <li><a href="carmm.build.html#carmm.build.adsorbate_placer.RotationBox.rotate">rotate() (carmm.build.adsorbate_placer.RotationBox method)</a>
+      <li><a href="carmm.analyse.html#carmm.analyse.hirshfeld.read_hirshfeld">read_hirshfeld() (in module carmm.analyse.hirshfeld)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="carmm.build.html#carmm.build.adsorbate_placer.RotationBox.rotate">rotate() (carmm.build.adsorbate_placer.RotationBox method)</a>
+</li>
       <li><a href="carmm.build.html#carmm.build.adsorbate_placer.RotationBox.rotate_ads2site_vec">rotate_ads2site_vec() (carmm.build.adsorbate_placer.RotationBox method)</a>
 </li>
       <li><a href="carmm.build.html#carmm.build.adsorbate_placer.RotationBox.rotate_and_place_adsorbate">rotate_and_place_adsorbate() (carmm.build.adsorbate_placer.RotationBox method)</a>
@@ -717,6 +732,8 @@ <h2 id="T">T</h2>
 <h2 id="V">V</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="carmm.analyse.html#carmm.analyse.hirshfeld.vmd_out">vmd_out() (in module carmm.analyse.hirshfeld)</a>
+</li>
       <li><a href="carmm.analyse.meshgrid.html#carmm.analyse.meshgrid.meshgrid_void.void_analysis">void_analysis() (in module carmm.analyse.meshgrid.meshgrid_void)</a>
 </li>
   </ul></td>
@@ -732,10 +749,12 @@ <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="carmm.build.neb.html#carmm.build.neb.symmetry.wrap_fcc">wrap_fcc() (in module carmm.build.neb.symmetry)</a>
+</li>
+      <li><a href="carmm.analyse.html#carmm.analyse.mulliken.write_dos_to_csv">write_dos_to_csv() (in module carmm.analyse.mulliken)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="carmm.analyse.html#carmm.analyse.mulliken.write_dos_to_csv">write_dos_to_csv() (in module carmm.analyse.mulliken)</a>
+      <li><a href="carmm.analyse.html#carmm.analyse.hirshfeld.write_hirshfeld">write_hirshfeld() (in module carmm.analyse.hirshfeld)</a>
 </li>
       <li><a href="carmm.analyse.html#carmm.analyse.images.write_to_povray">write_to_povray() (in module carmm.analyse.images)</a>
 </li>

diff --git a/docs/modules.html b/docs/modules.html
@@ -46,6 +46,7 @@ <h1>carmm<a class="headerlink" href="#carmm" title="Link to this heading">¶</a>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.distribution_functions">carmm.analyse.distribution_functions module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.forces">carmm.analyse.forces module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.graphs">carmm.analyse.graphs module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.hirshfeld">carmm.analyse.hirshfeld module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.images">carmm.analyse.images module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.molecules">carmm.analyse.molecules module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="carmm.analyse.html#module-carmm.analyse.mulliken">carmm.analyse.mulliken module</a></li>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -89,6 +89,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="carmm.analyse.html#module-carmm.analyse.graphs"><code class="xref">carmm.analyse.graphs</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="carmm.analyse.html#module-carmm.analyse.hirshfeld"><code class="xref">carmm.analyse.hirshfeld</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

diff --git a/docs/searchindex.js b/docs/searchindex.js