.. _glossary:

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

.. glossary::

    Jupyter notebook
        Powerful web application used in this project, for examples and
        tutorials containing real python code. From `<https://jupyter.org>`_:

            The Jupyter Notebook is an open-source web application that allows
            you to create and share documents that contain live code, equations,
            visualizations and narrative text.

    matplotlib
        Primary python package for plotting data. Highly customizable
        and extensible. More information at `<https://matplotlib.org>`_

    numpy
        Widely-used python package that allows multidimensional arrays
        and linear algebra routines. More information at
        `<https://www.numpy.org>`_
    
    pip
        Recommended tool for installing Python packages. More at
        `<https://pypi.org/project/pip/>`_

    pytest
        Fully featured python test runner. More at 
        `<https://pytest.org/en/latest/>`_

    yaml
        Human-readable format used for configuration files in this
        project. For more information, see
        `<https://pyyaml.org/wiki/PyYAMLDocumentation>`_
    
    sphinx
        A python package used to create (in this case) .html files out of .rst
        files. Sphinx powers the creation of this page! More information at
        `<https://www.sphinx-doc.org/en/master/index.html>`_

    latexocr
        A python based picture to Latex software. This program generated many of
        the equations displayed throughout the projects.
        `<https://pix2tex.readthedocs.io/en/latest/>`_

    serpentTools
        A python based package built for reading Serpent output data. This package
        is used extensively to interact with Serpent lattice calculations which are ingested
        for analysis.
        `<https://serpent-tools.readthedocs.io/en/master/>`_

    sympy
        A python library used for symbolic mathematics. Particularly useful when calculating moments of basis functions.
        `<https://www.sympy.org/en/index.html>`_

    Data Wrangler
        A VS Code extension designed for code-centric viewing and cleaning of tabular data. This
        is particularly useful while viewing data stored in dictionaries.
        `<https://code.visualstudio.com/docs/datascience/data-wrangler>`_