pyprocar.core.ElectronicBandStructure
=====================================

.. currentmodule:: pyprocar.core

.. autoclass:: ElectronicBandStructure

   

   
   .. rubric:: Methods

   .. autosummary::
      :toctree:
   
      
        
          ElectronicBandStructure.__init__
        
      
      
        
          ElectronicBandStructure.array_to_mesh
        
      
      
        
          ElectronicBandStructure.calculate_harmonic_average_effective_mass
        
      
      
        
          ElectronicBandStructure.calculate_nd_scalar_derivatives
        
      
      
        
          ElectronicBandStructure.calculate_nd_scalar_integral
        
      
      
        
          ElectronicBandStructure.cartesian_to_reduced
        
      
      
        
          ElectronicBandStructure.ebs_ipr
        
      
      
        
          ElectronicBandStructure.ebs_ipr_atom
        
      
      
        
          ElectronicBandStructure.ebs_sum
        
      
      
        
          ElectronicBandStructure.expand_kpoints_to_supercell
        
      
      
        
          ElectronicBandStructure.expand_kpoints_to_supercell_by_axes
        
      
      
        
          ElectronicBandStructure.fix_collinear_spin
        
      
      
        
          ElectronicBandStructure.general_rotation
        
      
      
        
          ElectronicBandStructure.ibz2fbz
        
      
      
        
          ElectronicBandStructure.interpolate_mesh_grid
        
      
      
        
          ElectronicBandStructure.mesh_to_array
        
      
      
        
          ElectronicBandStructure.mirror_x
        
      
      
        
          ElectronicBandStructure.plot_kpoints
        
      
      
        
          ElectronicBandStructure.ravel_array
        
      
      
        
          ElectronicBandStructure.reduce_bands_near_fermi
        
      
      
        
          ElectronicBandStructure.reduce_kpoints_to_plane
        
      
      
        
          ElectronicBandStructure.reduced_to_cartesian
        
      
      
        
          ElectronicBandStructure.rot_symmetry_z
        
      
      
        
          ElectronicBandStructure.translate
        
      
      
        
          ElectronicBandStructure.unfold
        
      
      
        
          ElectronicBandStructure.update_weights
        
      
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
      :toctree:
   
      
        
          ElectronicBandStructure.bands
        
      
      
        
          ElectronicBandStructure.bands_gradient
        
      
      
        
          ElectronicBandStructure.bands_gradient_mesh
        
      
      
        
          ElectronicBandStructure.bands_hessian
        
      
      
        
          ElectronicBandStructure.bands_hessian_mesh
        
      
      
        
          ElectronicBandStructure.bands_integral
        
      
      
        
          ElectronicBandStructure.bands_mesh
        
      
      
        
          ElectronicBandStructure.efermi
        
      
      
        
          ElectronicBandStructure.fermi_speed
        
      
      
        
          ElectronicBandStructure.fermi_speed_mesh
        
      
      
        
          ElectronicBandStructure.fermi_velocity
        
      
      
        
          ElectronicBandStructure.fermi_velocity_mesh
        
      
      
        
          ElectronicBandStructure.harmonic_average_effective_mass
        
      
      
        
          ElectronicBandStructure.harmonic_average_effective_mass_mesh
        
      
      
        
          ElectronicBandStructure.inv_reciprocal_lattice
        
      
      
        
          ElectronicBandStructure.is_non_collinear
        
      
      
        
          ElectronicBandStructure.kpath
        
      
      
        
          ElectronicBandStructure.kpoints
        
      
      
        
          ElectronicBandStructure.kpoints_cartesian
        
      
      
        
          ElectronicBandStructure.kpoints_cartesian_mesh
        
      
      
        
          ElectronicBandStructure.kpoints_mesh
        
      
      
        
          ElectronicBandStructure.kx_map
        
      
      
        
          ElectronicBandStructure.ky_map
        
      
      
        
          ElectronicBandStructure.kz_map
        
      
      
        
          ElectronicBandStructure.n_kx
        
      
      
        
          ElectronicBandStructure.n_ky
        
      
      
        
          ElectronicBandStructure.n_kz
        
      
      
        
          ElectronicBandStructure.natoms
        
      
      
        
          ElectronicBandStructure.nbands
        
      
      
        
          ElectronicBandStructure.nkpoints
        
      
      
        
          ElectronicBandStructure.norbitals
        
      
      
        
          ElectronicBandStructure.nprincipals
        
      
      
        
          ElectronicBandStructure.nspins
        
      
      
        
          ElectronicBandStructure.projected
        
      
      
        
          ElectronicBandStructure.projected_mesh
        
      
      
        
          ElectronicBandStructure.projected_phase
        
      
      
        
          ElectronicBandStructure.projected_phase_mesh
        
      
      
        
          ElectronicBandStructure.reciprocal_lattice
        
      
      
        
          ElectronicBandStructure.weights
        
      
      
        
          ElectronicBandStructure.weights_mesh
        
      
   
   