Adding Glossary (#1642)

* added glossary * added more terms * added more terms and definitions, linked some terms to glossary Co-authored-by: Jinyoung Jeong <[email protected]> Co-authored-by: Jack O'Brien <[email protected]>
tardis-sn · Jun 29, 2021 · c47a3df · c47a3df
1 parent 5941658
commit c47a3df
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 4 deletions.
diff --git a/docs/development/continuous_integration.rst b/docs/development/continuous_integration.rst
@@ -44,7 +44,7 @@ pipelines and GitHub Actions for some others (called "workflows"). The
 following sections explains briefly the different components of a
 pipeline/workflow, mostly focused on the Azure service.
 
-A pipeline (or a workflow) is essentially a YAML configuration file 
+A pipeline (or a workflow) is essentially a :term:`YAML` configuration file 
 with different sections such as variables, jobs and steps. These files
 run commands or tasks when they are triggered by some event, like a 
 commit being pushed to a certain branch.

diff --git a/docs/development/matterbridge.rst b/docs/development/matterbridge.rst
@@ -9,8 +9,8 @@ Overview
 We use Matterbridge to connect channels across different messaging platforms
 such as *Slack*, *Mattermost* and *Gitter*. Matterbridge provides binaries 
 for  many operating systems. The ``matterbridge`` binary is intended to be used
-in combination with a TOML configuration file:
-::
+
+in combination with a :term:`TOML` configuration file::
 
   $ ./matterbridge -conf config-tardis-matterbridge.toml
 

diff --git a/docs/physics/montecarlo/lineinteraction.rst b/docs/physics/montecarlo/lineinteraction.rst
@@ -5,7 +5,7 @@ Line Interaction Treatments
 ***************************
 
 TARDIS currently offers different ways to handle line interactions, which may be
-activated via the YAML configuration file. Independently of the chosen
+activated via the :term:`YAML` configuration file. Independently of the chosen
 treatment, a number of steps are always carried out when a Monte Carlo packet
 performs a line interaction. Since TARDIS adopts the indivisible energy packet
 formalism (see :ref:`Energy Packets <initialization>`), the packet will have the

diff --git a/docs/zreferences.rst b/docs/zreferences.rst
@@ -35,3 +35,20 @@ References
 ==========
 
 .. bibliography:: tardis.bib
+
+.. glossary:: 
+
+    Chianti
+        CHIANTI consists of a critically evaluated set of up-to-date atomic data, together with user-friendly programs written in Interactive Data Language (IDL) and Python to calculate the spectra from astrophysical plasmas.
+
+    Meta-Stable
+        Metastability is the condition of a system where the system has stability, but is not as stable as in the system's state of least energy.
+
+    Synapps
+        SYNAPPS is an open-source spectrum fitter embedding a highly parameterized synthetic SN spectrum calculation within a parallel asynchronous optimizer, created to systematically interpret large sets of SN spectroscopy data.
+
+    TOML
+        TOML (Tom's Obvious, Minimal Language) is a minimal configuration file format that is designed to be easy to read due to obvious semantics. It is designed to map unambiguously to a hash table and to be easy to parse into data structures in a wide variety of languages. TOML files have the ending ".toml".
+
+    YAML
+        YAML (YAML Ain't Markup Language) is a human friendly data serialization standard for all programming languages. It is commonly used for configuration files and in applications where data is being stored or transmitted. YAML files have the ending ".yml".