NEP-kappa Documentation
=======================

Welcome to the documentation of **NEP-kappa**.

Source code repository:
`GitHub <https://github.com/lyushisyan/NEP-kappa>`_

**NEP-kappa** is a workflow for lattice thermal conductivity calculations based on
**NEP**, **HiPhive**, and **phono3py**.

It supports:

- structure preparation and optional relaxation
- force-constant generation by finite displacement or HiPhive
- thermal conductivity calculations with phono3py
- example plotting scripts for bulk and film systems

.. toctree::
   :maxdepth: 1
   :caption: Table of contents
   :numbered:

   introduction
   requirements
   installation
   starting
   input_files
   tutorial
   reference
   troubleshooting