manual.rst 12.4 KB
Newer Older
Marco Govoni's avatar
Marco Govoni committed
1
2
3
4
5
.. _Manual:

Manual
======

Victor Yu's avatar
Victor Yu committed
6
The complete **WEST** reference for input parameters.
Marco Govoni's avatar
Marco Govoni committed
7
8
9
10

.. contents:: :local:
              :depth: 1

Victor Yu's avatar
Victor Yu committed
11
12
.. note::
   Not all input parameters listed below are mandatory. Check :ref:`quickreference` or :ref:`tutorial` pages to see examples of input files.
Marco Govoni's avatar
Marco Govoni committed
13
14
15
16

.. seealso::
   **WESTpy** is a Python package, designed to assist users of the WEST code in pre- and post-process massively parallel calculations. Click `here <http://www.west-code.org/doc/westpy/latest/>`_ to know more.

Marco Govoni's avatar
Marco Govoni committed
17
.. seealso::
Victor Yu's avatar
Victor Yu committed
18
   The input file is given according to the YAML Notation (`https://yaml.org/ <https://yaml.org//>`_).
Marco Govoni's avatar
Marco Govoni committed
19

Marco Govoni's avatar
Marco Govoni committed
20
21
22
23
24
25
26
27
|

----------
input_west
----------

.. data:: qe_prefix

Marco Govoni's avatar
Marco Govoni committed
28
.. list-table::
29
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
30
31
32
33
34
35
36
37
38
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "pwscf"
   * - **Description**
     - Prefix prepended to the QuantumEspresso save folder.

Marco Govoni's avatar
Marco Govoni committed
39
40
41

.. data:: west_prefix

Marco Govoni's avatar
Marco Govoni committed
42
.. list-table::
43
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
44
   :stub-columns: 0
Marco Govoni's avatar
Marco Govoni committed
45

Marco Govoni's avatar
Marco Govoni committed
46
47
48
49
50
   * - **Type**
     - string
   * - **Default**
     - "west"
   * - **Description**
Victor Yu's avatar
Victor Yu committed
51
     - Prefix prepended to the WEST save and restart folders.
Marco Govoni's avatar
Marco Govoni committed
52
53
54
55
56


.. data:: outdir

.. list-table::
57
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
58
59
60
61
62
63
64
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "./"
   * - **Description**
Victor Yu's avatar
Victor Yu committed
65
66
     - Directory for: input, temporary, and output files.

Marco Govoni's avatar
Marco Govoni committed
67
68
69
70
71
72
73
74
75

|

-------------
wstat_control
-------------

.. data:: wstat_calculation

Marco Govoni's avatar
Marco Govoni committed
76
.. list-table::
77
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
78
79
80
81
82
83
84
85
86
87
88
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "S"
   * - **Description**
     - Available options are:

       - "S" : Start from scratch.
       - "R" : Restart from an interrupted run. You should restart with the same number of cores, and images.
Victor Yu's avatar
Victor Yu committed
89
90
       - "E" : Calculation of the response is external, i.e. outsourced to a server.

Marco Govoni's avatar
Marco Govoni committed
91

Marco Govoni's avatar
Marco Govoni committed
92
93
.. data:: n_pdep_eigen

Marco Govoni's avatar
Marco Govoni committed
94
.. list-table::
95
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
96
97
98
99
100
101
102
103
104
105
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - dynamically set to match the number of electrons
   * - **Description**
     - Number of PDEP eigenpotentials.


Marco Govoni's avatar
Marco Govoni committed
106
107
.. data:: n_pdep_times

Marco Govoni's avatar
Marco Govoni committed
108
.. list-table::
109
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
110
111
112
113
114
115
116
117
118
119
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 4
   * - **Description**
     - Maximum dimension of the search space = n_pdep_eigen * n_pdep_times.


Marco Govoni's avatar
Marco Govoni committed
120
121
.. data:: n_pdep_maxiter

