Commit 759e0a23 authored by Marco Govoni's avatar Marco Govoni
Browse files

Updated documentation.

parent fea1a0b5
...@@ -9,11 +9,14 @@ The complete **WEST** reference for input parameters. ...@@ -9,11 +9,14 @@ The complete **WEST** reference for input parameters.
:depth: 1 :depth: 1
.. note:: .. note::
Not all input parameters listed below are mandatory. Check Quick reference or Tutorials pages to see examples of input files. Not all input parameters listed below are mandatory. Check :ref:`quickreference` or :ref:`tutorial` pages to see examples of input files.
.. seealso:: .. 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. **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.
.. seealso::
The input file is given according to the JavaScript Object Notation (`www.json.org <http://www.json.org/>`_).
| |
---------- ----------
...@@ -105,20 +108,20 @@ wstat_control ...@@ -105,20 +108,20 @@ wstat_control
.. data:: l_minimize_exx_if_active .. data:: l_minimize_exx_if_active
:type: boolean :type: boolean
:default: False :default: false
:description: If (True), then the exact-exchange term in the Hamiltonian is computed with the cutoff of the wavefunction. :description: If (true), then the exact-exchange term in the Hamiltonian is computed with the cutoff of the wavefunction.
.. data:: l_kinetic_only .. data:: l_kinetic_only
:type: boolean :type: boolean
:default: False :default: false
:description: If (True), then only the kinetic term in the Hamiltonian is kept. :description: If (true), then only the kinetic term in the Hamiltonian is kept.
.. data:: l_use_ecutrho .. data:: l_use_ecutrho
:type: boolean :type: boolean
:default: False :default: false
:description: If (True), then the eigenpotentials are represented with ecutrho instead of ecutwfc. :description: If (true), then the eigenpotentials are represented with ecutrho instead of ecutwfc.
.. data:: qlist .. data:: qlist
...@@ -218,13 +221,13 @@ wfreq_control ...@@ -218,13 +221,13 @@ wfreq_control
.. data:: l_enable_lanczos .. data:: l_enable_lanczos
:type: boolean :type: boolean
:default: True :default: true
:description: If (False), then Lanczos solvers are turned off. :description: If (false), then Lanczos solvers are turned off.
.. data:: l_enable_gwetot .. data:: l_enable_gwetot
:type: boolean :type: boolean
:default: False :default: false
:description: Deprecated parameter. :description: Deprecated parameter.
.. data:: o_restart_time .. data:: o_restart_time
...@@ -287,8 +290,8 @@ westpp_control ...@@ -287,8 +290,8 @@ westpp_control
.. data:: westpp_sign .. data:: westpp_sign
:type: boolean :type: boolean
:default: False :default: false
:description: If (True), then the sign of the wavefunction/eigenpotential is kept in the output file. :description: If (true), then the sign of the wavefunction/eigenpotential is kept in the output file.
.. data:: westpp_n_pdep_eigen_to_use .. data:: westpp_n_pdep_eigen_to_use
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment