.. _scripts-guide:

*************
Scripts guide
*************

Script guide is aimed at the users who want to use console interface via prepared scripts.

For any script use ``--help`` or ``-h`` option in the terminal in order to display
help message with the short summary of the arguments.

.. code-block:: console

    script-name -h

Files from the usage examples are available :examples:`here <>`.

.. toctree::
    :caption: for Quantum Espresso:
    :maxdepth: 1

    rad-plot-dos/index
    rad-plot-fatbands

.. toctree::
    :caption: for Wannier90:
    :maxdepth: 1

    rad-identify-wannier-centres

.. toctree::
    :caption: Common notes
    :maxdepth: 1

    output-structure