:py:mod:`aiida_vasp.utils.bands`
================================

.. py:module:: aiida_vasp.utils.bands

.. autodoc2-docstring:: aiida_vasp.utils.bands
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_bs_dims <aiida_vasp.utils.bands.get_bs_dims>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.get_bs_dims
          :summary:
   * - :py:obj:`get_kp_labels <aiida_vasp.utils.bands.get_kp_labels>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.get_kp_labels
          :summary:
   * - :py:obj:`get_efermi <aiida_vasp.utils.bands.get_efermi>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.get_efermi
          :summary:
   * - :py:obj:`get_kp_node <aiida_vasp.utils.bands.get_kp_node>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.get_kp_node
          :summary:
   * - :py:obj:`plot_bstr <aiida_vasp.utils.bands.plot_bstr>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.plot_bstr
          :summary:
   * - :py:obj:`plot_bands <aiida_vasp.utils.bands.plot_bands>`
     - .. autodoc2-docstring:: aiida_vasp.utils.bands.plot_bands
          :summary:

API
~~~

.. py:function:: get_bs_dims(bands_array: numpy.ndarray) -> tuple[int, int, int]
   :canonical: aiida_vasp.utils.bands.get_bs_dims

   .. autodoc2-docstring:: aiida_vasp.utils.bands.get_bs_dims

.. py:function:: get_kp_labels(bands_node: aiida.orm.BandsData, kpoints_node: aiida.orm.KpointsData | None = None) -> tuple[list[int], list[str]]
   :canonical: aiida_vasp.utils.bands.get_kp_labels

   .. autodoc2-docstring:: aiida_vasp.utils.bands.get_kp_labels

.. py:function:: get_efermi(calc: aiida.orm.CalcJobNode) -> float | None
   :canonical: aiida_vasp.utils.bands.get_efermi

   .. autodoc2-docstring:: aiida_vasp.utils.bands.get_efermi

.. py:function:: get_kp_node(calc: aiida.orm.CalcJobNode) -> aiida.orm.KpointsData | None
   :canonical: aiida_vasp.utils.bands.get_kp_node

   .. autodoc2-docstring:: aiida_vasp.utils.bands.get_kp_node

.. py:function:: plot_bstr(bands_node: aiida.orm.BandsData, kpoints_node: aiida.orm.KpointsData | None = None, title: str | None = None, efermi: float | None = None, use_parent_calc: bool = False, **kwargs: typing.Any)
   :canonical: aiida_vasp.utils.bands.plot_bstr

   .. autodoc2-docstring:: aiida_vasp.utils.bands.plot_bstr

.. py:function:: plot_bands(bands_node: aiida.orm.BandsData, **kwargs: typing.Any) -> None
   :canonical: aiida_vasp.utils.bands.plot_bands

   .. autodoc2-docstring:: aiida_vasp.utils.bands.plot_bands