Marco Govoni's avatar
Marco Govoni committed
122
.. list-table::
123
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
124
125
126
127
128
129
130
131
132
133
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 100
   * - **Description**
     - Maximum number of iterations in PDEP.


Marco Govoni's avatar
Marco Govoni committed
134
135
.. data:: n_dfpt_maxiter

Marco Govoni's avatar
Marco Govoni committed
136
.. list-table::
137
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
138
139
140
141
142
143
144
145
146
147
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 250
   * - **Description**
     - Maximum number of iterations in DFPT.


Marco Govoni's avatar
Marco Govoni committed
148
149
.. data:: n_pdep_read_from_file

Marco Govoni's avatar
Marco Govoni committed
150
.. list-table::
151
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
152
153
154
155
156
157
158
159
160
161
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 0
   * - **Description**
     - Number of PDEP eigenpotentials that can be read from file.


Marco Govoni's avatar
Marco Govoni committed
162
163
.. data:: trev_pdep

Marco Govoni's avatar
Marco Govoni committed
164
.. list-table::
165
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
166
167
168
169
170
171
172
173
174
175
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 0.001
   * - **Description**
     - Absolute convergence threshold for PDEP eigenvalues.


Marco Govoni's avatar
Marco Govoni committed
176
177
.. data:: trev_pdep_rel

Marco Govoni's avatar
Marco Govoni committed
178
.. list-table::
179
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
180
181
182
183
184
185
186
187
188
189
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 0.1
   * - **Description**
     - Relative convergence threshold for PDEP eigenvalues.


Marco Govoni's avatar
Marco Govoni committed
190
191
.. data:: tr2_dfpt

Marco Govoni's avatar
Marco Govoni committed
192
.. list-table::
193
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
194
195
196
197
198
199
200
201
202
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 1.e-12
   * - **Description**
     - Convergence threshold in DFPT. Note that in the first PDEP iterations a reduced threshold for DFPT could be used by the code in order to speed up the computation.

Marco Govoni's avatar
Marco Govoni committed
203
204
205

.. data:: l_kinetic_only

Marco Govoni's avatar
Marco Govoni committed
206
.. list-table::
207
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
208
   :stub-columns: 0
Marco Govoni's avatar
Marco Govoni committed
209

Marco Govoni's avatar
Marco Govoni committed
210
211
212
213
214
215
216
217
218
219
220
   * - **Type**
     - bool
   * - **Default**
     - False
   * - **Description**
     - If (True), then only the kinetic term in the Hamiltonian is kept.


.. data:: l_minimize_exx_if_active

.. list-table::
221
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
222
223
224
225
226
227
228
229
230
231
232
233
234
   :stub-columns: 0

   * - **Type**
     - bool
   * - **Default**
     - False
   * - **Description**
     - If (True), then the exact-exchange term in the Hamiltonian is computed with the cutoff of the wavefunction.


.. data:: l_use_ecutrho

.. list-table::
235
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
236
237
238
239
240
241
242
243
244
245
246
247
248
   :stub-columns: 0

   * - **Type**
     - bool
   * - **Default**
     - False
   * - **Description**
     - If (True), then the eigenpotentials are represented with ecutrho instead of ecutwfc.


.. data:: qlist

.. list-table::
249
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
250
251
252
253
254
255
256
257
   :stub-columns: 0

   * - **Type**
     - list of int
   * - **Default**
     - [1,2,...,number of q-points]
   * - **Description**
     - List of q-points to compute.
Marco Govoni's avatar
Marco Govoni committed
258
259
260
261
262
263
264
265


|

-------------
wfreq_control
-------------

Marco Govoni's avatar
Marco Govoni committed
266

Marco Govoni's avatar
Marco Govoni committed
267
268
.. data:: wfreq_calculation

