sumo package

Module contents

Sumo is a set of scripts and an API for dealing with VASP output files.

Subpackages

• sumo.cli package
  • Module contents
  • Submodules
  • sumo.cli.bandplot module
    • bandplot()
    • find_vasprun_files()
    • save_data_files()
  • sumo.cli.bandstats module
    • bandstats()
  • sumo.cli.dosplot module
    • dosplot()
  • sumo.cli.kgen module
    • kgen()
  • sumo.cli.optplot module
    • optplot()
  • sumo.cli.phonon_bandplot module
    • phonon_bandplot()
    • save_data_files()
• sumo.electronic_structure package
  • Module contents
  • Submodules
  • sumo.electronic_structure.bandstructure module
    • force_branches()
    • get_projections()
    • get_projections_by_branches()
    • get_reconstructed_band_structure()
    • string_to_spin()
  • sumo.electronic_structure.dos module
    • get_element_pdos()
    • get_pdos()
    • load_dos()
    • sort_orbitals()
    • write_files()
  • sumo.electronic_structure.effective_mass module
    • fit_effective_mass()
    • get_fitting_data()
  • sumo.electronic_structure.optics module
    • broaden_eps()
    • calculate_dielectric_properties()
    • kkr()
    • write_files()
• sumo.phonon package
  • Module contents
  • Submodules
  • sumo.phonon.phonopy module
    • load_phonopy()
• sumo.plotting package
  • Module contents
    • colorline()
    • curry_power_tick()
    • draw_themed_line()
    • get_interpolated_colors()
    • power_tick()
    • pretty_plot()
    • pretty_subplot()
    • styled_plot()
  • Submodules
  • sumo.plotting.bs_plotter module
    • SBSPlotter
      • SBSPlotter.get_plot()
      • SBSPlotter.get_projected_plot()
  • sumo.plotting.dos_plotter module
    • SDOSPlotter
      • SDOSPlotter.dos_plot_data()
      • SDOSPlotter.get_plot()
    • get_cached_colour()
  • sumo.plotting.optics_plotter module
    • SOpticsPlotter
      • SOpticsPlotter.get_plot()
    • ev_to_nm()
  • sumo.plotting.phonon_bs_plotter module
    • SPhononBSPlotter
      • SPhononBSPlotter.get_plot()
• sumo.symmetry package
  • Module contents
  • Submodules
  • sumo.symmetry.kpoints module
    • get_path_data()
  • sumo.symmetry.kpath module
    • Kpath
      • Kpath.prim
      • Kpath.conv
      • Kpath.correct_structure()
      • Kpath.get_kpoints()
      • Kpath.get_lattice_type()
      • Kpath.kpoints
      • Kpath.lattice_type
      • Kpath.path
      • Kpath.path_string
      • Kpath.spg_number
      • Kpath.spg_symbol
  • sumo.symmetry.brad_crack_kpath module
    • BradCrackKpath
      • BradCrackKpath.prim
      • BradCrackKpath.conv
      • BradCrackKpath.correct_structure()
      • BradCrackKpath.get_kpoints()
      • BradCrackKpath.get_lattice_type()
      • BradCrackKpath.kpoints
      • BradCrackKpath.lattice_type
      • BradCrackKpath.path
      • BradCrackKpath.path_string
      • BradCrackKpath.spg_number
      • BradCrackKpath.spg_symbol
  • sumo.symmetry.pymatgen_kpath module
    • PymatgenKpath
      • PymatgenKpath.prim
      • PymatgenKpath.conv
      • PymatgenKpath.correct_structure()
      • PymatgenKpath.get_kpoints()
      • PymatgenKpath.get_lattice_type()
      • PymatgenKpath.kpoints
      • PymatgenKpath.lattice_type
      • PymatgenKpath.path
      • PymatgenKpath.path_string
      • PymatgenKpath.spg_number
      • PymatgenKpath.spg_symbol
  • sumo.symmetry.seekpath_kpath module
    • SeekpathKpath
      • SeekpathKpath.prim
      • SeekpathKpath.conv
      • SeekpathKpath.correct_structure()
      • SeekpathKpath.get_kpoints()
      • SeekpathKpath.get_lattice_type()
      • SeekpathKpath.kpath_from_seekpath()
      • SeekpathKpath.kpoints
      • SeekpathKpath.lattice_type
      • SeekpathKpath.path
      • SeekpathKpath.path_string
      • SeekpathKpath.spg_number
      • SeekpathKpath.spg_symbol
  • sumo.symmetry.custom_kpath module
    • CustomKpath
      • CustomKpath.prim
      • CustomKpath.conv
      • CustomKpath.correct_structure()
      • CustomKpath.get_kpoints()
      • CustomKpath.get_lattice_type()
      • CustomKpath.kpoints
      • CustomKpath.lattice_type
      • CustomKpath.path
      • CustomKpath.path_string
      • CustomKpath.spg_number
      • CustomKpath.spg_symbol