jarvis.analysis.topological.spillage
====================================

.. py:module:: jarvis.analysis.topological.spillage

.. autoapi-nested-parse::

   Code to calculate spin-orbit spillage.

   Reference:
   https://www.nature.com/articles/s41598-019-45028-y
   https://www.nature.com/articles/s41524-020-0319-4
   https://arxiv.org/abs/2102.00237



Classes
-------

.. autoapisummary::

   jarvis.analysis.topological.spillage.Spillage


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

.. py:class:: Spillage(wf_noso='', wf_so='')

   Bases: :py:obj:`object`


   Spin-orbit spillage criteria.

   Predict whether a material is topologically non-trival.
   The spillage criteria physically signifies
   number of band-inverted electrons.
   A non-zero, high value (generally >0.5) suggests non-trivial behavior


   .. py:attribute:: wf_noso
      :value: ''



   .. py:attribute:: wf_so
      :value: ''



   .. py:method:: isclose(n1, n2, rel_tol=1e-07)

      Check if n1 and n2 are close.



   .. py:method:: orth(A)

      Orthogonalize a vector.



   .. py:method:: overlap_so_spinpol()

      Calculate spillage.