Marco Govoni's avatar
Marco Govoni committed
269
.. list-table::
270
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "XWGQ"
   * - **Description**
     - Available options are:

       - "XWGQ" : Compute the QP corrections.
       - "XwGQ" : Compute the QP corrections, restart from an interrupted / just read W run.
       - "XwgQ" : Compute the QP corrections, restart from an interrupted / just read G run.
       - "X" : Compute the HF corrections.
       - "XWO" : Compute the optical properties.
       - "XWGQP" : Compute the QP corrections, and plot spectral functions.
       - "XWGQOP" : Compute all.
Victor Yu's avatar
Victor Yu committed
287

Marco Govoni's avatar
Marco Govoni committed
288

Marco Govoni's avatar
Marco Govoni committed
289
290
.. data:: n_pdep_eigen_to_use

Marco Govoni's avatar
Marco Govoni committed
291
.. list-table::
292
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
293
294
295
296
297
298
299
300
301
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - dynamically set to match the number of electrons
   * - **Description**
     - Number of PDEP eigenvectors to use in Wfreq. They are read from previous Wstat run. This value cannot exceed n_pdep_eigen (defined in wstat_control) and is used to check the convergence of the calculation.

Marco Govoni's avatar
Marco Govoni committed
302
303
304

.. data:: qp_bandrange

Marco Govoni's avatar
Marco Govoni committed
305
.. list-table::
306
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
307
308
309
310
311
312
313
314
315
   :stub-columns: 0

   * - **Type**
     - 2-dim list of int
   * - **Default**
     - [1,2]
   * - **Description**
     - Compute the QP corrections from band qp_bandrange[0] to band qp_bandrange[1].

Marco Govoni's avatar
Marco Govoni committed
316
317
318

.. data:: macropol_calculation

Marco Govoni's avatar
Marco Govoni committed
319
.. list-table::
320
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
321
322
323
324
325
326
327
328
329
330
331
332
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "N"
   * - **Description**
     - Available options are:

       - "N" : None. Choice valid for isolated systems.
       - "C" : Include long-wavelength limit. Choice valid for condensed systems.

Marco Govoni's avatar
Marco Govoni committed
333
334
335

.. data:: n_lanczos

Marco Govoni's avatar
Marco Govoni committed
336
.. list-table::
337
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
338
339
340
341
342
343
344
345
346
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 30
   * - **Description**
     - Number of Lanczos chains.

Marco Govoni's avatar
Marco Govoni committed
347
348
349

.. data:: n_imfreq

Marco Govoni's avatar
Marco Govoni committed
350
.. list-table::
351
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
352
353
354
355
356
357
358
359
360
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 128
   * - **Description**
     - Number of frequecies used to sample the imaginary frequency axis in the range [0,ecut_imfreq].

Marco Govoni's avatar
Marco Govoni committed
361
362
363

.. data:: n_refreq

Marco Govoni's avatar
Marco Govoni committed
364
.. list-table::
365
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
366
367
368
369
370
371
372
373
374
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 272
   * - **Description**
     - Number of frequecies used to sample the real frequency axis in the range [0,ecut_refreq].

Marco Govoni's avatar
Marco Govoni committed
375
376
377

.. data:: ecut_imfreq

Marco Govoni's avatar
Marco Govoni committed
378
.. list-table::
379
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
380
381
382
383
384
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
Victor Yu's avatar
Victor Yu committed
385
     - dynamically set to the cutoff energy of the density, read from the ground state
Marco Govoni's avatar
Marco Govoni committed
386
387
388
   * - **Description**
     - Cutoff for the imaginary frequencies (in Ry).

Marco Govoni's avatar
Marco Govoni committed
389
390
391

.. data:: ecut_refreq

Marco Govoni's avatar
Marco Govoni committed
392
.. list-table::
393
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
394
395
396
397
398
399
400
401
402
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 2.0
   * - **Description**
     - Cutoff for the real frequencies (in Ry).

Marco Govoni's avatar
Marco Govoni committed
403
404
405

.. data:: wfreq_eta

Marco Govoni's avatar
Marco Govoni committed
406
.. list-table::
407
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
408
409
410
411
412
413
414
415
416
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 0.05 / 13.6056980659
   * - **Description**
     - Energy shift of the poles (in Ry).

