.. _api_kpoints:

*******
Kpoints
*******

.. currentmodule:: radtools

Class
=====

.. autosummary::
    :toctree: generated/

    Kpoints

Attributes
==========
* Kpoints.b1
* Kpoints.b2
* Kpoints.b3
* Kpoints.hs_names
* Kpoints.hs_coordinates
* Kpoints.hs_labels

Settings parameters
===================

.. autosummary::
    :toctree: generated/

    Kpoints.n
    Kpoints.path
    Kpoints.path_string
    Kpoints.add_hs_point

Flattened graph labels
======================

.. autosummary::
    :toctree: generated/

    Kpoints.labels
    Kpoints.coordinates

K points in the path
====================

.. autosummary::
    :toctree: generated/

    Kpoints.points
    Kpoints.flatten_points