Skip to content

Commit e0d68a5

Browse files
committed
manual updates for v1.1.0
1 parent 1ed9690 commit e0d68a5

File tree

7 files changed

+3
-63
lines changed

7 files changed

+3
-63
lines changed

docs/_sources/grad/force.rst.txt

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,18 +107,6 @@ Optional Keywords
107107
| **Default:** 100
108108
| **Recommendation:** Increase the value when Z-vector equation does not converge.
109109
110-
.. topic:: ``save_ref``
111-
112-
| **Description:** The reference wavefunction is saved to an archive file.
113-
| **Datatype:** bool
114-
| **Default:** false
115-
| **Recommendation:** Save file if it is likely that the calculation will need to be restarted.
116-
117-
.. topic:: ``ref_out``
118-
119-
| **Description:** The name of the archive file for the stored reference. The path to the location the file should be written can also be specified here.
120-
| **Datatype:** string
121-
122110
.. topic:: ``nproc``
123111

124112
| **Description:** The numerical gradient code is embarrassingly parallelized so that the displacements in the finite difference calculations can be run at the same time. The nproc keyword allows the user to specify the number of MPI processes to be used for each energy calculation.

docs/_sources/smith/caspt2.rst.txt

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,19 +115,12 @@ The default values are recommended unless mentioned otherwise.
115115
| **Datatype:** int
116116
| **Default:** 10
117117
118-
.. topic:: ``cimaxtile``
119-
120-
| **Description:** Maximum number of Slater determinants in a single data tile used in CASPT2 gradient.
121-
| **Datatype:** int
122-
| **Default:** 100 (When number of determinants is over 10000), 10 (otherwise)
123-
| **Recommendation:** Use default. Increase further when the number of determinants is larger.
124-
125118
.. topic:: ``cimaxchunk``
126119

127120
| **Description:** Number of elements per pass in the multipassing algorithm.
128121
| **Datatype:** int
129122
| **Default:** 317520001
130-
| **Recommendation:** This number is adjusted for 64GB of memory. Decrease if necessary.
123+
| **Recommendation:** This number is adjusted for 64GB of memory per node. Decrease if necessary.
131124
132125
.. topic:: ``davidson_subspace``
133126

docs/_sources/smith/relcaspt2.rst.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,6 @@ The default values are recommended unless mentioned otherwise.
103103
| **Datatype:** int
104104
| **Default:** 10
105105
106-
.. topic:: ``cimaxtile``
107-
108-
| **Description:** Maximum number of Slater determinants in a single data tile used in CASPT2 gradient.
109-
| **Datatype:** int
110-
| **Default:** 100 (When number of determinants is over 10000), 10 (otherwise)
111-
| **Recommendation:** Use default. Increase further when the number of determinants is larger.
112-
113106
.. topic:: ``davidson_subspace``
114107

115108
| **Description:** Number of vectors retained in the limited-memory Davidson algorithm.

docs/grad/force.html

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -185,22 +185,6 @@ <h3>Optional Keywords<a class="headerlink" href="#optional-keywords" title="Perm
185185
</div>
186186
</div>
187187
<div class="topic">
188-
<p class="topic-title first"><code class="docutils literal"><span class="pre">save_ref</span></code></p>
189-
<div class="line-block">
190-
<div class="line"><strong>Description:</strong> The reference wavefunction is saved to an archive file.</div>
191-
<div class="line"><strong>Datatype:</strong> bool</div>
192-
<div class="line"><strong>Default:</strong> false</div>
193-
<div class="line"><strong>Recommendation:</strong> Save file if it is likely that the calculation will need to be restarted.</div>
194-
</div>
195-
</div>
196-
<div class="topic">
197-
<p class="topic-title first"><code class="docutils literal"><span class="pre">ref_out</span></code></p>
198-
<div class="line-block">
199-
<div class="line"><strong>Description:</strong> The name of the archive file for the stored reference. The path to the location the file should be written can also be specified here.</div>
200-
<div class="line"><strong>Datatype:</strong> string</div>
201-
</div>
202-
</div>
203-
<div class="topic">
204188
<p class="topic-title first"><code class="docutils literal"><span class="pre">nproc</span></code></p>
205189
<div class="line-block">
206190
<div class="line"><strong>Description:</strong> The numerical gradient code is embarrassingly parallelized so that the displacements in the finite difference calculations can be run at the same time. The nproc keyword allows the user to specify the number of MPI processes to be used for each energy calculation.</div>

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/smith/caspt2.html

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -184,21 +184,12 @@ <h3>SMITH keywords<a class="headerlink" href="#smith-keywords" title="Permalink
184184
</div>
185185
</div>
186186
<div class="topic">
187-
<p class="topic-title first"><code class="docutils literal"><span class="pre">cimaxtile</span></code></p>
188-
<div class="line-block">
189-
<div class="line"><strong>Description:</strong> Maximum number of Slater determinants in a single data tile used in CASPT2 gradient.</div>
190-
<div class="line"><strong>Datatype:</strong> int</div>
191-
<div class="line"><strong>Default:</strong> 100 (When number of determinants is over 10000), 10 (otherwise)</div>
192-
<div class="line"><strong>Recommendation:</strong> Use default. Increase further when the number of determinants is larger.</div>
193-
</div>
194-
</div>
195-
<div class="topic">
196187
<p class="topic-title first"><code class="docutils literal"><span class="pre">cimaxchunk</span></code></p>
197188
<div class="line-block">
198189
<div class="line"><strong>Description:</strong> Number of elements per pass in the multipassing algorithm.</div>
199190
<div class="line"><strong>Datatype:</strong> int</div>
200191
<div class="line"><strong>Default:</strong> 317520001</div>
201-
<div class="line"><strong>Recommendation:</strong> This number is adjusted for 64GB of memory. Decrease if necessary.</div>
192+
<div class="line"><strong>Recommendation:</strong> This number is adjusted for 64GB of memory per node. Decrease if necessary.</div>
202193
</div>
203194
</div>
204195
<div class="topic">

docs/smith/relcaspt2.html

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,15 +173,6 @@ <h3>SMITH keywords<a class="headerlink" href="#smith-keywords" title="Permalink
173173
</div>
174174
</div>
175175
<div class="topic">
176-
<p class="topic-title first"><code class="docutils literal"><span class="pre">cimaxtile</span></code></p>
177-
<div class="line-block">
178-
<div class="line"><strong>Description:</strong> Maximum number of Slater determinants in a single data tile used in CASPT2 gradient.</div>
179-
<div class="line"><strong>Datatype:</strong> int</div>
180-
<div class="line"><strong>Default:</strong> 100 (When number of determinants is over 10000), 10 (otherwise)</div>
181-
<div class="line"><strong>Recommendation:</strong> Use default. Increase further when the number of determinants is larger.</div>
182-
</div>
183-
</div>
184-
<div class="topic">
185176
<p class="topic-title first"><code class="docutils literal"><span class="pre">davidson_subspace</span></code></p>
186177
<div class="line-block">
187178
<div class="line"><strong>Description:</strong> Number of vectors retained in the limited-memory Davidson algorithm.</div>

0 commit comments

Comments
 (0)