plot_fermi_surface#

FermiHandler.plot_fermi_surface(mode, bands=None, atoms=None, orbitals=None, spins=None, spin_texture=False, property_name=None, show=True, save_2d=None, save_gif=None, save_mp4=None, save_3d=None, print_plot_opts: bool = False, **kwargs)[source]#

A method to plot the 3d fermi surface

Parameters:

  • mode (str) – The mode to calculate

  • bands (List[int], optional) – A list of band indexes to plot, by default None

  • atoms (List[int], optional) – A list of atoms, by default None

  • orbitals (List[int], optional) – A list of orbitals, by default None

  • spins (List[int], optional) – A list of spins, by default None

  • spin_texture (bool, optional) – Boolean to plot spin texture, by default False

  • print_plot_opts (bool, optional) – Boolean to print the plotting options