Marco Govoni's avatar
Marco Govoni committed
417
418
419

.. data:: n_secant_maxiter

Marco Govoni's avatar
Marco Govoni committed
420
.. list-table::
421
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
422
423
424
425
426
427
428
429
430
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 1
   * - **Description**
     - Maximum number of iterations in the secant solver.

Marco Govoni's avatar
Marco Govoni committed
431
432
433

.. data:: trev_secant

Marco Govoni's avatar
Marco Govoni committed
434
.. list-table::
435
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
436
437
438
439
440
441
442
443
444
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 0.05 / 13.6056980659
   * - **Description**
     - Convergence energy threshold (in Ry) for the secant solver.

Marco Govoni's avatar
Marco Govoni committed
445
446
447

.. data:: l_enable_lanczos

Marco Govoni's avatar
Marco Govoni committed
448
.. list-table::
449
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
450
451
452
453
454
455
456
457
458
   :stub-columns: 0

   * - **Type**
     - bool
   * - **Default**
     - True
   * - **Description**
     - If (False), then Lanczos solvers are turned off.

Marco Govoni's avatar
Marco Govoni committed
459
460
461

.. data:: l_enable_gwetot

Marco Govoni's avatar
Marco Govoni committed
462
.. list-table::
463
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
464
465
466
467
468
469
470
471
472
   :stub-columns: 0

   * - **Type**
     - bool
   * - **Default**
     - False
   * - **Description**
     - Deprecated parameter.

Marco Govoni's avatar
Marco Govoni committed
473
474
475

.. data:: o_restart_time

Marco Govoni's avatar
Marco Govoni committed
476
.. list-table::
477
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
478
479
480
481
482
483
484
485
486
487
488
489
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 0.0
   * - **Description**
     - Available options are:

       - If ( o_restart_time == 0 ) A checkpoint is written at every iteration of the W and G loops.
       - If ( o_restart_time >  0 ) A checkpoint is written every o_restart_time minutes in the W and G loops.
       - If ( o_restart_time <  0 ) A checkpoint is NEVER written in the W and G loops. Restart will not be possible.
Marco Govoni's avatar
Marco Govoni committed
490
491
492
493


.. data:: ecut_spectralf

Marco Govoni's avatar
Marco Govoni committed
494
.. list-table::
495
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
496
497
498
499
500
501
502
503
504
   :stub-columns: 0

   * - **Type**
     - 2-dim list of float
   * - **Default**
     - [-2.0,1.0]
   * - **Description**
     - Energy cutoff (in Ry) for the real frequencies. Used when wfreq_caculation contains the runlevel "P".

Marco Govoni's avatar
Marco Govoni committed
505
506
507

.. data:: n_spectralf

Marco Govoni's avatar
Marco Govoni committed
508
.. list-table::
509
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
510
511
512
513
514
515
516
517
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 204
   * - **Description**
     - Number of frequecies used to plot the spectral function (runlevel "P"), sampling the interval [-ecut_spectralf[0],ecut_spectralf[1]].
Marco Govoni's avatar
Marco Govoni committed
518
519
520
521
522
523
524

|

--------------
westpp_control
--------------

Marco Govoni's avatar
Marco Govoni committed
525

Marco Govoni's avatar
Marco Govoni committed
526
527
.. data:: westpp_calculation

Marco Govoni's avatar
Marco Govoni committed
528
.. list-table::
529
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
530
531
532
533
534
535
536
537
538
539
540
541
542
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "R"
   * - **Description**
     - Available options are:

       - "R" : Output rho, the electronic density.
       - "W" : Output the electronic wavefunctions.
       - "E" : Output the eigenpotentials.
       - "S" : Output the screened exchange constant.
Marco Govoni's avatar
Marco Govoni committed
543
544
545
546


.. data:: westpp_range

Marco Govoni's avatar
Marco Govoni committed
547
.. list-table::
548
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
549
550
551
552
553
554
555
556
557
   :stub-columns: 0

   * - **Type**
     - list of int
   * - **Default**
     - [1,2]
   * - **Description**
     - Range for W, E, and S run.

