.. include:: /substitutions.rst

.. _glossary:

========
Glossary
========

.. glossary::

    API
      Application programming interface

    ASE
      Atomic Simulation Environment. See the `ASE homepage <https://wiki.fysik.dtu.dk/ase/>`__.

    BLAS
      Basic linear-algebra subprograms. See the
      `Wikipedia entry <https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms>`__.

    C
      The C programming language.

    CC BY 4.0
      Creative Commons Attribution 4.0 License.
      This documentation for all parts of the ViPErLEED project is licensed
      under the CC BY 4.0 license.
      The license allows free sharing and adaptation of the source material,
      but requires attribution to the original authors (e.g. via citation in a
      scientific publication).
      For more details see
      `here <https://creativecommons.org/licenses/by/4.0/>`__.

    CLI
      Command-line interface

    conda
      The conda package manager for :term:`Python`. See the
      `conda homepage <https://docs.conda.io/en/latest/>`__.

    CSV
      Comma-separated value format. See the
      `Wikipedia entry <https://en.wikipedia.org/wiki/Comma-separated_values>`__.

    DFT
      Density functional theory

    Environment variable
      A variable that is set in the environment of a process. It is used to
      pass information to a process. ViPErLEED uses the environment variable
      :envvar:`VIPERLEED_TENSORLEED` to locate the TensErLEED source code if
      the path is not given explicitly. See also :ref:`here<how_to_run>`.

    fcc
      Face-centered-cubic crystal structure.

    Fortran
      The Fortran programming language.
      One of the first high-level programming languages.
      It is still heavily used in legacy :term:`HPC` applications.
      TensErLEED is written in Fortran 77 and Fortran 90.
      See the `Wikipedia entry <https://en.wikipedia.org/wiki/Fortran>`__.

    gcc
      GNU compiler collection. See the GCC `homepage <https://gcc.gnu.org>`__.

    gfortran
      The GNU :term:`Fortran` compiler.

    GPLv3
      The GNU General Public License version 3.
      `License text <https://www.gnu.org/licenses/gpl-3.0.en.html#license-text>`__.

    GUI
      Graphical user interface

    HPC
      High-performance computing

    ifort
      Intel Fortran compiler.

    ImageJ
      ImageJ is a public domain image processing and analysis software commonly
      used in the scientific community.
      The ViPErLEED spot-tracker, curve editor and several associated utilities
      are implemented as ImageJ plugins.
      See also the `ImageJ homepage <https://imagej.net/ij/>`__.

    Jupyter
      The Jupyter project for interactive computing.
      Jupyter notebooks are commonly used as interactive Python environments.
      See also the `project Jupyter homepage <https://jupyter.org>`__.

    LAPACK
      Linear-algebra package. See the
      `Wikipedia entry <https://en.wikipedia.org/wiki/LAPACK>`__.

    LEED
      Low energy electron diffraction

    |LEED-IV|
      Energy-dependent low-energy electron diffraction.

    MPI
      Message-passing interface. See the
      `Wikipedia entry <https://en.wikipedia.org/wiki/Message_Passing_Interface>`__.

    mpifort
      The :term:`MPI` wrapper for :term:`gfortran`. See the `homepage <https://www.open-mpi.org/doc/v4.1/man1/mpifort.1.php>`__.

    mpiifort
      The :term:`MPI` wrapper for :term:`ifort`.

    TensErLEED
      Erlangen package for tensor LEED.
      See also the paper by :cite:t:`blumFastLEEDIntensity2001a`.

    VASP
      Vienna ab initio simulation package.
      See the `VASP wiki <https://www.vasp.at/wiki/index.php>`__.

    VESTA
      3D Visualization software for structural models :cite:p:`mommaVESTAThreedimensionalVisualization2011`.
      See also the VESTA `homepage <https://jp-minerals.org/vesta/en/>`__.

    PyPI
      The Python Package Index. See the `PyPI homepage <https://pypi.org>`__.

    Python
      The Python programming language. See the Python
      `homepage <https://www.python.org>`__.

    UHV
      Ultra-high vacuum

    ViPErLEED
      The Vienna Package for Erlangen LEED

    |calc|
      The Python package of ViPErLEED that deals with calculations
      of |LEED-IV| curves.

    WSL
      Windows Subsystem for Linux. See also `the page by Microsoft <https://learn.microsoft.com/en-us/windows/wsl/about>`__.

    XRD
      X-ray diffraction.