Kpath input documentation
=========================

Initialize k-path with spacing `dk` connecting `points`.


Used to initialize class :class:`qimpy.lattice.Kpath`.

YAML template:
--------------

.. parsed-literal::

   :yamlparam:`qimpy.lattice.Kpath:dk`: 0.0       :yamlcomment:`# Maximum distance between adjacent points on k-path.`
   :yamlparam:`qimpy.lattice.Kpath:points`: :yamlkey:`null`  :yamlcomment:`# List of special k-points [kx, ky, kz, label] along path.`

Parameters:
-----------

dk
++

*Type:* :yamltype:`float`, *Default:*  0.0

Maximum distance between adjacent points on k-path.
(Units: :math:`a_0^{-1}`.)

points
++++++

*Type:* :yamltype:`list` or :yamltype:`null`, *Default:*  :yamlkey:`null`

List of special k-points [kx, ky, kz, label] along path.
Each point should contain three fractional coordinates (float)
and optionally a string label for this point for use in
band structure plots.