__init__

FermiSurface.__init__(kpoints, bands, spd, figsize: tuple = (6, 6), ax: Axes | None = None, **kwargs)[source]

Initialize the FermiSurface object.

Parameters:

  • kpoints (np.ndarray) – Array of k-points in Cartesian coordinates with shape (n_kpoints, 3).

  • bands (np.ndarray) – Array of band energies with shape (n_kpoints, n_bands, n_spins).

  • spd (np.ndarray) – Array of spin-projected density with shape (n_kpoints, n_bands, n_spins, n_orbitals, n_atoms).

  • figsize (tuple of float, optional) – Figure size as (width, height) in inches, by default (6, 6).

  • ax (matplotlib.axes.Axes or None, optional) – Matplotlib axes object to plot on, by default None.

  • **kwargs – Additional keyword arguments.