Skip to content

Commit 2dd8987

Browse files
author
mVMC Developers
committed
Deploy docs to master by GitHub Actions triggered by d73d06b
1 parent 8f16af8 commit 2dd8987

File tree

4 files changed

+165
-100
lines changed

4 files changed

+165
-100
lines changed

doc/master/en/_sources/expert.rst.txt

Lines changed: 74 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -243,52 +243,80 @@ User rules
243243

244244
- When the head of line is ``#``, the line is skipped.
245245

246-
======================== ===================================================================================
247-
Keywords Details for corresponding files
248-
======================== ===================================================================================
249-
ModPara :math:`^*` Parameters for calculation.
250-
LocSpin :math:`^*` Configurations of the local spins for Hamiltonian.
251-
Trans Transfer and chemical potential for Hamiltonian.
252-
InterAll Two-body interactions for Hamiltonian.
253-
CoulombIntra CoulombIntra interactions.
254-
CoulombInter CoulombInter interactions.
255-
Hund Hund couplings.
256-
PairHop Pair hopping couplings.
257-
Exchange Exchange couplings.
258-
Gutzwiller Gutzwiller factors.
259-
Jastrow Charge Jastrow factors.
260-
DH2 2-site doublon-holon correlation factors.
261-
DH4 4-site doublon-holon correlation factors.
262-
GeneralRBM_PhysLayer A part of the general RBM correlation factor including variational parameters
263-
in a physical layer :math:`\alpha_{i\sigma}`.
264-
GeneralRBM_HiddenLayer A part of the general RBM correlation factor including variational parameters
265-
in a hidden layer :math:`h_{k}`.
266-
GeneralRBM_PhysHidden A part of the general RBM correlation factor including variational parameters
267-
which connect physical and hidden layers :math:`W_{i\sigma k}`.
268-
Orbital :math:`^*` Pair orbital factors with anti-parallel spins :math:`f_{i\uparrow j\downarrow}`.
269-
OrbitalAntiParallel Pair orbital factors with anti-parallel spins :math:`f_{i\uparrow j\downarrow}`.
270-
OrbitalParallel Pair orbital factors with parallel spins :math:`f_{i\sigma j\sigma}`.
271-
OrbitalGeneral Pair orbital factors :math:`f_{i\sigma_1 j\sigma_2}`.
272-
TransSym :math:`^*` Translational and lattice symmetry operation.
273-
InGutzwiller Initial values of Gutzwiller factors.
274-
InJastrow Initial values of charge Jastrow factors.
275-
InDH2 Initial values of 2-site doublon-holon correlation factors.
276-
InDH4 Initial values of 4-site doublon-holon correlation factors.
277-
InGeneralRBM_PhysLayer Initial values of variational parameters of the general RBM correlation factors
278-
in a physical layer :math:`\alpha_{i\sigma}`.
279-
InGeneralRBM_HiddenLayer Initial values of variational parameters of the general RBM correlation factors
280-
in a hidden layer :math:`h_{k}`.
281-
InGeneralRBM_PhysHidden Initial values of variational parameters of the general RBM correlation factors
282-
which connect physical and hidden layers :math:`W_{i\sigma k}`.
283-
InOrbital Initial values of pair orbital factors :math:`f_{i\uparrow j\downarrow}`.
284-
InOrbitalAntiParallel Initial values of pair orbital factors :math:`f_{i\uparrow j\downarrow}`.
285-
InOrbitalParallel Initial values of pair orbital factors :math:`f_{i\sigma j\sigma}`.
286-
InOrbitalGeneral Initial values of pair orbital factors :math:`f_{i\sigma_1 j\sigma_2}`.
287-
OneBodyG Output components for Green functions
288-
:math:`\langle c_{i\sigma}^{\dagger}c_{j\sigma}\rangle`
289-
TwoBodyG Output components for Correlation functions
290-
:math:`\langle c_{i\sigma}^{\dagger}c_{j\sigma}c_{k\tau}^{\dagger}c_{l\tau}\rangle`
291-
======================== ===================================================================================
246+
.. list-table::
247+
:widths: 30 70
248+
:header-rows: 1
249+
250+
* - Keywords
251+
- Details for corresponding files
252+
* - ModPara :math:`^*`
253+
- Parameters for calculation.
254+
* - LocSpin :math:`^*`
255+
- Configurations of the local spins for Hamiltonian.
256+
* - Trans
257+
- Transfer and chemical potential for Hamiltonian.
258+
* - InterAll
259+
- Two-body interactions for Hamiltonian.
260+
* - CoulombIntra
261+
- CoulombIntra interactions.
262+
* - CoulombInter
263+
- CoulombInter interactions.
264+
* - Hund
265+
- Hund couplings.
266+
* - PairHop
267+
- Pair hopping couplings.
268+
* - Exchange
269+
- Exchange couplings.
270+
* - Gutzwiller
271+
- Gutzwiller factors.
272+
* - Jastrow
273+
- Charge Jastrow factors.
274+
* - DH2
275+
- 2-site doublon-holon correlation factors.
276+
* - DH4
277+
- 4-site doublon-holon correlation factors.
278+
* - GeneralRBM_PhysLayer
279+
- A part of the general RBM correlation factor including variational parameters in a physical layer :math:`\alpha_{i\sigma}`.
280+
* - GeneralRBM_HiddenLayer
281+
- A part of the general RBM correlation factor including variational parameters in a hidden layer :math:`h_{k}`.
282+
* - GeneralRBM_PhysHidden
283+
- A part of the general RBM correlation factor including variational parameters which connect physical and hidden layers :math:`W_{i\sigma k}`.
284+
* - Orbital :math:`^*`
285+
- Pair orbital factors with anti-parallel spins :math:`f_{i\uparrow j\downarrow}`.
286+
* - OrbitalAntiParallel
287+
- Pair orbital factors with anti-parallel spins :math:`f_{i\uparrow j\downarrow}`.
288+
* - OrbitalParallel
289+
- Pair orbital factors with parallel spins :math:`f_{i\sigma j\sigma}`.
290+
* - OrbitalGeneral
291+
- Pair orbital factors :math:`f_{i\sigma_1 j\sigma_2}`.
292+
* - TransSym :math:`^*`
293+
- Translational and lattice symmetry operation.
294+
* - InGutzwiller
295+
- Initial values of Gutzwiller factors.
296+
* - InJastrow
297+
- Initial values of charge Jastrow factors.
298+
* - InDH2
299+
- Initial values of 2-site doublon-holon correlation factors.
300+
* - InDH4
301+
- Initial values of 4-site doublon-holon correlation factors.
302+
* - InGeneralRBM_PhysLayer
303+
- Initial values of variational parameters of the general RBM correlation factors in a physical layer :math:`\alpha_{i\sigma}`.
304+
* - InGeneralRBM_HiddenLayer
305+
- Initial values of variational parameters of the general RBM correlation factors in a hidden layer :math:`h_{k}`.
306+
* - InGeneralRBM_PhysHidden
307+
- Initial values of variational parameters of the general RBM correlation factors which connect physical and hidden layers :math:`W_{i\sigma k}`.
308+
* - InOrbital
309+
- Initial values of pair orbital factors :math:`f_{i\uparrow j\downarrow}`.
310+
* - InOrbitalAntiParallel
311+
- Initial values of pair orbital factors :math:`f_{i\uparrow j\downarrow}`.
312+
* - InOrbitalParallel
313+
- Initial values of pair orbital factors :math:`f_{i\sigma j\sigma}`.
314+
* - InOrbitalGeneral
315+
- Initial values of pair orbital factors :math:`f_{i\sigma_1 j\sigma_2}`.
316+
* - OneBodyG
317+
- Output components for Green functions :math:`\langle c_{i\sigma}^{\dagger}c_{j\sigma}\rangle`
318+
* - TwoBodyG
319+
- Output components for Correlation functions :math:`\langle c_{i\sigma}^{\dagger}c_{j\sigma}c_{k\tau}^{\dagger}c_{l\tau}\rangle`
292320

