Skip to content

Commit a3c85ea

Browse files
committed
deploy: 89b38d4
1 parent 78cb43b commit a3c85ea

7 files changed

+392
-249
lines changed

_autosummary/atomdb.datasets.html

+3
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060
<script async="async" src="../_static/sphinx-thebe.js?v=c100c467"></script>
6161
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
6262
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
63+
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
64+
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
6365
<script>DOCUMENTATION_OPTIONS.pagename = '_autosummary/atomdb.datasets';</script>
6466
<link rel="icon" href="../_static/favicon.png"/>
6567
<link rel="index" title="Index" href="../genindex.html" />
@@ -426,6 +428,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
426428
<li class="toctree-l1"><a class="reference internal" href="atomdb.datasets.numeric.html">atomdb.datasets.numeric package</a><ul>
427429
<li class="toctree-l2"><a class="reference internal" href="atomdb.datasets.numeric.html#submodules">Submodules</a></li>
428430
<li class="toctree-l2"><a class="reference internal" href="atomdb.datasets.numeric.html#module-atomdb.datasets.numeric.run">atomdb.datasets.numeric.run module</a><ul>
431+
<li class="toctree-l3"><a class="reference internal" href="atomdb.datasets.numeric.html#atomdb.datasets.numeric.run.eval_radial_dd_density"><code class="docutils literal notranslate"><span class="pre">eval_radial_dd_density()</span></code></a></li>
429432
<li class="toctree-l3"><a class="reference internal" href="atomdb.datasets.numeric.html#atomdb.datasets.numeric.run.load_numerical_hf_data"><code class="docutils literal notranslate"><span class="pre">load_numerical_hf_data()</span></code></a></li>
430433
<li class="toctree-l3"><a class="reference internal" href="atomdb.datasets.numeric.html#atomdb.datasets.numeric.run.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li>
431434
</ul>

_autosummary/atomdb.datasets.numeric.html