Marco Govoni's avatar
Marco Govoni committed
558
559
560

.. data:: westpp_format

Marco Govoni's avatar
Marco Govoni committed
561
.. list-table::
562
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
563
564
565
566
567
568
569
570
   :stub-columns: 0

   * - **Type**
     - string
   * - **Default**
     - "C"
   * - **Description**
     - Available options for the output fortmat are:
Victor Yu's avatar
Victor Yu committed
571

Marco Govoni's avatar
Marco Govoni committed
572
573
574
575
576
577
       - "c" : Cube.
       - "x" : Planar average yz.
       - "y" : Planar average xz.
       - "z" : Planar average xy.
       - "s" : Spherical average.

Marco Govoni's avatar
Marco Govoni committed
578
579
580

.. data:: westpp_sign

Marco Govoni's avatar
Marco Govoni committed
581
.. list-table::
582
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
583
584
585
586
587
588
589
590
591
   :stub-columns: 0

   * - **Type**
     - bool
   * - **Default**
     - False
   * - **Description**
     - If (True), then the sign of the wavefunction/eigenpotential is kept in the output file.

Marco Govoni's avatar
Marco Govoni committed
592
593
594

.. data:: westpp_n_pdep_eigen_to_use

Marco Govoni's avatar
Marco Govoni committed
595
.. list-table::
596
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
597
598
599
600
601
602
603
604
605
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 1
   * - **Description**
     - Number PDEP eigenpotentials to read/use.

Marco Govoni's avatar
Marco Govoni committed
606
607
608

.. data:: westpp_r0

Marco Govoni's avatar
Marco Govoni committed
609
.. list-table::
610
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
611
612
613
614
615
616
617
618
619
   :stub-columns: 0

   * - **Type**
     - 3-dim list of floats (a vector)
   * - **Default**
     - [0.0, 0.0, 0.0]
   * - **Description**
     - Position of the center (in a.u.) for spherical average plot.

Marco Govoni's avatar
Marco Govoni committed
620
621
622

.. data:: westpp_nr

Marco Govoni's avatar
Marco Govoni committed
623
.. list-table::
624
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
625
626
627
628
629
630
631
632
633
   :stub-columns: 0

   * - **Type**
     - int
   * - **Default**
     - 100
   * - **Description**
     - Number of points in the spherical average plot.

Marco Govoni's avatar
Marco Govoni committed
634
635
636

.. data:: westpp_rmax

Marco Govoni's avatar
Marco Govoni committed
637
.. list-table::
638
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
639
640
641
642
643
644
645
646
647
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 1.0
   * - **Description**
     - Max radius (in a.u.) for the spherical average plot.

Marco Govoni's avatar
Marco Govoni committed
648
649
650

.. data:: westpp_epsinfty

Marco Govoni's avatar
Marco Govoni committed
651
.. list-table::
652
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
653
654
655
656
657
658
659
660
661
662
   :stub-columns: 0

   * - **Type**
     - float
   * - **Default**
     - 1.0
   * - **Description**
     - Macroscopic relative dielectric constant. Used in the "S" runlevel.

|
Marco Govoni's avatar
Marco Govoni committed
663
664
665
666
667
668
669

--------------
server_control
--------------

.. data:: document

Marco Govoni's avatar
Marco Govoni committed
670
.. list-table::
671
   :widths: 10 90
Marco Govoni's avatar
Marco Govoni committed
672
673
674
675
676
677
678
679
   :stub-columns: 0

   * - **Type**
     - jsonizable object
   * - **Default**
     - "{}"
   * - **Description**
     - The document is serialized into a JSON string and passed to the server (see `West/Pytools/west_clientserver.py`).
Marco Govoni's avatar
Marco Govoni committed
680
681

|
Victor Yu's avatar
Victor Yu committed
682

Marco Govoni's avatar
Marco Govoni committed
683