Skip to main content
Ctrl+K

Tepkit Documentation

  • Home

Introduction

  • Overview

Tutorials

  • Installation
  • Work with thirdorder
  • Plotting Figures
  • How to Add Custom Functions
  • Adjust cutoff radius
  • Deformation Potential Theory

File API

  • Overview
  • VASP File Classes
    • EIGENVAL
    • OUTCAR
    • POSCAR
  • BoltzTraP2 File Classes
    • interpolation.condtens
  • Phonopy File Classes
    • FORCE_CONSTANTS
  • ShengBTE File Classes

API Reference

  • Overview
  • tepkit.core
    • tepkit.core.atom
      • tepkit.core.atom.AtomicNumber
    • tepkit.core.geometry
      • tepkit.core.geometry.Point2D
      • tepkit.core.geometry.Line2D
    • tepkit.core.high_symmetry_points
      • tepkit.core.high_symmetry_points.HighSymmetryPoints2D
        • tepkit.core.high_symmetry_points.HighSymmetryPoints2D.LatticeGammaException
        • tepkit.core.high_symmetry_points.HighSymmetryPoints2D.GammaAngleException
    • tepkit.core.structure
    • tepkit.core.symmetry
      • tepkit.core.symmetry.Axis
      • tepkit.core.symmetry.BravaisSystem2D
      • tepkit.core.symmetry.BravaisLattice2D
      • tepkit.core.symmetry.CrystalSystem3D
      • tepkit.core.symmetry.LayerGroup
    • tepkit.core.symmetry_data
    • tepkit.core.vasp
      • tepkit.core.vasp.VaspState
  • tepkit.io
    • tepkit.io.boltztrap2
      • tepkit.io.boltztrap2.Condtens
    • tepkit.io.indices
    • tepkit.io.output
    • tepkit.io.phonopy
      • tepkit.io.phonopy.ForceConstants
    • tepkit.io.shengbte
      • tepkit.io.shengbte.Control
      • tepkit.io.shengbte.SubdirFile
      • tepkit.io.shengbte.OmegaShapedFile
      • tepkit.io.shengbte.OmegaLengthFile
      • tepkit.io.shengbte.OmegaParalleledFile
      • tepkit.io.shengbte.NticksLengthFile
      • tepkit.io.shengbte.TemperatureLengthFile
      • tepkit.io.shengbte.CumulativeKappaTensor
      • tepkit.io.shengbte.CumulativeKappaVsOmegaTensor
      • tepkit.io.shengbte.KappaTensorVsT
      • tepkit.io.shengbte.WP3
      • tepkit.io.shengbte.Gruneisen
      • tepkit.io.shengbte.Omega
      • tepkit.io.shengbte.V
      • tepkit.io.shengbte.W
      • tepkit.io.shengbte.ForceConstants3rd
    • tepkit.io.vasp
      • tepkit.io.vasp.Eigenval
      • tepkit.io.vasp.ExplicitKpoints
      • tepkit.io.vasp.Ibzkpt
      • tepkit.io.vasp.Kpoints
        • tepkit.io.vasp.Kpoints.Mode
      • tepkit.io.vasp.Outcar
      • tepkit.io.vasp.Poscar
      • tepkit.io.vasp.VaspCoordinatesMode
    • tepkit.io.File
    • tepkit.io.TextFile
    • tepkit.io.StructuredTextFile
    • tepkit.io.TableTextFile
  • tepkit.utils
    • tepkit.utils.colors
    • tepkit.utils.mpl_tools
      • tepkit.utils.mpl_tools.color_tools
      • tepkit.utils.mpl_tools.font_tools
      • tepkit.utils.mpl_tools.formatters
      • tepkit.utils.mpl_tools.plotters
        • tepkit.utils.mpl_tools.plotters.kpoints_plotter
        • tepkit.utils.mpl_tools.plotters.plotter
        • tepkit.utils.mpl_tools.plotters.rms_plotter
        • tepkit.utils.mpl_tools.plotters.BasePlotter
        • tepkit.utils.mpl_tools.plotters.Plotter
        • tepkit.utils.mpl_tools.plotters.BrillouinZone2DPlotter
        • tepkit.utils.mpl_tools.plotters.ExplicitKpoints2DPlotter
      • tepkit.utils.mpl_tools.ticker_tools
      • tepkit.utils.mpl_tools.Figure
    • tepkit.utils.rich_tools
      • tepkit.utils.rich_tools.TablePrinter
    • tepkit.utils.typing_tools
      • tepkit.utils.typing_tools.AutoClass
  • tepkit.formulas
    • tepkit.formulas.dp
    • tepkit.formulas.thermoelectric
  • .rst

API Reference

API Reference#

  • tepkit.core

  • tepkit.io

  • tepkit.utils

  • tepkit.formulas

previous

ShengBTE File Classes

next

tepkit.core

By TepLab

© Copyright 2024–2025, TepLab.