+57-1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060
<script async="async" src="../_static/sphinx-thebe.js?v=c100c467"></script>
6161
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
6262
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
63+
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
64+
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
6365
<script>DOCUMENTATION_OPTIONS.pagename = '_autosummary/atomdb.datasets.numeric';</script>
6466
<link rel="icon" href="../_static/favicon.png"/>
6567
<link rel="index" title="Index" href="../genindex.html" />
@@ -387,6 +389,7 @@ <h2> Contents </h2>
387389
<ul class="visible nav section-nav flex-column">
388390
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submodules">Submodules</a></li>
389391
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-atomdb.datasets.numeric.run">atomdb.datasets.numeric.run module</a><ul class="nav section-nav flex-column">
392+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.eval_radial_dd_density"><code class="docutils literal notranslate"><span class="pre">eval_radial_dd_density()</span></code></a></li>
390393
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.load_numerical_hf_data"><code class="docutils literal notranslate"><span class="pre">load_numerical_hf_data()</span></code></a></li>
391394
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li>
392395
</ul>
@@ -411,10 +414,62 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
411414
<section id="module-atomdb.datasets.numeric.run">
412415
<span id="atomdb-datasets-numeric-run-module"></span><h2>atomdb.datasets.numeric.run module<a class="headerlink" href="#module-atomdb.datasets.numeric.run" title="Link to this heading">#</a></h2>
413416
<p>Numerical Hartree-Fock Data on a Grid.</p>
417+
<dl class="py function">
418+
<dt class="sig sig-object py" id="atomdb.datasets.numeric.run.eval_radial_dd_density">
419+
<span class="sig-prename descclassname"><span class="pre">atomdb.datasets.numeric.run.</span></span><span class="sig-name descname"><span class="pre">eval_radial_dd_density</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gradient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">laplacian</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">points</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ignore'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#atomdb.datasets.numeric.run.eval_radial_dd_density" title="Link to this definition">#</a></dt>
420+
<dd><p>Helper function to compute the radial second derivative of the density.</p>
421+
<blockquote>
422+
<div><p>From a set of radial points <span class="math notranslate nohighlight">\(r\)</span>, the gradient of the density, <span class="math notranslate nohighlight">\(df/dr\)</span>, and the
423+
Laplacian of the density, :math:<a href="#id1"><span class="problematic" id="id2">`</span></a></p>
424+
</div></blockquote>
425+
<dl>
426+
<dt>abla^2 f`, the radial second derivative of the density is</dt><dd><p>computed as:</p>
427+
<div class="math notranslate nohighlight">
428+
\[d/dr (df/dr) = \]</div>
429+
</dd>
430+
</dl>
431+
<p>abla^2 f - 2/r * df/dr</p>
432+
<blockquote>
433+
<div><dl class="simple">
434+
<dt>gradient<span class="classifier">np.ndarray</span></dt><dd><p>Gradient of the density.</p>
435+
</dd>
436+
<dt>laplacian<span class="classifier">np.ndarray</span></dt><dd><p>Laplacian of the density.</p>
437+
</dd>
438+
<dt>points<span class="classifier">np.ndarray</span></dt><dd><p>Radial points where the density gradient and Laplacian are evaluated.</p>
439+
</dd>
440+
<dt>err<span class="classifier">str, optional</span></dt><dd><p>Error handling for division by zero.</p>
441+
</dd>
442+
<dt>tol<span class="classifier">float, optional</span></dt><dd><p>Tolerance for the points close to zero.</p>
443+
</dd>
444+
</dl>
445+
<dl class="simple">
446+
<dt>d2dens<span class="classifier">np.ndarray</span></dt><dd><p>Radial second derivative of the density.</p>
447+
</dd>
448+
</dl>
449+
<p>When the points are close to zero, the radial second derivative of the density tends to infinity.
450+
In this case, this function returns zero.</p>
451+
</div></blockquote>
452+
</dd></dl>
453+
414454
<dl class="py function">
415455
<dt class="sig sig-object py" id="atomdb.datasets.numeric.run.load_numerical_hf_data">
416-
<span class="sig-prename descclassname"><span class="pre">atomdb.datasets.numeric.run.</span></span><span class="sig-name descname"><span class="pre">load_numerical_hf_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#atomdb.datasets.numeric.run.load_numerical_hf_data" title="Link to this definition">#</a></dt>
456+
<span class="sig-prename descclassname"><span class="pre">atomdb.datasets.numeric.run.</span></span><span class="sig-name descname"><span class="pre">load_numerical_hf_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#atomdb.datasets.numeric.run.load_numerical_hf_data" title="Link to this definition">#</a></dt>
417457
<dd><p>Load data from desnity.out file into a <cite>SpeciesTable</cite>.</p>
458+
<section id="parameters">
459+
<h3>Parameters<a class="headerlink" href="#parameters" title="Link to this heading">#</a></h3>
460+
<dl class="simple">
461+
<dt>data_path<span class="classifier">str</span></dt><dd><p>Path to the directory containing a folder named <cite>raw</cite> where the desnity.out file is stored.</p>
462+
</dd>
463+
</dl>
464+
</section>
465+
<section id="returns">
466+
<h3>Returns<a class="headerlink" href="#returns" title="Link to this heading">#</a></h3>
467+
<dl class="simple">
468+
<dt>species<span class="classifier">dict</span></dt><dd><p>Dictionary of atomic species containing the information from the numeric Hartree-Fock calculation.
469+
This is energy components, grid, density, gradient, and laplacian values.</p>
470+
</dd>
471+
</dl>
472+
</section>
418473
</dd></dl>
419474

420475
<dl class="py function">
@@ -493,6 +548,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
493548
<ul class="visible nav section-nav flex-column">
494549
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submodules">Submodules</a></li>
495550
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-atomdb.datasets.numeric.run">atomdb.datasets.numeric.run module</a><ul class="nav section-nav flex-column">
551+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.eval_radial_dd_density"><code class="docutils literal notranslate"><span class="pre">eval_radial_dd_density()</span></code></a></li>
496552
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.load_numerical_hf_data"><code class="docutils literal notranslate"><span class="pre">load_numerical_hf_data()</span></code></a></li>
497553
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#atomdb.datasets.numeric.run.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li>
498554
</ul>

0 commit comments

Comments
 (0)