TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-11-04 21:24:08 +01:00
Code Issues Projects Releases Wiki Activity

Deploying to gh-pages from @ TREX-CoE/trexio@75ae5818b1 🚀

Browse Source
This commit is contained in:
q-posev 2024-08-17 20:42:43 +00:00
parent 7663e0d326
commit 5e0e9f7981
9 changed files with 667 additions and 667 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -406,7 +406,7 @@ The TREXIO library is licensed under the open-source 3-clause BSD license.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

172
examples.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Examples</title>
@ -346,61 +346,61 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org400fa53">1. Writing nuclear coordinates</a>
<li><a href="#org2a42af6">1. Writing nuclear coordinates</a>
<ul>
<li><a href="#org5228cf2">1.1. C</a></li>
<li><a href="#org4d5beea">1.2. Python</a></li>
<li><a href="#orgbf5ef7b">1.3. Fortran</a></li>
<li><a href="#orgfd32a2d">1.1. C</a></li>
<li><a href="#org727d26f">1.2. Python</a></li>
<li><a href="#org4513929">1.3. Fortran</a></li>
</ul>
</li>
<li><a href="#org8f7c734">2. Accessing sparse quantities (integrals)</a>
<li><a href="#org2afe172">2. Accessing sparse quantities (integrals)</a>
<ul>
<li><a href="#org315e428">2.1. Fortran</a>
<li><a href="#org4cdd307">2.1. Fortran</a>
<ul>
<li><a href="#org561f90c">2.1.1. Declare Temporary variables</a></li>
<li><a href="#orgd7c5d56">2.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
<li><a href="#orgd67465a">2.1.3. Read the nuclear repulsion energy</a></li>
<li><a href="#org4bfab0e">2.1.4. Read the number of molecular orbitals</a></li>
<li><a href="#org920d909">2.1.5. Allocate memory</a></li>
<li><a href="#orgfb4c78b">2.1.6. Read one-electron quantities</a></li>
<li><a href="#org9b26e9c">2.1.7. Read two-electron quantities</a>
<li><a href="#org0853f77">2.1.1. Declare Temporary variables</a></li>
<li><a href="#org97d08ed">2.1.2. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
<li><a href="#orgf395a77">2.1.3. Read the nuclear repulsion energy</a></li>
<li><a href="#org6026e8f">2.1.4. Read the number of molecular orbitals</a></li>
<li><a href="#orge561886">2.1.5. Allocate memory</a></li>
<li><a href="#orge7936d5">2.1.6. Read one-electron quantities</a></li>
<li><a href="#org476fa7b">2.1.7. Read two-electron quantities</a>
<ul>
<li><a href="#orge79b211">2.1.7.1. Electron repulsion integrals</a></li>
<li><a href="#orgbaeb463">2.1.7.2. Reduced density matrix</a></li>
<li><a href="#org266d58a">2.1.7.1. Electron repulsion integrals</a></li>
<li><a href="#org917aeaa">2.1.7.2. Reduced density matrix</a></li>
</ul>
</li>
<li><a href="#org73fbe42">2.1.8. Compute the energy</a></li>
<li><a href="#org2805014">2.1.9. Terminate</a></li>
<li><a href="#orgf347749">2.1.8. Compute the energy</a></li>
<li><a href="#orgcc286dd">2.1.9. Terminate</a></li>
</ul>
</li>
<li><a href="#org8574b41">2.2. Python</a>
<li><a href="#orgcb1f487">2.2. Python</a>
<ul>
<li><a href="#org2fc482e">2.2.1. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
<li><a href="#orge5d52d2">2.2.2. Read the nuclear repulsion energy</a></li>
<li><a href="#org0b89865">2.2.3. Read the number of molecular orbitals</a></li>
<li><a href="#org955fa3b">2.2.4. Read one-electron quantities</a></li>
<li><a href="#orgad8d4e6">2.2.5. Read two-electron quantities</a>
<li><a href="#org39cfa3f">2.2.1. Obtain the name of the TREXIO file from the command line, and open it for reading</a></li>
<li><a href="#org3f7d352">2.2.2. Read the nuclear repulsion energy</a></li>
<li><a href="#org98154c6">2.2.3. Read the number of molecular orbitals</a></li>
<li><a href="#orgaa647ae">2.2.4. Read one-electron quantities</a></li>
<li><a href="#orgc645875">2.2.5. Read two-electron quantities</a>
<ul>
<li><a href="#org3a41c57">2.2.5.1. Electron repulsion integrals</a></li>
<li><a href="#org3bb2ba9">2.2.5.2. Reduced density matrix</a></li>
<li><a href="#org36218e9">2.2.5.1. Electron repulsion integrals</a></li>
<li><a href="#orgdf82748">2.2.5.2. Reduced density matrix</a></li>
</ul>
</li>
<li><a href="#orgac2756c">2.2.6. Compute the energy</a></li>
<li><a href="#orgc7a7fde">2.2.6. Compute the energy</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orga23c9b6">3. Reading determinants</a>
<li><a href="#orge8b5196">3. Reading determinants</a>
<ul>
<li><a href="#orga89cd5b">3.1. Fortran</a></li>
<li><a href="#org65a05d4">3.1. Fortran</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org400fa53" class="outline-2">
<h2 id="org400fa53"><span class="section-number-2">1</span> Writing nuclear coordinates</h2>
<div id="outline-container-org2a42af6" class="outline-2">
<h2 id="org2a42af6"><span class="section-number-2">1</span> Writing nuclear coordinates</h2>
<div class="outline-text-2" id="text-1">
<p>
Here is a demonstration of how to use TREXIO to write the nuclear
@ -410,8 +410,8 @@ as well as the necessary TREXIO functions to perform these actions.
</p>
</div>
<div id="outline-container-org5228cf2" class="outline-3">
<h3 id="org5228cf2"><span class="section-number-3">1.1</span> C</h3>
<div id="outline-container-orgfd32a2d" class="outline-3">
<h3 id="orgfd32a2d"><span class="section-number-3">1.1</span> C</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#include</span> <span style="color: #8b2252;">&lt;stdio.h&gt;</span>
@ -461,8 +461,8 @@ as well as the necessary TREXIO functions to perform these actions.
</div>
</div>
<div id="outline-container-org4d5beea" class="outline-3">
<h3 id="org4d5beea"><span class="section-number-3">1.2</span> Python</h3>
<div id="outline-container-org727d26f" class="outline-3">
<h3 id="org727d26f"><span class="section-number-3">1.2</span> Python</h3>
<div class="outline-text-3" id="text-1-2">
<p>
This code uses the TREXIO Python binding to create a new TREXIO file named
@ -509,8 +509,8 @@ coordinates of the system.
</div>
</div>
<div id="outline-container-orgbf5ef7b" class="outline-3">
<h3 id="orgbf5ef7b"><span class="section-number-3">1.3</span> Fortran</h3>
<div id="outline-container-org4513929" class="outline-3">
<h3 id="org4513929"><span class="section-number-3">1.3</span> Fortran</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">program</span> <span style="color: #0000ff;">trexio_water</span>
@ -567,12 +567,12 @@ coordinates of the system.
</div>
</div>
<div id="outline-container-org8f7c734" class="outline-2">
<h2 id="org8f7c734"><span class="section-number-2">2</span> Accessing sparse quantities (integrals)</h2>
<div id="outline-container-org2afe172" class="outline-2">
<h2 id="org2afe172"><span class="section-number-2">2</span> Accessing sparse quantities (integrals)</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-org315e428" class="outline-3">
<h3 id="org315e428"><span class="section-number-3">2.1</span> Fortran</h3>
<div id="outline-container-org4cdd307" class="outline-3">
<h3 id="org4cdd307"><span class="section-number-3">2.1</span> Fortran</h3>
<div class="outline-text-3" id="text-2-1">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">program</span> <span style="color: #0000ff;">print_energy</span>
@ -618,8 +618,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-org561f90c" class="outline-4">
<h4 id="org561f90c"><span class="section-number-4">2.1.1</span> Declare Temporary variables</h4>
<div id="outline-container-org0853f77" class="outline-4">
<h4 id="org0853f77"><span class="section-number-4">2.1.1</span> Declare Temporary variables</h4>
<div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #228b22;">integer</span> ::<span style="color: #a0522d;"> i, j, k, l, m</span>
@ -634,8 +634,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-orgd7c5d56" class="outline-4">
<h4 id="orgd7c5d56"><span class="section-number-4">2.1.2</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4>
<div id="outline-container-org97d08ed" class="outline-4">
<h4 id="org97d08ed"><span class="section-number-4">2.1.2</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4>
<div class="outline-text-4" id="text-2-1-2">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">call</span> <span style="color: #0000ff;">getarg</span>(1, filename)
@ -651,8 +651,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_AUTO
</div>
</div>
<div id="outline-container-orgd67465a" class="outline-4">
<h4 id="orgd67465a"><span class="section-number-4">2.1.3</span> Read the nuclear repulsion energy</h4>
<div id="outline-container-orgf395a77" class="outline-4">
<h4 id="orgf395a77"><span class="section-number-4">2.1.3</span> Read the nuclear repulsion energy</h4>
<div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container">
<pre class="src src-f90">rc = trexio_read_nucleus_repulsion(f, E_nn)
@ -666,8 +666,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_AUTO
</div>
</div>
<div id="outline-container-org4bfab0e" class="outline-4">
<h4 id="org4bfab0e"><span class="section-number-4">2.1.4</span> Read the number of molecular orbitals</h4>
<div id="outline-container-org6026e8f" class="outline-4">
<h4 id="org6026e8f"><span class="section-number-4">2.1.4</span> Read the number of molecular orbitals</h4>
<div class="outline-text-4" id="text-2-1-4">
<div class="org-src-container">
<pre class="src src-f90">rc = trexio_read_mo_num(f, n)
@ -681,8 +681,8 @@ f = trexio_open (filename, <span style="color: #8b2252;">'r'</span>, TREXIO_AUTO
</div>
</div>
<div id="outline-container-org920d909" class="outline-4">
<h4 id="org920d909"><span class="section-number-4">2.1.5</span> Allocate memory</h4>
<div id="outline-container-orge561886" class="outline-4">
<h4 id="orge561886"><span class="section-number-4">2.1.5</span> Allocate memory</h4>
<div class="outline-text-4" id="text-2-1-5">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">allocate</span>( D(n,n), h0(n,n) )
@ -694,8 +694,8 @@ W(:,:,:,:) = 0.d0
</div>
</div>
<div id="outline-container-orgfb4c78b" class="outline-4">
<h4 id="orgfb4c78b"><span class="section-number-4">2.1.6</span> Read one-electron quantities</h4>
<div id="outline-container-orge7936d5" class="outline-4">
<h4 id="orge7936d5"><span class="section-number-4">2.1.6</span> Read one-electron quantities</h4>
<div class="outline-text-4" id="text-2-1-6">
<div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_mo_1e_int_core_hamiltonian(f)
@ -727,8 +727,8 @@ rc = trexio_read_rdm_1e(f, D)
</div>
</div>
<div id="outline-container-org9b26e9c" class="outline-4">
<h4 id="org9b26e9c"><span class="section-number-4">2.1.7</span> Read two-electron quantities</h4>
<div id="outline-container-org476fa7b" class="outline-4">
<h4 id="org476fa7b"><span class="section-number-4">2.1.7</span> Read two-electron quantities</h4>
<div class="outline-text-4" id="text-2-1-7">
<p>
Reading is done with OpenMP. Each thread reads its own buffer, and
@ -744,8 +744,8 @@ to be protected in the critical section when modified.
</p>
</div>
<div id="outline-container-orge79b211" class="outline-5">
<h5 id="orge79b211"><span class="section-number-5">2.1.7.1</span> Electron repulsion integrals</h5>
<div id="outline-container-org266d58a" class="outline-5">
<h5 id="org266d58a"><span class="section-number-5">2.1.7.1</span> Electron repulsion integrals</h5>
<div class="outline-text-5" id="text-2-1-7-1">
<div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_mo_2e_int_eri(f)
@ -794,8 +794,8 @@ icount = BUFSIZE
</div>
</div>
<div id="outline-container-orgbaeb463" class="outline-5">
<h5 id="orgbaeb463"><span class="section-number-5">2.1.7.2</span> Reduced density matrix</h5>
<div id="outline-container-org917aeaa" class="outline-5">
<h5 id="org917aeaa"><span class="section-number-5">2.1.7.2</span> Reduced density matrix</h5>
<div class="outline-text-5" id="text-2-1-7-2">
<div class="org-src-container">
<pre class="src src-f90">rc = trexio_has_rdm_2e(f)
@ -839,8 +839,8 @@ icount = bufsize
</div>
</div>
<div id="outline-container-org73fbe42" class="outline-4">
<h4 id="org73fbe42"><span class="section-number-4">2.1.8</span> Compute the energy</h4>
<div id="outline-container-orgf347749" class="outline-4">
<h4 id="orgf347749"><span class="section-number-4">2.1.8</span> Compute the energy</h4>
<div class="outline-text-4" id="text-2-1-8">
<p>
When the orbitals are real, we can use
@ -886,8 +886,8 @@ E = E + E_nn
</div>
</div>
<div id="outline-container-org2805014" class="outline-4">
<h4 id="org2805014"><span class="section-number-4">2.1.9</span> Terminate</h4>
<div id="outline-container-orgcc286dd" class="outline-4">
<h4 id="orgcc286dd"><span class="section-number-4">2.1.9</span> Terminate</h4>
<div class="outline-text-4" id="text-2-1-9">
<div class="org-src-container">
<pre class="src src-f90"> <span style="color: #a020f0;">deallocate</span>( D, h0, G, W )
@ -899,8 +899,8 @@ E = E + E_nn
</div>
</div>
<div id="outline-container-org8574b41" class="outline-3">
<h3 id="org8574b41"><span class="section-number-3">2.2</span> Python</h3>
<div id="outline-container-orgcb1f487" class="outline-3">
<h3 id="orgcb1f487"><span class="section-number-3">2.2</span> Python</h3>
<div class="outline-text-3" id="text-2-2">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a020f0;">import</span> sys
@ -934,8 +934,8 @@ One needs to read from the TREXIO file:
</dl>
</div>
<div id="outline-container-org2fc482e" class="outline-4">
<h4 id="org2fc482e"><span class="section-number-4">2.2.1</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4>
<div id="outline-container-org39cfa3f" class="outline-4">
<h4 id="org39cfa3f"><span class="section-number-4">2.2.1</span> Obtain the name of the TREXIO file from the command line, and open it for reading</h4>
<div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a0522d;">filename</span> = sys.argv[1]
@ -945,8 +945,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-orge5d52d2" class="outline-4">
<h4 id="orge5d52d2"><span class="section-number-4">2.2.2</span> Read the nuclear repulsion energy</h4>
<div id="outline-container-org3f7d352" class="outline-4">
<h4 id="org3f7d352"><span class="section-number-4">2.2.2</span> Read the nuclear repulsion energy</h4>
<div class="outline-text-4" id="text-2-2-2">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a0522d;">E_nn</span> = trexio.read_nucleus_repulsion(f)
@ -955,8 +955,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-org0b89865" class="outline-4">
<h4 id="org0b89865"><span class="section-number-4">2.2.3</span> Read the number of molecular orbitals</h4>
<div id="outline-container-org98154c6" class="outline-4">
<h4 id="org98154c6"><span class="section-number-4">2.2.3</span> Read the number of molecular orbitals</h4>
<div class="outline-text-4" id="text-2-2-3">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a0522d;">n</span> = trexio.read_mo_num(f)
@ -965,8 +965,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-org955fa3b" class="outline-4">
<h4 id="org955fa3b"><span class="section-number-4">2.2.4</span> Read one-electron quantities</h4>
<div id="outline-container-orgaa647ae" class="outline-4">
<h4 id="orgaa647ae"><span class="section-number-4">2.2.4</span> Read one-electron quantities</h4>
<div class="outline-text-4" id="text-2-2-4">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a020f0;">if</span> <span style="color: #a020f0;">not</span> trexio.has_mo_1e_int_core_hamiltonian(f):
@ -985,12 +985,12 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-orgad8d4e6" class="outline-4">
<h4 id="orgad8d4e6"><span class="section-number-4">2.2.5</span> Read two-electron quantities</h4>
<div id="outline-container-orgc645875" class="outline-4">
<h4 id="orgc645875"><span class="section-number-4">2.2.5</span> Read two-electron quantities</h4>
<div class="outline-text-4" id="text-2-2-5">
</div>
<div id="outline-container-org3a41c57" class="outline-5">
<h5 id="org3a41c57"><span class="section-number-5">2.2.5.1</span> Electron repulsion integrals</h5>
<div id="outline-container-org36218e9" class="outline-5">
<h5 id="org36218e9"><span class="section-number-5">2.2.5.1</span> Electron repulsion integrals</h5>
<div class="outline-text-5" id="text-2-2-5-1">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a020f0;">if</span> <span style="color: #a020f0;">not</span> trexio.has_mo_2e_int_eri(f):
@ -1020,8 +1020,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-org3bb2ba9" class="outline-5">
<h5 id="org3bb2ba9"><span class="section-number-5">2.2.5.2</span> Reduced density matrix</h5>
<div id="outline-container-orgdf82748" class="outline-5">
<h5 id="orgdf82748"><span class="section-number-5">2.2.5.2</span> Reduced density matrix</h5>
<div class="outline-text-5" id="text-2-2-5-2">
<div class="org-src-container">
<pre class="src src-python"><span style="color: #a020f0;">if</span> <span style="color: #a020f0;">not</span> trexio.has_rdm_2e(f):
@ -1043,8 +1043,8 @@ One needs to read from the TREXIO file:
</div>
</div>
<div id="outline-container-orgac2756c" class="outline-4">
<h4 id="orgac2756c"><span class="section-number-4">2.2.6</span> Compute the energy</h4>
<div id="outline-container-orgc7a7fde" class="outline-4">
<h4 id="orgc7a7fde"><span class="section-number-4">2.2.6</span> Compute the energy</h4>
<div class="outline-text-4" id="text-2-2-6">
<p>
When the orbitals are real, we can use
@ -1073,12 +1073,12 @@ E &=& E_{\text{NN}} + \sum_{ij} \gamma_{ij}\, \langle j | h | i \rangle\,
</div>
</div>
<div id="outline-container-orga23c9b6" class="outline-2">
<h2 id="orga23c9b6"><span class="section-number-2">3</span> Reading determinants</h2>
<div id="outline-container-orge8b5196" class="outline-2">
<h2 id="orge8b5196"><span class="section-number-2">3</span> Reading determinants</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-orga89cd5b" class="outline-3">
<h3 id="orga89cd5b"><span class="section-number-3">3.1</span> Fortran</h3>
<div id="outline-container-org65a05d4" class="outline-3">
<h3 id="org65a05d4"><span class="section-number-3">3.1</span> Fortran</h3>
<div class="outline-text-3" id="text-3-1">
<div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">program</span> <span style="color: #0000ff;">test</span>
@ -1157,7 +1157,7 @@ end
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

4
index.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -406,7 +406,7 @@ The TREXIO library is licensed under the open-source 3-clause BSD license.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

4
intro.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Motivation</title>
@ -384,7 +384,7 @@ still lacking, and the purpose of the TREXIO library is to fill this gap.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

58
lib.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>The TREXIO library</title>
@ -346,19 +346,19 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org010934f">1. Format specification</a>
<li><a href="#org7ed033b">1. Format specification</a>
<ul>
<li><a href="#org43c5340">1.1. Organization of the data</a></li>
<li><a href="#org53b1859">1.2. Data types</a></li>
<li><a href="#org28a99ee">1.1. Organization of the data</a></li>
<li><a href="#org8b6c7ea">1.2. Data types</a></li>
</ul>
</li>
<li><a href="#org8673b2a">2. The TREXIO library</a>
<li><a href="#orgaaaa250">2. The TREXIO library</a>
<ul>
<li><a href="#org31ae6b0">2.1. The front-end</a></li>
<li><a href="#org2b4502f">2.2. The back-end</a></li>
<li><a href="#org5ca1184">2.3. Supported languages</a></li>
<li><a href="#orgf081a39">2.4. Source code generation and documentation</a></li>
<li><a href="#org87ed0e7">2.5. Availability</a></li>
<li><a href="#org0058111">2.1. The front-end</a></li>
<li><a href="#orgf81e24e">2.2. The back-end</a></li>
<li><a href="#org083c787">2.3. Supported languages</a></li>
<li><a href="#orgfdb4217">2.4. Source code generation and documentation</a></li>
<li><a href="#org5370233">2.5. Availability</a></li>
</ul>
</li>
</ul>
@ -366,8 +366,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org010934f" class="outline-2">
<h2 id="org010934f"><span class="section-number-2">1</span> Format specification</h2>
<div id="outline-container-org7ed033b" class="outline-2">
<h2 id="org7ed033b"><span class="section-number-2">1</span> Format specification</h2>
<div class="outline-text-2" id="text-1">
</td>
<td>
@ -388,8 +388,8 @@ calculation are stored.
</p>
</div>
<div id="outline-container-org43c5340" class="outline-3">
<h3 id="org43c5340"><span class="section-number-3">1.1</span> Organization of the data</h3>
<div id="outline-container-org28a99ee" class="outline-3">
<h3 id="org28a99ee"><span class="section-number-3">1.1</span> Organization of the data</h3>
<div class="outline-text-3" id="text-1-1">
<p>
The data in TREXIO are organized into <b>groups</b>, each containing
@ -405,8 +405,8 @@ number of nuclei.
</div>
</div>
<div id="outline-container-org53b1859" class="outline-3">
<h3 id="org53b1859"><span class="section-number-3">1.2</span> Data types</h3>
<div id="outline-container-org8b6c7ea" class="outline-3">
<h3 id="org8b6c7ea"><span class="section-number-3">1.2</span> Data types</h3>
<div class="outline-text-3" id="text-1-2">
<p>
So that TREXIO can be used in any language, we use a limited number
@ -473,8 +473,8 @@ with the same name suffixed by <code>_im</code>.
</div>
</div>
<div id="outline-container-org8673b2a" class="outline-2">
<h2 id="org8673b2a"><span class="section-number-2">2</span> The TREXIO library</h2>
<div id="outline-container-orgaaaa250" class="outline-2">
<h2 id="orgaaaa250"><span class="section-number-2">2</span> The TREXIO library</h2>
<div class="outline-text-2" id="text-2">
</td>
<td>
@ -497,8 +497,8 @@ interface between the library and the physical storage.
</p>
</div>
<div id="outline-container-org31ae6b0" class="outline-3">
<h3 id="org31ae6b0"><span class="section-number-3">2.1</span> The front-end</h3>
<div id="outline-container-org0058111" class="outline-3">
<h3 id="org0058111"><span class="section-number-3">2.1</span> The front-end</h3>
<div class="outline-text-3" id="text-2-1">
<p>
By using the TREXIO library, users can store and extract data in a
@ -539,8 +539,8 @@ made are safe.
</div>
</div>
<div id="outline-container-org2b4502f" class="outline-3">
<h3 id="org2b4502f"><span class="section-number-3">2.2</span> The back-end</h3>
<div id="outline-container-orgf81e24e" class="outline-3">
<h3 id="orgf81e24e"><span class="section-number-3">2.2</span> The back-end</h3>
<div class="outline-text-3" id="text-2-2">
<p>
At present, TREXIO supports two back-ends: one relying only on the
@ -610,8 +610,8 @@ repositories.
</div>
</div>
<div id="outline-container-org5ca1184" class="outline-3">
<h3 id="org5ca1184"><span class="section-number-3">2.3</span> Supported languages</h3>
<div id="outline-container-org083c787" class="outline-3">
<h3 id="org083c787"><span class="section-number-3">2.3</span> Supported languages</h3>
<div class="outline-text-3" id="text-2-3">
<p>
One of the main benefits of using C as the interface for a library is
@ -668,8 +668,8 @@ via the Binder platform.
</div>
<div id="outline-container-orgf081a39" class="outline-3">
<h3 id="orgf081a39"><span class="section-number-3">2.4</span> Source code generation and documentation</h3>
<div id="outline-container-orgfdb4217" class="outline-3">
<h3 id="orgfdb4217"><span class="section-number-3">2.4</span> Source code generation and documentation</h3>
<div class="outline-text-3" id="text-2-4">
<p>
Source code generation is a valuable technique that can significantly
@ -723,8 +723,8 @@ regardless of their programming skills.
</div>
</div>
<div id="outline-container-org87ed0e7" class="outline-3">
<h3 id="org87ed0e7"><span class="section-number-3">2.5</span> Availability</h3>
<div id="outline-container-org5370233" class="outline-3">
<h3 id="org5370233"><span class="section-number-3">2.5</span> Availability</h3>
<div class="outline-text-3" id="text-2-5">
<p>
The TREXIO library is designed to be portable and easy to install
@ -754,7 +754,7 @@ are available in Ubuntu 23.04.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

650
templator_front.html
View File

File diff suppressed because it is too large Load Diff

82
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title>
@ -324,25 +324,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org7bd47b7">1. Template for HDF5 definitions</a></li>
<li><a href="#orgfb1b9be">2. Template for HDF5 structures</a></li>
<li><a href="#org6621000">3. Template for HDF5 init/deinit</a></li>
<li><a href="#org4d14a21">4. Template for HDF5 has a group</a></li>
<li><a href="#orgfedc676">5. Template for HDF5 has/read/write a numerical attribute</a></li>
<li><a href="#org2aa871b">6. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org3624c47">7. Template for HDF5 has/read/write a dataset of sparse data</a></li>
<li><a href="#orgdbc7d08">8. Template for HDF5 has/read/write a dataset of buffered vectors</a></li>
<li><a href="#orgf280727">9. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#orgbb28145">10. Template for HDF5 has/read/write a string attribute</a></li>
<li><a href="#org259da9f">11. Template for HDF5 delete a group (UNSAFE mode)</a></li>
<li><a href="#orgbe33074">12. Source code for the determinant part</a></li>
<li><a href="#orgdc6d1bf">13. Helper functions</a></li>
<li><a href="#org600f775">1. Template for HDF5 definitions</a></li>
<li><a href="#org7cb8d97">2. Template for HDF5 structures</a></li>
<li><a href="#orgb0e461b">3. Template for HDF5 init/deinit</a></li>
<li><a href="#org9ff9869">4. Template for HDF5 has a group</a></li>
<li><a href="#org3a71ea7">5. Template for HDF5 has/read/write a numerical attribute</a></li>
<li><a href="#org248b0eb">6. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org00e24d4">7. Template for HDF5 has/read/write a dataset of sparse data</a></li>
<li><a href="#org58fd723">8. Template for HDF5 has/read/write a dataset of buffered vectors</a></li>
<li><a href="#org101ef02">9. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#org7cca1a2">10. Template for HDF5 has/read/write a string attribute</a></li>
<li><a href="#orgf3ee45b">11. Template for HDF5 delete a group (UNSAFE mode)</a></li>
<li><a href="#org02967d5">12. Source code for the determinant part</a></li>
<li><a href="#orga14147c">13. Helper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-org7bd47b7" class="outline-2">
<h2 id="org7bd47b7"><span class="section-number-2">1</span> Template for HDF5 definitions</h2>
<div id="outline-container-org600f775" class="outline-2">
<h2 id="org600f775"><span class="section-number-2">1</span> Template for HDF5 definitions</h2>
<div class="outline-text-2" id="text-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
@ -354,8 +354,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgfb1b9be" class="outline-2">
<h2 id="orgfb1b9be"><span class="section-number-2">2</span> Template for HDF5 structures</h2>
<div id="outline-container-org7cb8d97" class="outline-2">
<h2 id="org7cb8d97"><span class="section-number-2">2</span> Template for HDF5 structures</h2>
<div class="outline-text-2" id="text-2">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -375,8 +375,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org6621000" class="outline-2">
<h2 id="org6621000"><span class="section-number-2">3</span> Template for HDF5 init/deinit</h2>
<div id="outline-container-orgb0e461b" class="outline-2">
<h2 id="orgb0e461b"><span class="section-number-2">3</span> Template for HDF5 init/deinit</h2>
<div class="outline-text-2" id="text-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -496,8 +496,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org4d14a21" class="outline-2">
<h2 id="org4d14a21"><span class="section-number-2">4</span> Template for HDF5 has a group</h2>
<div id="outline-container-org9ff9869" class="outline-2">
<h2 id="org9ff9869"><span class="section-number-2">4</span> Template for HDF5 has a group</h2>
<div class="outline-text-2" id="text-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -527,8 +527,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-orgfedc676" class="outline-2">
<h2 id="orgfedc676"><span class="section-number-2">5</span> Template for HDF5 has/read/write a numerical attribute</h2>
<div id="outline-container-org3a71ea7" class="outline-2">
<h2 id="org3a71ea7"><span class="section-number-2">5</span> Template for HDF5 has/read/write a numerical attribute</h2>
<div class="outline-text-2" id="text-5">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -632,8 +632,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org2aa871b" class="outline-2">
<h2 id="org2aa871b"><span class="section-number-2">6</span> Template for HDF5 has/read/write a dataset of numerical data</h2>
<div id="outline-container-org248b0eb" class="outline-2">
<h2 id="org248b0eb"><span class="section-number-2">6</span> Template for HDF5 has/read/write a dataset of numerical data</h2>
<div class="outline-text-2" id="text-6">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -770,8 +770,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org3624c47" class="outline-2">
<h2 id="org3624c47"><span class="section-number-2">7</span> Template for HDF5 has/read/write a dataset of sparse data</h2>
<div id="outline-container-org00e24d4" class="outline-2">
<h2 id="org00e24d4"><span class="section-number-2">7</span> Template for HDF5 has/read/write a dataset of sparse data</h2>
<div class="outline-text-2" id="text-7">
<p>
Sparse data is stored using extensible datasets of HDF5. Extensibility is required
@ -976,8 +976,8 @@ due to the fact that the sparse data will be written in chunks of user-defined s
</div>
</div>
<div id="outline-container-orgdbc7d08" class="outline-2">
<h2 id="orgdbc7d08"><span class="section-number-2">8</span> Template for HDF5 has/read/write a dataset of buffered vectors</h2>
<div id="outline-container-org58fd723" class="outline-2">
<h2 id="org58fd723"><span class="section-number-2">8</span> Template for HDF5 has/read/write a dataset of buffered vectors</h2>
<div class="outline-text-2" id="text-8">
<p>
Chunked I/O in HDF5 for <code>buffered</code> data.
@ -1111,8 +1111,8 @@ Chunked I/O in HDF5 for <code>buffered</code> data.
</div>
</div>
<div id="outline-container-orgf280727" class="outline-2">
<h2 id="orgf280727"><span class="section-number-2">9</span> Template for HDF5 has/read/write a dataset of strings</h2>
<div id="outline-container-org101ef02" class="outline-2">
<h2 id="org101ef02"><span class="section-number-2">9</span> Template for HDF5 has/read/write a dataset of strings</h2>
<div class="outline-text-2" id="text-9">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1309,8 +1309,8 @@ Chunked I/O in HDF5 for <code>buffered</code> data.
</div>
</div>
<div id="outline-container-orgbb28145" class="outline-2">
<h2 id="orgbb28145"><span class="section-number-2">10</span> Template for HDF5 has/read/write a string attribute</h2>
<div id="outline-container-org7cca1a2" class="outline-2">
<h2 id="org7cca1a2"><span class="section-number-2">10</span> Template for HDF5 has/read/write a string attribute</h2>
<div class="outline-text-2" id="text-10">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1437,8 +1437,8 @@ Chunked I/O in HDF5 for <code>buffered</code> data.
</div>
</div>
</div>
<div id="outline-container-org259da9f" class="outline-2">
<h2 id="org259da9f"><span class="section-number-2">11</span> Template for HDF5 delete a group (UNSAFE mode)</h2>
<div id="outline-container-orgf3ee45b" class="outline-2">
<h2 id="orgf3ee45b"><span class="section-number-2">11</span> Template for HDF5 delete a group (UNSAFE mode)</h2>
<div class="outline-text-2" id="text-11">
<p>
<b><b>Note:</b></b> in early versions of the HDF5 library (v &lt; 1.10) unlinking an object was not working as expected
@ -1478,8 +1478,8 @@ Thus, any corrupted/lost file space will remain in the first file. The use of <c
</div>
</div>
<div id="outline-container-orgbe33074" class="outline-2">
<h2 id="orgbe33074"><span class="section-number-2">12</span> Source code for the determinant part</h2>
<div id="outline-container-org02967d5" class="outline-2">
<h2 id="org02967d5"><span class="section-number-2">12</span> Source code for the determinant part</h2>
<div class="outline-text-2" id="text-12">
<p>
Each array is stored in a separate HDF5 dataset due to the fact that determinant I/O has to be decoupled.
@ -1581,8 +1581,8 @@ Size specifies the number of data items (e.g. determinants) to process.
</div>
</div>
<div id="outline-container-orgdc6d1bf" class="outline-2">
<h2 id="orgdc6d1bf"><span class="section-number-2">13</span> Helper functions</h2>
<div id="outline-container-orga14147c" class="outline-2">
<h2 id="orga14147c"><span class="section-number-2">13</span> Helper functions</h2>
<div class="outline-text-2" id="text-13">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1850,7 +1850,7 @@ Size specifies the number of data items (e.g. determinants) to process.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

106
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title>
@ -324,23 +324,23 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org6de44b4">1. Template for group-related structures in text back end</a></li>
<li><a href="#org34c4234">2. Template for general structure in text back end</a></li>
<li><a href="#org0cbfd3f">3. Initialize function (constant part)</a></li>
<li><a href="#orgf0cb5e7">4. Deinitialize function (templated part)</a></li>
<li><a href="#org40bd743">5. Flush function (templated part)</a></li>
<li><a href="#orgc0bec9b">6. Template for text read a group</a></li>
<li><a href="#org7531f7f">7. Template for text has a group</a></li>
<li><a href="#org812f6ac">8. Template for text flush a group</a></li>
<li><a href="#orge2182da">9. Template for text free memory</a></li>
<li><a href="#orgb81d257">10. Template for has/read/write a numerical attribute</a></li>
<li><a href="#org7df2525">11. Template for has/read/write a dataset of numerical data</a></li>
<li><a href="#orge9bb095">12. Template for has/read/write a dataset of strings</a></li>
<li><a href="#orgb948bac">13. Template for has/read/write a string attribute</a></li>
<li><a href="#org72d09e8">14. Template for has/read/write the dataset of sparse data</a></li>
<li><a href="#org49dd951">15. Template for has/read/write a buffered vector</a></li>
<li><a href="#org703edc9">16. Template for text delete a group (UNSAFE mode)</a></li>
<li><a href="#org98917af">17. Source code for the determinant part</a></li>
<li><a href="#org150e0f2">1. Template for group-related structures in text back end</a></li>
<li><a href="#org27174c4">2. Template for general structure in text back end</a></li>
<li><a href="#org120dbd4">3. Initialize function (constant part)</a></li>
<li><a href="#org1415ec5">4. Deinitialize function (templated part)</a></li>
<li><a href="#org7c111ef">5. Flush function (templated part)</a></li>
<li><a href="#org4736778">6. Template for text read a group</a></li>
<li><a href="#org1d488e7">7. Template for text has a group</a></li>
<li><a href="#orge8fee56">8. Template for text flush a group</a></li>
<li><a href="#org2d67d62">9. Template for text free memory</a></li>
<li><a href="#org547a70d">10. Template for has/read/write a numerical attribute</a></li>
<li><a href="#org4a3c33b">11. Template for has/read/write a dataset of numerical data</a></li>
<li><a href="#orgae1139e">12. Template for has/read/write a dataset of strings</a></li>
<li><a href="#orgee380c0">13. Template for has/read/write a string attribute</a></li>
<li><a href="#org2bdd27b">14. Template for has/read/write the dataset of sparse data</a></li>
<li><a href="#org1a27553">15. Template for has/read/write a buffered vector</a></li>
<li><a href="#orgd5db8a6">16. Template for text delete a group (UNSAFE mode)</a></li>
<li><a href="#org2634565">17. Source code for the determinant part</a></li>
</ul>
</div>
</div>
@ -362,8 +362,8 @@ directory.
The file is written when closed, or when the flush function is called.
</p>
<div id="outline-container-org6de44b4" class="outline-2">
<h2 id="org6de44b4"><span class="section-number-2">1</span> Template for group-related structures in text back end</h2>
<div id="outline-container-org150e0f2" class="outline-2">
<h2 id="org150e0f2"><span class="section-number-2">1</span> Template for group-related structures in text back end</h2>
<div class="outline-text-2" id="text-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
@ -382,8 +382,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org34c4234" class="outline-2">
<h2 id="org34c4234"><span class="section-number-2">2</span> Template for general structure in text back end</h2>
<div id="outline-container-org27174c4" class="outline-2">
<h2 id="org27174c4"><span class="section-number-2">2</span> Template for general structure in text back end</h2>
<div class="outline-text-2" id="text-2">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -403,8 +403,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org0cbfd3f" class="outline-2">
<h2 id="org0cbfd3f"><span class="section-number-2">3</span> Initialize function (constant part)</h2>
<div id="outline-container-org120dbd4" class="outline-2">
<h2 id="org120dbd4"><span class="section-number-2">3</span> Initialize function (constant part)</h2>
<div class="outline-text-2" id="text-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">bool</span>
@ -601,8 +601,8 @@ In that case, we define an alternate one, which is not as safe as the original o
</div>
</div>
<div id="outline-container-orgf0cb5e7" class="outline-2">
<h2 id="orgf0cb5e7"><span class="section-number-2">4</span> Deinitialize function (templated part)</h2>
<div id="outline-container-org1415ec5" class="outline-2">
<h2 id="org1415ec5"><span class="section-number-2">4</span> Deinitialize function (templated part)</h2>
<div class="outline-text-2" id="text-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -624,8 +624,8 @@ In that case, we define an alternate one, which is not as safe as the original o
</div>
</div>
<div id="outline-container-org40bd743" class="outline-2">
<h2 id="org40bd743"><span class="section-number-2">5</span> Flush function (templated part)</h2>
<div id="outline-container-org7c111ef" class="outline-2">
<h2 id="org7c111ef"><span class="section-number-2">5</span> Flush function (templated part)</h2>
<div class="outline-text-2" id="text-5">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -648,8 +648,8 @@ In that case, we define an alternate one, which is not as safe as the original o
</div>
</div>
<div id="outline-container-orgc0bec9b" class="outline-2">
<h2 id="orgc0bec9b"><span class="section-number-2">6</span> Template for text read a group</h2>
<div id="outline-container-org4736778" class="outline-2">
<h2 id="org4736778"><span class="section-number-2">6</span> Template for text read a group</h2>
<div class="outline-text-2" id="text-6">
<div class="org-src-container">
<pre class="src src-c">$group$_t*
@ -875,8 +875,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org7531f7f" class="outline-2">
<h2 id="org7531f7f"><span class="section-number-2">7</span> Template for text has a group</h2>
<div id="outline-container-org1d488e7" class="outline-2">
<h2 id="org1d488e7"><span class="section-number-2">7</span> Template for text has a group</h2>
<div class="outline-text-2" id="text-7">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -916,8 +916,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org812f6ac" class="outline-2">
<h2 id="org812f6ac"><span class="section-number-2">8</span> Template for text flush a group</h2>
<div id="outline-container-orge8fee56" class="outline-2">
<h2 id="orge8fee56"><span class="section-number-2">8</span> Template for text flush a group</h2>
<div class="outline-text-2" id="text-8">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -981,8 +981,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orge2182da" class="outline-2">
<h2 id="orge2182da"><span class="section-number-2">9</span> Template for text free memory</h2>
<div id="outline-container-org2d67d62" class="outline-2">
<h2 id="org2d67d62"><span class="section-number-2">9</span> Template for text free memory</h2>
<div class="outline-text-2" id="text-9">
<p>
Memory is allocated when reading. The following function frees memory.
@ -1051,8 +1051,8 @@ This function is called upon the non-successful exit from the <code>trexio_text_
</div>
</div>
<div id="outline-container-orgb81d257" class="outline-2">
<h2 id="orgb81d257"><span class="section-number-2">10</span> Template for has/read/write a numerical attribute</h2>
<div id="outline-container-org547a70d" class="outline-2">
<h2 id="org547a70d"><span class="section-number-2">10</span> Template for has/read/write a numerical attribute</h2>
<div class="outline-text-2" id="text-10">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1115,8 +1115,8 @@ This function is called upon the non-successful exit from the <code>trexio_text_
</div>
</div>
<div id="outline-container-org7df2525" class="outline-2">
<h2 id="org7df2525"><span class="section-number-2">11</span> Template for has/read/write a dataset of numerical data</h2>
<div id="outline-container-org4a3c33b" class="outline-2">
<h2 id="org4a3c33b"><span class="section-number-2">11</span> Template for has/read/write a dataset of numerical data</h2>
<div class="outline-text-2" id="text-11">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1212,8 +1212,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-orge9bb095" class="outline-2">
<h2 id="orge9bb095"><span class="section-number-2">12</span> Template for has/read/write a dataset of strings</h2>
<div id="outline-container-orgae1139e" class="outline-2">
<h2 id="orgae1139e"><span class="section-number-2">12</span> Template for has/read/write a dataset of strings</h2>
<div class="outline-text-2" id="text-12">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1314,8 +1314,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-orgb948bac" class="outline-2">
<h2 id="orgb948bac"><span class="section-number-2">13</span> Template for has/read/write a string attribute</h2>
<div id="outline-container-orgee380c0" class="outline-2">
<h2 id="orgee380c0"><span class="section-number-2">13</span> Template for has/read/write a string attribute</h2>
<div class="outline-text-2" id="text-13">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1389,8 +1389,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org72d09e8" class="outline-2">
<h2 id="org72d09e8"><span class="section-number-2">14</span> Template for has/read/write the dataset of sparse data</h2>
<div id="outline-container-org2bdd27b" class="outline-2">
<h2 id="org2bdd27b"><span class="section-number-2">14</span> Template for has/read/write the dataset of sparse data</h2>
<div class="outline-text-2" id="text-14">
<p>
Each sparse array is stored in a separate <code>.txt</code> file due to the fact that sparse I/O has to be decoupled
@ -1680,8 +1680,8 @@ User provides indices and values of the sparse array as two separate variables.
</div>
</div>
<div id="outline-container-org49dd951" class="outline-2">
<h2 id="org49dd951"><span class="section-number-2">15</span> Template for has/read/write a buffered vector</h2>
<div id="outline-container-org1a27553" class="outline-2">
<h2 id="org1a27553"><span class="section-number-2">15</span> Template for has/read/write a buffered vector</h2>
<div class="outline-text-2" id="text-15">
<p>
Each array is stored in a separate <code>.txt</code> file due to the fact that buffered I/O has to be decoupled
@ -1911,8 +1911,8 @@ Size specifies the number of vector elements to be written.
</div>
</div>
</div>
<div id="outline-container-org703edc9" class="outline-2">
<h2 id="org703edc9"><span class="section-number-2">16</span> Template for text delete a group (UNSAFE mode)</h2>
<div id="outline-container-orgd5db8a6" class="outline-2">
<h2 id="orgd5db8a6"><span class="section-number-2">16</span> Template for text delete a group (UNSAFE mode)</h2>
<div class="outline-text-2" id="text-16">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1940,8 +1940,8 @@ Size specifies the number of vector elements to be written.
</div>
</div>
<div id="outline-container-org98917af" class="outline-2">
<h2 id="org98917af"><span class="section-number-2">17</span> Source code for the determinant part</h2>
<div id="outline-container-org2634565" class="outline-2">
<h2 id="org2634565"><span class="section-number-2">17</span> Source code for the determinant part</h2>
<div class="outline-text-2" id="text-17">
<p>
Each array is stored in a separate <code>.txt</code> file due to the fact that determinant I/O has to be decoupled
@ -2133,7 +2133,7 @@ Size specifies the number of data items, e.g. determinants.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

254
trex.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-08-17 Sat 20:27 -->
<!-- 2024-08-17 Sat 20:42 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Data stored in TREXIO</title>
@ -346,72 +346,72 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org9f0180a">1. Metadata (metadata group)</a></li>
<li><a href="#org01feec0">2. System</a>
<li><a href="#org9543bbf">1. Metadata (metadata group)</a></li>
<li><a href="#orgc495a24">2. System</a>
<ul>
<li><a href="#orgf08b0d0">2.1. Nucleus (nucleus group)</a></li>
<li><a href="#org823cd3b">2.2. Cell (cell group)</a></li>
<li><a href="#orgcf9b902">2.3. Periodic boundary calculations (pbc group)</a></li>
<li><a href="#orgc0e5108">2.4. Electron (electron group)</a></li>
<li><a href="#org5c14721">2.5. Ground or excited states (state group)</a></li>
<li><a href="#orgede7deb">2.1. Nucleus (nucleus group)</a></li>
<li><a href="#orgb0da0e4">2.2. Cell (cell group)</a></li>
<li><a href="#orgdb404c3">2.3. Periodic boundary calculations (pbc group)</a></li>
<li><a href="#orgddef078">2.4. Electron (electron group)</a></li>
<li><a href="#org575102f">2.5. Ground or excited states (state group)</a></li>
</ul>
</li>
<li><a href="#org6a5aeca">3. Basis functions</a>
<li><a href="#org882ca39">3. Basis functions</a>
<ul>
<li><a href="#org822cd5b">3.1. Basis set (basis group)</a>
<li><a href="#org9e37dbc">3.1. Basis set (basis group)</a>
<ul>
<li><a href="#org09402b2">3.1.1. Gaussian and Slater-type orbitals</a></li>
<li><a href="#org8901886">3.1.2. Numerical orbitals</a></li>
<li><a href="#org873597d">3.1.3. Plane waves</a></li>
<li><a href="#org0590568">3.1.4. Oscillating orbitals</a></li>
<li><a href="#org56396c3">3.1.5. Data definitions</a></li>
<li><a href="#orgd5ef5d7">3.1.6. Example</a></li>
<li><a href="#org9bb0d96">3.1.1. Gaussian and Slater-type orbitals</a></li>
<li><a href="#org5579ae1">3.1.2. Numerical orbitals</a></li>
<li><a href="#org14eb109">3.1.3. Plane waves</a></li>
<li><a href="#org0e951d0">3.1.4. Oscillating orbitals</a></li>
<li><a href="#orge91ef29">3.1.5. Data definitions</a></li>
<li><a href="#org05d9df9">3.1.6. Example</a></li>
</ul>
</li>
<li><a href="#org444ad2c">3.2. Effective core potentials (ecp group)</a>
<li><a href="#orgac095be">3.2. Effective core potentials (ecp group)</a>
<ul>
<li><a href="#orgfc02cd5">3.2.1. Example</a></li>
<li><a href="#org7424aa0">3.2.1. Example</a></li>
</ul>
</li>
<li><a href="#org761b288">3.3. Numerical integration grid (grid group)</a></li>
<li><a href="#orgdd68eef">3.3. Numerical integration grid (grid group)</a></li>
</ul>
</li>
<li><a href="#org49cdb83">4. Orbitals</a>
<li><a href="#orgc897907">4. Orbitals</a>
<ul>
<li><a href="#orge796f49">4.1. Atomic orbitals (ao group)</a>
<li><a href="#org6a3b9dc">4.1. Atomic orbitals (ao group)</a>
<ul>
<li><a href="#ao_one_e">4.1.1. One-electron integrals (<code>ao_1e_int</code> group)</a></li>
<li><a href="#ao_two_e">4.1.2. Two-electron integrals (<code>ao_2e_int</code> group)</a></li>
</ul>
</li>
<li><a href="#orga2a9c35">4.2. Molecular orbitals (mo group)</a>
<li><a href="#orga35c161">4.2. Molecular orbitals (mo group)</a>
<ul>
<li><a href="#org02a784c">4.2.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
<li><a href="#org5e866ba">4.2.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
<li><a href="#org322c69c">4.2.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
<li><a href="#orgf2821a9">4.2.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orge99a418">5. Multi-determinant information</a>
<li><a href="#org6bd7af0">5. Multi-determinant information</a>
<ul>
<li><a href="#orgd6c2373">5.1. Slater determinants (determinant group)</a></li>
<li><a href="#org55c9b57">5.2. Configuration state functions (csf group)</a></li>
<li><a href="#org7d6c586">5.3. Amplitudes (amplitude group)</a></li>
<li><a href="#orgbcb3817">5.4. Reduced density matrices (rdm group)</a></li>
<li><a href="#org5f5fa5a">5.1. Slater determinants (determinant group)</a></li>
<li><a href="#orge81fa5d">5.2. Configuration state functions (csf group)</a></li>
<li><a href="#org222c260">5.3. Amplitudes (amplitude group)</a></li>
<li><a href="#org75efef0">5.4. Reduced density matrices (rdm group)</a></li>
</ul>
</li>
<li><a href="#org22d7c18">6. Correlation factors</a>
<li><a href="#orgd25b3f4">6. Correlation factors</a>
<ul>
<li><a href="#org432fca4">6.1. Jastrow factor (jastrow group)</a>
<li><a href="#org602ff81">6.1. Jastrow factor (jastrow group)</a>
<ul>
<li><a href="#org04b0804">6.1.1. CHAMP</a></li>
<li><a href="#org496e533">6.1.2. Mu</a></li>
<li><a href="#org1ca335f">6.1.3. Table of values</a></li>
<li><a href="#org6fa9c05">6.1.1. CHAMP</a></li>
<li><a href="#org7ecb640">6.1.2. Mu</a></li>
<li><a href="#orgfa933de">6.1.3. Table of values</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org66f0633">7. Quantum Monte Carlo data (qmc group)</a></li>
<li><a href="#orge6f2f52">7. Quantum Monte Carlo data (qmc group)</a></li>
</ul>
</div>
</div>
@ -433,8 +433,8 @@ contiguous in memory. In the row-major representation, <code>A[i,j]</code> and
<code>A[i,j+1]</code> are contiguous.
</p>
<div id="outline-container-org9f0180a" class="outline-2">
<h2 id="org9f0180a"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
<div id="outline-container-org9543bbf" class="outline-2">
<h2 id="org9543bbf"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
<div class="outline-text-2" id="text-1">
<p>
As we expect TREXIO files to be archived in open-data repositories,
@ -444,7 +444,7 @@ have participated to the creation of the file, a list of authors of
the file, and a textual description.
</p>
<table id="org696983d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org7ee6f8e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -537,19 +537,19 @@ value can be manually overwritten (in unsafe mode) from <code>1</code> to <code>
</div>
</div>
<div id="outline-container-org01feec0" class="outline-2">
<h2 id="org01feec0"><span class="section-number-2">2</span> System</h2>
<div id="outline-container-orgc495a24" class="outline-2">
<h2 id="orgc495a24"><span class="section-number-2">2</span> System</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-orgf08b0d0" class="outline-3">
<h3 id="orgf08b0d0"><span class="section-number-3">2.1</span> Nucleus (nucleus group)</h3>
<div id="outline-container-orgede7deb" class="outline-3">
<h3 id="orgede7deb"><span class="section-number-3">2.1</span> Nucleus (nucleus group)</h3>
<div class="outline-text-3" id="text-2-1">
<p>
The nuclei are considered as fixed point charges. Coordinates are
given in Cartesian \((x,y,z)\) format.
</p>
<table id="orgcc10711" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org6d21372" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -634,15 +634,15 @@ given in Cartesian \((x,y,z)\) format.
</div>
</div>
<div id="outline-container-org823cd3b" class="outline-3">
<h3 id="org823cd3b"><span class="section-number-3">2.2</span> Cell (cell group)</h3>
<div id="outline-container-orgb0da0e4" class="outline-3">
<h3 id="orgb0da0e4"><span class="section-number-3">2.2</span> Cell (cell group)</h3>
<div class="outline-text-3" id="text-2-2">
<p>
3 Lattice vectors to define a box containing the system, for example
used in periodic calculations.
</p>
<table id="org1c3bbf1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org7a28a81" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -726,10 +726,10 @@ used in periodic calculations.
</div>
</div>
<div id="outline-container-orgcf9b902" class="outline-3">
<h3 id="orgcf9b902"><span class="section-number-3">2.3</span> Periodic boundary calculations (pbc group)</h3>
<div id="outline-container-orgdb404c3" class="outline-3">
<h3 id="orgdb404c3"><span class="section-number-3">2.3</span> Periodic boundary calculations (pbc group)</h3>
<div class="outline-text-3" id="text-2-3">
<table id="org47a1a4c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org403a612" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -789,8 +789,8 @@ used in periodic calculations.
</div>
</div>
<div id="outline-container-orgc0e5108" class="outline-3">
<h3 id="orgc0e5108"><span class="section-number-3">2.4</span> Electron (electron group)</h3>
<div id="outline-container-orgddef078" class="outline-3">
<h3 id="orgddef078"><span class="section-number-3">2.4</span> Electron (electron group)</h3>
<div class="outline-text-3" id="text-2-4">
<p>
The chemical system consists of nuclei and electrons, where the
@ -809,7 +809,7 @@ the number of &uarr; and &darr; electrons is fixed.
</p>
<table id="org718e52d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orga85edfd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -861,8 +861,8 @@ the number of &uarr; and &darr; electrons is fixed.
</div>
</div>
<div id="outline-container-org5c14721" class="outline-3">
<h3 id="org5c14721"><span class="section-number-3">2.5</span> Ground or excited states (state group)</h3>
<div id="outline-container-org575102f" class="outline-3">
<h3 id="org575102f"><span class="section-number-3">2.5</span> Ground or excited states (state group)</h3>
<div class="outline-text-3" id="text-2-5">
<p>
This group contains information about excited states. Since only a
@ -879,7 +879,7 @@ integrals, etc.
The <code>id</code> and <code>current_label</code> attributes need to be specified for each file.
</p>
<table id="org8cc4752" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org910c933" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -956,16 +956,16 @@ The <code>id</code> and <code>current_label</code> attributes need to be specifi
</div>
</div>
<div id="outline-container-org6a5aeca" class="outline-2">
<h2 id="org6a5aeca"><span class="section-number-2">3</span> Basis functions</h2>
<div id="outline-container-org882ca39" class="outline-2">
<h2 id="org882ca39"><span class="section-number-2">3</span> Basis functions</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-org822cd5b" class="outline-3">
<h3 id="org822cd5b"><span class="section-number-3">3.1</span> Basis set (basis group)</h3>
<div id="outline-container-org9e37dbc" class="outline-3">
<h3 id="org9e37dbc"><span class="section-number-3">3.1</span> Basis set (basis group)</h3>
<div class="outline-text-3" id="text-3-1">
</div>
<div id="outline-container-org09402b2" class="outline-4">
<h4 id="org09402b2"><span class="section-number-4">3.1.1</span> Gaussian and Slater-type orbitals</h4>
<div id="outline-container-org9bb0d96" class="outline-4">
<h4 id="org9bb0d96"><span class="section-number-4">3.1.1</span> Gaussian and Slater-type orbitals</h4>
<div class="outline-text-4" id="text-3-1-1">
<p>
We consider here basis functions centered on nuclei. Hence, it is
@ -1019,8 +1019,8 @@ All the basis set parameters are stored in one-dimensional arrays.
</div>
</div>
<div id="outline-container-org8901886" class="outline-4">
<h4 id="org8901886"><span class="section-number-4">3.1.2</span> Numerical orbitals</h4>
<div id="outline-container-org5579ae1" class="outline-4">
<h4 id="org5579ae1"><span class="section-number-4">3.1.2</span> Numerical orbitals</h4>
<div class="outline-text-4" id="text-3-1-2">
<p>
Trexio supports numerical atom centered orbitals. The implementation is
@ -1084,8 +1084,8 @@ reimplement them with consideration for its specific needs.
</div>
</div>
<div id="outline-container-org873597d" class="outline-4">
<h4 id="org873597d"><span class="section-number-4">3.1.3</span> Plane waves</h4>
<div id="outline-container-org14eb109" class="outline-4">
<h4 id="org14eb109"><span class="section-number-4">3.1.3</span> Plane waves</h4>
<div class="outline-text-4" id="text-3-1-3">
<p>
A plane wave is defined as
@ -1106,8 +1106,8 @@ plane waves.
</div>
</div>
<div id="outline-container-org0590568" class="outline-4">
<h4 id="org0590568"><span class="section-number-4">3.1.4</span> Oscillating orbitals</h4>
<div id="outline-container-org0e951d0" class="outline-4">
<h4 id="org0e951d0"><span class="section-number-4">3.1.4</span> Oscillating orbitals</h4>
<div class="outline-text-4" id="text-3-1-4">
<p>
Basis functions can be made oscillating as
@ -1129,10 +1129,10 @@ Oscillation kind can be:
</div>
</div>
<div id="outline-container-org56396c3" class="outline-4">
<h4 id="org56396c3"><span class="section-number-4">3.1.5</span> Data definitions</h4>
<div id="outline-container-orge91ef29" class="outline-4">
<h4 id="orge91ef29"><span class="section-number-4">3.1.5</span> Data definitions</h4>
<div class="outline-text-4" id="text-3-1-5">
<table id="org7bb236f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org789c11c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1384,8 +1384,8 @@ Oscillation kind can be:
</div>
</div>
<div id="outline-container-orgd5ef5d7" class="outline-4">
<h4 id="orgd5ef5d7"><span class="section-number-4">3.1.6</span> Example</h4>
<div id="outline-container-org05d9df9" class="outline-4">
<h4 id="org05d9df9"><span class="section-number-4">3.1.6</span> Example</h4>
<div class="outline-text-4" id="text-3-1-6">
<p>
For example, consider H<sub>2</sub> with the following basis set (in GAMESS
@ -1463,8 +1463,8 @@ prim_factor =
</div>
</div>
<div id="outline-container-org444ad2c" class="outline-3">
<h3 id="org444ad2c"><span class="section-number-3">3.2</span> Effective core potentials (ecp group)</h3>
<div id="outline-container-orgac095be" class="outline-3">
<h3 id="orgac095be"><span class="section-number-3">3.2</span> Effective core potentials (ecp group)</h3>
<div class="outline-text-3" id="text-3-2">
<p>
An effective core potential (ECP) \(V_A^{\text{ECP}}\) replacing the
@ -1498,7 +1498,7 @@ where \(Z_\text{eff}\) is the effective nuclear charge of the center.
See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.4984046</a> or <a href="https://doi.org/10.1063/1.5121006">https://doi.org/10.1063/1.5121006</a> for more info.
</p>
<table id="org34deff2" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orge6c4539" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1613,8 +1613,8 @@ If you encounter the aforementioned issue, please report it to our
</p>
</div>
<div id="outline-container-orgfc02cd5" class="outline-4">
<h4 id="orgfc02cd5"><span class="section-number-4">3.2.1</span> Example</h4>
<div id="outline-container-org7424aa0" class="outline-4">
<h4 id="org7424aa0"><span class="section-number-4">3.2.1</span> Example</h4>
<div class="outline-text-4" id="text-3-2-1">
<p>
For example, consider H<sub>2</sub> molecule with the following
@ -1677,8 +1677,8 @@ power = [
</div>
</div>
<div id="outline-container-org761b288" class="outline-3">
<h3 id="org761b288"><span class="section-number-3">3.3</span> Numerical integration grid (grid group)</h3>
<div id="outline-container-orgdd68eef" class="outline-3">
<h3 id="orgdd68eef"><span class="section-number-3">3.3</span> Numerical integration grid (grid group)</h3>
<div class="outline-text-3" id="text-3-3">
<p>
In some applications, such as DFT calculations, integrals have to
@ -1693,7 +1693,7 @@ The structure of this group is adapted for the <a href="https://github.com/dftli
Feel free to submit a PR if you find missing options/functionalities.
</p>
<table id="orgf711934" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgb2d60bd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1826,12 +1826,12 @@ Feel free to submit a PR if you find missing options/functionalities.
</div>
</div>
<div id="outline-container-org49cdb83" class="outline-2">
<h2 id="org49cdb83"><span class="section-number-2">4</span> Orbitals</h2>
<div id="outline-container-orgc897907" class="outline-2">
<h2 id="orgc897907"><span class="section-number-2">4</span> Orbitals</h2>
<div class="outline-text-2" id="text-4">
</div>
<div id="outline-container-orge796f49" class="outline-3">
<h3 id="orge796f49"><span class="section-number-3">4.1</span> Atomic orbitals (ao group)</h3>
<div id="outline-container-org6a3b9dc" class="outline-3">
<h3 id="org6a3b9dc"><span class="section-number-3">4.1</span> Atomic orbitals (ao group)</h3>
<div class="outline-text-3" id="text-4-1">
<p>
AOs are defined as
@ -1912,7 +1912,7 @@ AO, so the correction factor \(\mathcal{N}_i'\) for \(d_{xy}\) in the
</p>
<table id="orgd71001a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org0daa70b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -1971,7 +1971,7 @@ AO, so the correction factor \(\mathcal{N}_i'\) for \(d_{xy}\) in the
</table>
</div>
<div id="outline-container-org257d059" class="outline-4">
<div id="outline-container-org0279665" class="outline-4">
<h4 id="ao_one_e"><span class="section-number-4">4.1.1</span> One-electron integrals (<code>ao_1e_int</code> group)</h4>
<div class="outline-text-4" id="text-ao_one_e">
<ul class="org-ul">
@ -1989,7 +1989,7 @@ The one-electron integrals for a one-electron operator \(\hat{O}\) are
over atomic orbitals.
</p>
<table id="org19fb4bd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org21566b8" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2097,7 +2097,7 @@ over atomic orbitals.
</div>
</div>
<div id="outline-container-org758e5b5" class="outline-4">
<div id="outline-container-org181ce42" class="outline-4">
<h4 id="ao_two_e"><span class="section-number-4">4.1.2</span> Two-electron integrals (<code>ao_2e_int</code> group)</h4>
<div class="outline-text-4" id="text-ao_two_e">
<p>
@ -2123,7 +2123,7 @@ The Cholesky decomposition of the integrals can also be stored:
\]
</p>
<table id="org1661a1c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org1659a7b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2200,10 +2200,10 @@ The Cholesky decomposition of the integrals can also be stored:
</div>
</div>
<div id="outline-container-orga2a9c35" class="outline-3">
<h3 id="orga2a9c35"><span class="section-number-3">4.2</span> Molecular orbitals (mo group)</h3>
<div id="outline-container-orga35c161" class="outline-3">
<h3 id="orga35c161"><span class="section-number-3">4.2</span> Molecular orbitals (mo group)</h3>
<div class="outline-text-3" id="text-4-2">
<table id="org4bd1de9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org666e80d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2319,8 +2319,8 @@ is the number of spin-orbitals, twice the number of spatial orbitals.
</div>
<div id="outline-container-org02a784c" class="outline-4">
<h4 id="org02a784c"><span class="section-number-4">4.2.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h4>
<div id="outline-container-org322c69c" class="outline-4">
<h4 id="org322c69c"><span class="section-number-4">4.2.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h4>
<div class="outline-text-4" id="text-4-2-1">
<p>
The operators as the same as those defined in the
@ -2328,7 +2328,7 @@ The operators as the same as those defined in the
the basis of molecular orbitals.
</p>
<table id="org72bbbec" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org83573c3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2436,8 +2436,8 @@ the basis of molecular orbitals.
</div>
</div>
<div id="outline-container-org5e866ba" class="outline-4">
<h4 id="org5e866ba"><span class="section-number-4">4.2.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h4>
<div id="outline-container-orgf2821a9" class="outline-4">
<h4 id="orgf2821a9"><span class="section-number-4">4.2.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h4>
<div class="outline-text-4" id="text-4-2-2">
<p>
The operators are the same as those defined in the
@ -2445,7 +2445,7 @@ The operators are the same as those defined in the
the basis of molecular orbitals.
</p>
<table id="org2046201" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org897e7b1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2523,12 +2523,12 @@ the basis of molecular orbitals.
</div>
</div>
<div id="outline-container-orge99a418" class="outline-2">
<h2 id="orge99a418"><span class="section-number-2">5</span> Multi-determinant information</h2>
<div id="outline-container-org6bd7af0" class="outline-2">
<h2 id="org6bd7af0"><span class="section-number-2">5</span> Multi-determinant information</h2>
<div class="outline-text-2" id="text-5">
</div>
<div id="outline-container-orgd6c2373" class="outline-3">
<h3 id="orgd6c2373"><span class="section-number-3">5.1</span> Slater determinants (determinant group)</h3>
<div id="outline-container-org5f5fa5a" class="outline-3">
<h3 id="org5f5fa5a"><span class="section-number-3">5.1</span> Slater determinants (determinant group)</h3>
<div class="outline-text-3" id="text-5-1">
<p>
The configuration interaction (CI) wave function \(\Psi\)
@ -2570,7 +2570,7 @@ produced by the code generator.
An illustration on how to read determinants is presented in the <a href="./examples.html">examples</a>.
</p>
<table id="org7e28d19" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org3cabcae" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2622,8 +2622,8 @@ An illustration on how to read determinants is presented in the <a href="./examp
</div>
</div>
<div id="outline-container-org55c9b57" class="outline-3">
<h3 id="org55c9b57"><span class="section-number-3">5.2</span> Configuration state functions (csf group)</h3>
<div id="outline-container-orge81fa5d" class="outline-3">
<h3 id="orge81fa5d"><span class="section-number-3">5.2</span> Configuration state functions (csf group)</h3>
<div class="outline-text-3" id="text-5-2">
<p>
The configuration interaction (CI) wave function \(\Psi\) can be
@ -2645,7 +2645,7 @@ matrix \(\langle D_I | \psi_J \rangle\) needed to project the CSFs in
the basis of Slater determinants.
</p>
<table id="orgc04d1d1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org5f90cf1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2697,8 +2697,8 @@ the basis of Slater determinants.
</div>
</div>
<div id="outline-container-org7d6c586" class="outline-3">
<h3 id="org7d6c586"><span class="section-number-3">5.3</span> Amplitudes (amplitude group)</h3>
<div id="outline-container-org222c260" class="outline-3">
<h3 id="org222c260"><span class="section-number-3">5.3</span> Amplitudes (amplitude group)</h3>
<div class="outline-text-3" id="text-5-3">
<p>
The wave function may be expressed in terms of action of the cluster
@ -2769,7 +2769,7 @@ The order of the indices is chosen such that
<li>\(\dots\)</li>
</ul>
<table id="org7be6391" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orga7da1b3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -2861,8 +2861,8 @@ The order of the indices is chosen such that
</div>
</div>
<div id="outline-container-orgbcb3817" class="outline-3">
<h3 id="orgbcb3817"><span class="section-number-3">5.4</span> Reduced density matrices (rdm group)</h3>
<div id="outline-container-org75efef0" class="outline-3">
<h3 id="org75efef0"><span class="section-number-3">5.4</span> Reduced density matrices (rdm group)</h3>
<div class="outline-text-3" id="text-5-4">
<p>
The reduced density matrices are defined in the basis of molecular
@ -2934,7 +2934,7 @@ expressed in a basis of a one-electron function
\(g_{ik}(\mathbf{r}_1) = \phi_i(\mathbf{r}_1) \phi_k(\mathbf{r}_1)\).
</p>
<table id="org9da4ff6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgabbdbb6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -3099,12 +3099,12 @@ expressed in a basis of a one-electron function
</div>
</div>
<div id="outline-container-org22d7c18" class="outline-2">
<h2 id="org22d7c18"><span class="section-number-2">6</span> Correlation factors</h2>
<div id="outline-container-orgd25b3f4" class="outline-2">
<h2 id="orgd25b3f4"><span class="section-number-2">6</span> Correlation factors</h2>
<div class="outline-text-2" id="text-6">
</div>
<div id="outline-container-org432fca4" class="outline-3">
<h3 id="org432fca4"><span class="section-number-3">6.1</span> Jastrow factor (jastrow group)</h3>
<div id="outline-container-org602ff81" class="outline-3">
<h3 id="org602ff81"><span class="section-number-3">6.1</span> Jastrow factor (jastrow group)</h3>
<div class="outline-text-3" id="text-6-1">
<p>
The Jastrow factor is an $N$-electron function which multiplies the CI
@ -3129,8 +3129,8 @@ following:
</ul>
</div>
<div id="outline-container-org04b0804" class="outline-4">
<h4 id="org04b0804"><span class="section-number-4">6.1.1</span> CHAMP</h4>
<div id="outline-container-org6fa9c05" class="outline-4">
<h4 id="org6fa9c05"><span class="section-number-4">6.1.1</span> CHAMP</h4>
<div class="outline-text-4" id="text-6-1-1">
<p>
The first form of Jastrow factor is the one used in
@ -3231,8 +3231,8 @@ The terms \(J_{\text{ee},ij}^\infty\) and \(J_{\text{eN}}^\infty\) are shifts to
</div>
<div id="outline-container-org496e533" class="outline-4">
<h4 id="org496e533"><span class="section-number-4">6.1.2</span> Mu</h4>
<div id="outline-container-org7ecb640" class="outline-4">
<h4 id="org7ecb640"><span class="section-number-4">6.1.2</span> Mu</h4>
<div class="outline-text-4" id="text-6-1-2">
<p>
<a href="https://aip.scitation.org/doi/10.1063/5.0044683">Mu-Jastrow</a> is based on a one-parameter correlation factor that has
@ -3329,10 +3329,10 @@ The parameter \(\mu\) is stored in the <code>ee</code> array, the parameters
</div>
</div>
<div id="outline-container-org1ca335f" class="outline-4">
<h4 id="org1ca335f"><span class="section-number-4">6.1.3</span> Table of values</h4>
<div id="outline-container-orgfa933de" class="outline-4">
<h4 id="orgfa933de"><span class="section-number-4">6.1.3</span> Table of values</h4>
<div class="outline-text-4" id="text-6-1-3">
<table id="org891bb9b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org734eef3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -3450,8 +3450,8 @@ The parameter \(\mu\) is stored in the <code>ee</code> array, the parameters
</div>
</div>
<div id="outline-container-org66f0633" class="outline-2">
<h2 id="org66f0633"><span class="section-number-2">7</span> Quantum Monte Carlo data (qmc group)</h2>
<div id="outline-container-orge6f2f52" class="outline-2">
<h2 id="orge6f2f52"><span class="section-number-2">7</span> Quantum Monte Carlo data (qmc group)</h2>
<div class="outline-text-2" id="text-7">
<p>
In quantum Monte Carlo calculations, the wave function is evaluated
@ -3465,7 +3465,7 @@ By convention, the electron coordinates contain first all the electrons
of $&uarr;$-spin and then all the $&darr;$-spin.
</p>
<table id="org1ece053" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orga329410" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -3527,7 +3527,7 @@ of $&uarr;$-spin and then all the $&darr;$-spin.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2024-08-17 Sat 20:27</p>
<p class="date">Created: 2024-08-17 Sat 20:42</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>