.. _api_crystal-module:

.. currentmodule:: radtools

**************
Crystal module
**************

.. versionadded:: 0.7

.. automodule:: radtools.crystal

.. currentmodule:: radtools

Classes
=======

.. toctree:: 
    :maxdepth: 2

    crystal
    lattice
    atom
    kpoints

Bravais lattice classes
=======================

.. autosummary::
    :toctree: generated/

    CUB
    FCC
    BCC
    TET
    BCT    
    ORC
    ORCF
    ORCI
    ORCC
    HEX
    RHL
    MCL
    MCLC
    TRI

Identification routines
=======================

.. autosummary::
    :toctree: generated/

    niggli
    lepage

Bravais lattice generation
==========================

.. autosummary::
    :toctree: generated/

    lattice_example
    bravais_lattice_from_param
    bravais_lattice_from_cell

Properties
==========

.. autosummary::
    :toctree: generated/

    dipole_dipole_energy
    dipole_dipole_interaction