293321
ModPara file (modpara.def)
294322
~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/master/en/expert.html

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,10 @@ <h3>User rules<a class="headerlink" href="#user-rules" title="Permalink to this
226226
<li><p>When the head of line is <code class="docutils literal notranslate"><span class="pre">#</span></code>, the line is skipped.</p></li>
227227
</ul>
228228
<table class="docutils align-default">
229+
<colgroup>
230+
<col style="width: 30.0%" />
231+
<col style="width: 70.0%" />
232+
</colgroup>
229233
<thead>
230234
<tr class="row-odd"><th class="head"><p>Keywords</p></th>
231235
<th class="head"><p>Details for corresponding files</p></th>
@@ -272,16 +276,13 @@ <h3>User rules<a class="headerlink" href="#user-rules" title="Permalink to this
272276
<td><p>4-site doublon-holon correlation factors.</p></td>
273277
</tr>
274278
<tr class="row-odd"><td><p>GeneralRBM_PhysLayer</p></td>
275-
<td><p>A part of the general RBM correlation factor including variational parameters
276-
in a physical layer <span class="math notranslate nohighlight">\(\alpha_{i\sigma}\)</span>.</p></td>
279+
<td><p>A part of the general RBM correlation factor including variational parameters in a physical layer <span class="math notranslate nohighlight">\(\alpha_{i\sigma}\)</span>.</p></td>
277280
</tr>
278281
<tr class="row-even"><td><p>GeneralRBM_HiddenLayer</p></td>
279-
<td><p>A part of the general RBM correlation factor including variational parameters
280-
in a hidden layer <span class="math notranslate nohighlight">\(h_{k}\)</span>.</p></td>
282+
<td><p>A part of the general RBM correlation factor including variational parameters in a hidden layer <span class="math notranslate nohighlight">\(h_{k}\)</span>.</p></td>
281283
</tr>
282284
<tr class="row-odd"><td><p>GeneralRBM_PhysHidden</p></td>
283-
<td><p>A part of the general RBM correlation factor including variational parameters
284-
which connect physical and hidden layers <span class="math notranslate nohighlight">\(W_{i\sigma k}\)</span>.</p></td>
285+
<td><p>A part of the general RBM correlation factor including variational parameters which connect physical and hidden layers <span class="math notranslate nohighlight">\(W_{i\sigma k}\)</span>.</p></td>
285286
</tr>
286287
<tr class="row-even"><td><p>Orbital <span class="math notranslate nohighlight">\(^*\)</span></p></td>
287288
<td><p>Pair orbital factors with anti-parallel spins <span class="math notranslate nohighlight">\(f_{i\uparrow j\downarrow}\)</span>.</p></td>
@@ -311,16 +312,13 @@ <h3>User rules<a class="headerlink" href="#user-rules" title="Permalink to this
311312
<td><p>Initial values of 4-site doublon-holon correlation factors.</p></td>
312313
</tr>
313314
<tr class="row-odd"><td><p>InGeneralRBM_PhysLayer</p></td>
314-
<td><p>Initial values of variational parameters of the general RBM correlation factors
315-
in a physical layer <span class="math notranslate nohighlight">\(\alpha_{i\sigma}\)</span>.</p></td>
315+
<td><p>Initial values of variational parameters of the general RBM correlation factors in a physical layer <span class="math notranslate nohighlight">\(\alpha_{i\sigma}\)</span>.</p></td>
316316
</tr>
317317
<tr class="row-even"><td><p>InGeneralRBM_HiddenLayer</p></td>
318-
<td><p>Initial values of variational parameters of the general RBM correlation factors
319-
in a hidden layer <span class="math notranslate nohighlight">\(h_{k}\)</span>.</p></td>
318+
<td><p>Initial values of variational parameters of the general RBM correlation factors in a hidden layer <span class="math notranslate nohighlight">\(h_{k}\)</span>.</p></td>
320319
</tr>
321320
<tr class="row-odd"><td><p>InGeneralRBM_PhysHidden</p></td>
322-
<td><p>Initial values of variational parameters of the general RBM correlation factors
323-
which connect physical and hidden layers <span class="math notranslate nohighlight">\(W_{i\sigma k}\)</span>.</p></td>
321+
<td><p>Initial values of variational parameters of the general RBM correlation factors which connect physical and hidden layers <span class="math notranslate nohighlight">\(W_{i\sigma k}\)</span>.</p></td>
324322
</tr>
325323
<tr class="row-even"><td><p>InOrbital</p></td>
326324
<td><p>Initial values of pair orbital factors <span class="math notranslate nohighlight">\(f_{i\uparrow j\downarrow}\)</span>.</p></td>
@@ -335,12 +333,10 @@ <h3>User rules<a class="headerlink" href="#user-rules" title="Permalink to this
335333
<td><p>Initial values of pair orbital factors <span class="math notranslate nohighlight">\(f_{i\sigma_1 j\sigma_2}\)</span>.</p></td>
336334
</tr>
337335
<tr class="row-even"><td><p>OneBodyG</p></td>
338-
<td><p>Output components for Green functions
339-
<span class="math notranslate nohighlight">\(\langle c_{i\sigma}^{\dagger}c_{j\sigma}\rangle\)</span></p></td>
336+
<td><p>Output components for Green functions <span class="math notranslate nohighlight">\(\langle c_{i\sigma}^{\dagger}c_{j\sigma}\rangle\)</span></p></td>
340337
</tr>
341338
<tr class="row-odd"><td><p>TwoBodyG</p></td>
342-
<td><p>Output components for Correlation functions
343-
<span class="math notranslate nohighlight">\(\langle c_{i\sigma}^{\dagger}c_{j\sigma}c_{k\tau}^{\dagger}c_{l\tau}\rangle\)</span></p></td>
339+
<td><p>Output components for Correlation functions <span class="math notranslate nohighlight">\(\langle c_{i\sigma}^{\dagger}c_{j\sigma}c_{k\tau}^{\dagger}c_{l\tau}\rangle\)</span></p></td>
344340
</tr>
345341
</tbody>
346342
</table>

0 commit comments

Comments
 (0)