.. _api_constants:

*****************
wulfric.constants
*****************

.. toctree::
    :hidden:

    atom_species
    atomic_mass
    atom_colors
    sc_bravais_lattice_short_names
    sc_bravais_lattice_long_names
    sc_conventional_to_primitive
    sc_bravais_lattice_variations
    sc_default_k_paths
    hpkot_default_k_paths
    hpkot_conventional_to_primitive
    hpkot_extended_bl_symbols
    todegrees
    toradians
    inversion_symmetry
    crystal_family
    centring_type
    hs_plot_names
    bravais_lattices


Atoms
=====

================================= ====================================
:ref:`api_constants_ATOM_SPECIES` All possible atom species.
:ref:`api_constants_ATOMIC_MASS`  Atomic mass
:ref:`api_constants_ATOM_COLORS`  Atom colors that are used by default
================================= ====================================

Setyawan and Curtarolo convention
=================================

=================================================== =================================================================
:ref:`api_constants_SC_BRAVAIS_LATTICE_SHORT_NAMES` Short names of the Bravais lattices.
:ref:`api_constants_SC_BRAVAIS_LATTICE_LONG_NAMES`  Long names of the Bravais lattices.
:ref:`api_constants_SC_CONVENTIONAL_TO_PRIMITIVE`   Transformation matrices from conventional cell to primitive cell.
:ref:`api_constants_SC_BRAVAIS_LATTICE_VARIATIONS`  List of all possible variations of the Bravais lattices.
:ref:`api_constants_SC_DEFAULT_K_PATHS`             Default k-path for each variation of Bravais lattices.
=================================================== =================================================================

Hinuma, Pizzi, Kumagai, Oba, Tanaka convention
==============================================

==================================================== =================================================================
:ref:`api_constants_HPKOT_CONVENTIONAL_TO_PRIMITIVE` Transformation matrices from conventional cell to primitive cell.
:ref:`api_constants_HPKOT_DEFAULT_K_PATHS`           Default k-path for each extended Bravais lattice symbols.
:ref:`api_constants_HPKOT_EXTENDED_BL_SYMBOLS`       Extended Bravais lattice symbols.
==================================================== =================================================================

Kpoints
=======

================================== =================================================
:ref:`api_constants_HS_PLOT_NAMES` Names of high-symmetry k points written in LaTex.
================================== =================================================

Angle conversion
================

============================== ==========================================
:ref:`api_constants_TODEGREES` Constant that converts radians to degrees.
:ref:`api_constants_TORADIANS` Constant that converts degrees to radians.
============================== ==========================================

Space Groups
============

======================================= =====================================================================
:ref:`api_constants_INVERSION_SYMMETRY` Whether the space group has inversion as a symmetry operation or not.
:ref:`api_constants_CRYSTAL_FAMILY`     Crystal family of every space group.
:ref:`api_constants_CENTRING_TYPE`      Centring type of every space group.
======================================= =====================================================================

Bravais lattices
================

===================================== ============================
:ref:`api_constants_BRAVAIS_LATTICES` Symbols of Bravais lattices.
===================================== ============================