merge Develop

README.md

@@ -19,7 +19,7 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - Refer to the acronyms.tex file for making additional edits and updates to this sheet.
 
 ## Edit Notes & Information:
-- Modified- 20240910 (YYYYMMDD)
+- Modified- 20240924 (YYYYMMDD)
 - Notes: Combined other acronym listings to this file and added some missing acronyms.
 
 ---------------------------------
@@ -106,6 +106,7 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - OPD -> OPD -> optical path difference
 - MEL -> MEL -> Master Equipment List
 - EFC -> EFC -> electric-field conjugation
+- iEFC -> EFC -> implicit -> Lower-Case= EFC
 - LDFC -> LDFC -> linear dark field control
 - DAC -> DAC -> digital-to-analog converter
 - TMA -> TMA -> three-mirror anastigmat
@@ -176,6 +177,7 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - PSFTFC -> PSFTFC -> PSF template subtracted coronagraphy
 - LOWFSC -> LOWFSC -> Low-order -> Lower-Case= WFS -> and control
 - scoob -> SCoOB -> Space Coronagraph Optical Bench
+- FDPR -> FDPR -> focus diversity phase retrieval
 
 ---------------------------------
 
@@ -249,6 +251,7 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - UVS -> UVS -> Ultraviolet Spectrograph
 - IFS -> IFS -> Integral Field Spectrograph
 - STIS -> STIS -> Space Telescope Imaging Spectrograph
+- SCoOB -> scoob -> space-coronagraph optical bench
 
 ---------------------------------
 
@@ -270,6 +273,7 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - CAD -> CAD -> computer-aided design
 - DBMS -> DBMS -> database management system
 - POPPY -> POPPY -> Physical Optics Propagation in Python
+- SOEDMS -> SOEDMS -> Steward Observatory Electronic Data Management System
 
 ---------------------------------
 
@@ -356,6 +360,17 @@ For storing the latest versions of acronyms for other repos to pull from. The [`
 - AC -> AC -> Alternating Current
 - RH -> RH -> Relative Humidity
 - RGA -> RGA -> Residual Gas Analyzer
+- esds -> ESDS -> ESD Sensitive
+- dmm -> DMM -> Digital Multimeter
+- DC -> DC -> Direct Current
+- CPG -> CPG -> Common Point Ground
+- WM -> WM -> Workmanship Manual
+- N/A -> N/A -> Not Applicable
+- na -> NA -> Not Applicable
+- MM -> MM -> Machine Model [for electrostatic discharge]
+- LVDS -> LVDS -> Low-Voltage Differential Signal
+- LNA -> LNA -> Low Noise Amplifier
+
 
 ---------------------------------
 

combined-acronyms.md

@@ -3,7 +3,7 @@
 - Refer to the acronyms.tex file for making additional edits and updates to this sheet.
 
 ## Edit Notes & Information:
-- Modified- 20240910 (YYYYMMDD)
+- Modified- 20240924 (YYYYMMDD)
 - Notes: Combined other acronym listings to this file and added some missing acronyms.
 
 ---------------------------------
@@ -90,6 +90,7 @@
 - OPD -> OPD -> optical path difference
 - MEL -> MEL -> Master Equipment List
 - EFC -> EFC -> electric-field conjugation
+- iEFC -> EFC -> implicit -> Lower-Case= EFC
 - LDFC -> LDFC -> linear dark field control
 - DAC -> DAC -> digital-to-analog converter
 - TMA -> TMA -> three-mirror anastigmat
@@ -160,6 +161,7 @@
 - PSFTFC -> PSFTFC -> PSF template subtracted coronagraphy
 - LOWFSC -> LOWFSC -> Low-order -> Lower-Case= WFS -> and control
 - scoob -> SCoOB -> Space Coronagraph Optical Bench
+- FDPR -> FDPR -> focus diversity phase retrieval
 
 ---------------------------------
 
@@ -233,6 +235,7 @@
 - UVS -> UVS -> Ultraviolet Spectrograph
 - IFS -> IFS -> Integral Field Spectrograph
 - STIS -> STIS -> Space Telescope Imaging Spectrograph
+- SCoOB -> scoob -> space-coronagraph optical bench
 
 ---------------------------------
 
@@ -254,6 +257,7 @@
 - CAD -> CAD -> computer-aided design
 - DBMS -> DBMS -> database management system
 - POPPY -> POPPY -> Physical Optics Propagation in Python
+- SOEDMS -> SOEDMS -> Steward Observatory Electronic Data Management System
 
 ---------------------------------
 
@@ -340,6 +344,17 @@
 - AC -> AC -> Alternating Current
 - RH -> RH -> Relative Humidity
 - RGA -> RGA -> Residual Gas Analyzer
+- esds -> ESDS -> ESD Sensitive
+- dmm -> DMM -> Digital Multimeter
+- DC -> DC -> Direct Current
+- CPG -> CPG -> Common Point Ground
+- WM -> WM -> Workmanship Manual
+- N/A -> N/A -> Not Applicable
+- na -> NA -> Not Applicable
+- MM -> MM -> Machine Model [for electrostatic discharge]
+- LVDS -> LVDS -> Low-Voltage Differential Signal
+- LNA -> LNA -> Low Noise Amplifier
+
 
 ---------------------------------
 

combined_acronyms.tex

@@ -19,7 +19,7 @@
 %% Refer to the acronyms.tex file for making additional edits and updates to this sheet.
 
 %%+ Edit Notes & Information:
-%% Modified- 20240910 (YYYYMMDD)
+%% Modified- 20240924 (YYYYMMDD)
 %% Notes: Combined other acronym listings to this file and added some missing acronyms.
 
 % Units:
@@ -91,6 +91,7 @@
 \newacronym{OPD}{OPD}{optical path difference}
 \newacronym{MEL}{MEL}{Master Equipment List}
 \newacronym{EFC}{EFC}{electric-field conjugation}
+\newacronym{iEFC}{EFC}{implicit \gls{EFC}}
 \newacronym{LDFC}{LDFC}{linear dark field control}
 \newacronym{DAC}{DAC}{digital-to-analog converter}
 \newacronym{TMA}{TMA}{three-mirror anastigmat}
@@ -155,7 +156,7 @@
 \newacronym{PSFTFC}{PSFTFC}{PSF template subtracted coronagraphy}
 \newacronym{LOWFSC}{LOWFSC}{Low-order \gls{WFS} and control}
 \newacronym{scoob}{SCoOB}{Space Coronagraph Optical Bench}
-\newacronym{ZIF}{ZIF}{zero insertion force}
+\newacronym{FDPR}{FDPR}{focus diversity phase retrieval}
 
 % Observatories and Instruments:
 \newacronym{HST}{HST}{Hubble Space Telescope}
@@ -226,6 +227,7 @@
 \newacronym{UVS}{UVS}{Ultraviolet Spectrograph}
 \newacronym{IFS}{IFS}{Integral Field Spectrograph}
 \newacronym{STIS}{STIS}{Space Telescope Imaging Spectrograph}
+\newacronym{SCoOB}{scoob}{space-coronagraph optical bench}
 
 % Software:
 \newacronym{AURIC}{AURIC}{The Atmospheric Ultraviolet Radiance Integrated Code}
@@ -244,6 +246,7 @@
 \newacronym{CAD}{CAD}{computer-aided design}
 \newacronym{DBMS}{DBMS}{database management system}
 \newacronym{POPPY}{POPPY}{Physical Optics Propagation in Python}
+\newacronym{SOEDMS}{SOEDMS}{Steward Observatory Electronic Data Management System}
 
 % Earth's Atmosphere and Ionosphere:
 \newacronym{MSIS}{MSIS}{Mass Spectrometer Incoherent Scatter Radar}
@@ -324,6 +327,17 @@
 \newacronym{AC}{AC}{Alternating Current}
 \newacronym{RH}{RH}{Relative Humidity}
 \newacronym{RGA}{RGA}{Residual Gas Analyzer}
+\newacronym{esds}{ESDS}{ESD Sensitive}
+\newacronym{dmm}{DMM}{Digital Multimeter}
+\newacronym{DC}{DC}{Direct Current}
+\newacronym{CPG}{CPG}{Common Point Ground}
+\newacronym{WM}{WM}{Workmanship Manual}
+\newacronym{N/A}{N/A}{Not Applicable}
+\newacronym{na}{NA}{Not Applicable}
+\newacronym{MM}{MM}{Machine Model [for electrostatic discharge]}
+\newacronym{LVDS}{LVDS}{Low-Voltage Differential Signal}
+\newacronym{LNA}{LNA}{Low Noise Amplifier}
+
 
 % Material Abbreviations
 \newacronym{PVC}{PVC}{Polyvinyl Chloride}

compile-test.sh

@@ -0,0 +1,10 @@
+# Simply for compiling compile-test.tex to see if it has errors. No error catching at the moment / using latex warnings for troubleshooting if there are problems with edits.
+
+# Setup gitinfo
+sed -i -e 's/\r$//' gitinfo2-hook.sh
+bash gitinfo2-hook.sh
+
+# Using -shell-escape in case this repo becomes a latex documentation template and minted is used.
+xelatex -shell-escape compile-test.tex
+xelatex -shell-escape compile-test.tex
+

compile-test.tex

@@ -0,0 +1,96 @@
+%! Author = srinaldi
+%! Date = 9/24/2024
+
+% Preamble
+\documentclass[12pt]{book}
+
+% Packages
+\usepackage{amsmath}
+\usepackage[toc]{glossaries}
+\usepackage[automake]{glossaries-extra}
+\usepackage{gitinfo2}
+\usepackage{hyperref}
+\usepackage{fancyhdr}
+\usepackage{enumitem}
+\usepackage{longtable}
+
+% Glossary settings / loading
+\loadglsentries[\acronymtype]{combined_acronyms.tex}
+\loadglsentries[term]{glossaries.tex}
+\makeglossaries
+
+% Set Variables
+\def\title{LaTeX Compiling Test}
+\def\subtitle{Verifying acronyms and glossaries entries made in .tex files compile correctly.}
+\def\repourl{\url{https://github.com/uasal/acronyms/tree/main}}
+
+\edef\masterBranch{\detokenize{master}}
+\edef\gitBranch{\gitBranch}
+
+% Setup internal link colors
+\hypersetup{%
+	colorlinks=true,
+	linkcolor=blue,
+	urlcolor=blue,
+	filecolor=blue,
+	linktoc=all,
+	citecolor=blue,
+}
+
+
+% Pagestyles
+\cfoot{\thepage\n }
+\pagestyle{fancy}
+\fancyhf{}
+\fancyhead[LE,RO]{Rev: \gitAbbrevHash- \gitDirty\, \gitCommitterDate}
+\fancyhead[RE,LO]{LaTeX Acronyms \& Terms, Page \thepage}
+\fancyfoot[CE,CO]{\rightmark}
+\setlength{\headheight}{14.49998pt}
+\addtolength{\topmargin}{-2.49998pt}
+%\fancyfoot[LE,RO]{}
+\topskip0pt
+
+
+% Document
+\begin{document}
+
+    % Making Title Page
+    \renewcommand{\maketitle}{
+	\pagestyle{empty}
+	\thispagestyle{empty}
+	%--- Make title page
+	\begin{center}
+		\vspace{0.5cm} \mbox{}\hrulefill \mbox{}\\[1cm]
+     		{\Huge \textbf{\title}\\[1cm]}
+     		{\LARGE \textit{\subtitle}}\\[2cm]
+			%{\small \textbf{Teledoc Link: }\textit{\teledoc}}\\[0.3cm]
+            {\small \textbf{Repository: }\textit{\repourl}}\\[0.5cm]
+			{\small \textbf{Branch: } \gitBranch}
+			{\small \textbf{  |  Commit:} \gitDescribe}\\[0.5cm]
+     		%{\small \textit{\access}} \vfill
+     		{\small \mbox{}\hrulefill\mbox{}\\[10mm]}
+            \footnote{{ Revision: \gitAbbrevHash - \gitDirty\ Date: \gitCommitterDate}}
+  	\end{center}
+	\pagestyle{fancy}
+}
+
+    \maketitle
+	\newpage
+
+    \setcounter{secnumdepth}{4}
+    \setcounter{tocdepth}{2}
+    \tableofcontents
+
+	\chapter{Overview}
+    Testing acronyms and glossary entries.
+
+	\chapter{List of Terms and Abbreviations}
+	\setglossarysection{section}
+	\printglossary[type=\acronymtype]
+	\printglossary[type=term]
+%\printglossary[type=\acronymtype]
+%\glsaddallunused[\acronymtype]
+
+	Fin.
+
+\end{document}

gitinfo2-hook.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+# Copyright 2015 Brent Longborough
+# Part of gitinfo2 package Version 2
+# Release 2.0.7 2015-11-22
+# Please read gitinfo2.pdf for licencing and other details
+# -----------------------------------------------------
+# Post-{commit,checkout,merge} hook for the gitinfo2 package
+#
+# Get the first tag found in the history from the current HEAD
+FIRSTTAG=$(git describe --tags --always --dirty='-*' 2>/dev/null)
+# Get the first tag in history that looks like a Release
+RELTAG=$(git describe --tags --long --always --dirty='-*' --match 'v[0-9]*.*' 2>/dev/null)
+# Hoover up the metadata
+git --no-pager log -1 --date=short --decorate=short \
+    --pretty=format:"\usepackage[%
+        shash={%h},
+        lhash={%H},
+        authname={%an},
+        authemail={%ae},
+        authsdate={%ad},
+        authidate={%ai},
+        authudate={%at},
+        commname={%cn},
+        commemail={%ce},
+        commsdate={%cd},
+        commidate={%ci},
+        commudate={%ct},
+        refnames={%d},
+        firsttagdescribe={$FIRSTTAG},
+        reltag={$RELTAG}
+    ]{gitexinfo}" HEAD > .git/gitHeadInfo.gin

glossaries.tex

@@ -0,0 +1,42 @@
+%! Author = srinaldi
+%! Date = 2024-09-23
+
+% For recording terms and definitions (separate from acronyms) to be used in latex generating repositories or for reference.
+% Use the following command for adding a new term to the glossary:
+% \newglossaryentry{term}{type={term},name={term},description={term description}}
+
+\newglossaryentry{assembly}
+{
+    type={term},
+    name={assembly},
+    description={A functional subdivision of a component, consisting of parts or subassemblies, which perform functions necessary for the operation of the component as a whole. Examples: regulator assembly, power amplifier assembly, gyro assembly, etc.}
+}
+\newglossaryentry{cheater plug}
+{
+    type={term},
+    name={cheater plug},
+    description={An Alternating Current \gls{AC} plug adapter used to connect a three-pronged plug to a two-pronged AC socket. It can be used to separate the ground wire from the socket for testing purposes.}
+}
+\newglossaryentry{component}
+{
+    type={term},
+    name={component},
+    description={A functional subdivision of a system, generally a self-contained combination of assemblies performing a function necessary for the system's operation. Examples: power supply, transmitter, gyro package, etc.}
+}
+\newglossaryentry{conductive material}{type={term},name={conductive material},description={A material that has a surface resistivity of <105 ohms per square or a volume resistivity <104 ohms-cm.}}
+\newglossaryentry{electrostatic discharge (ESD)}{type={term},name={electrostatic discharge},description={A transfer of electrostatic charge between bodies at different electrostatic potentials caused by direct contact or induced by an electrostatic field.}}
+\newglossaryentry{ESD-Protective Material}{type={term},name={ESD-Protective Material},description={Material capable of one or more of the following functions: limiting the generation of static electricity; safely dissipating electrostatic charges over its surface or volume; or providing shielding from ESD spark discharge or electrostatic fields.}}
+\newglossaryentry{ESD Protected Area}{type={term},name={ESD Protected Area},description={An area that is constructed and equipped with the necessary ESD-protective materials and equipment to limit ESD voltage below the sensitivity level of ESDS items handled therein. This may include benches, rooms or buildings.}}
+\newglossaryentry{Kit}{type={term},name={Kit},description={A prepared package of parts with instructions for assembly and/or wiring a component or chassis.}}
+\newglossaryentry{Operator}{type={term},name={Operator},description={An individual who is trained and certified to perform tasks in an ESD protected area.}}
+\newglossaryentry{Part}{type={term},name={Part},description={An element of a component, assembly, or subassembly which is not normally subject to further subdivision or disassembly without destruction of its designed use, e.g., a module, Integrated Circuit (IC), resistor, etc.}}
+\newglossaryentry{Soft Ground}{type={term},name={Soft Ground},description={A connection to ground through impedance sufficiently high to limit current flow to safe levels for personnel (normally 5 milliamperes). Impedance needed for a soft ground is dependent upon the voltage levels which could be contacted by personnel near the ground. By this definition a hard ground protected by a functional GFCI is considered a soft ground.}}
+\newglossaryentry{Static Dissipative}{type={term},name={Static Dissipative},description={A property of a material having surface resistivity ≥105 but <1012 ohms per square or a volume resistivity ≥104 but <1011 ohms-cm.}}
+\newglossaryentry{Surface Resistivity}{type={term},name={Surface Resistivity},description={The surface resistivity is an inverse measure of the conductivity of a material. Surface resistivity of a material is numerically equal to the surface resistance between two electrodes forming opposite sides of a square. The size of the square is immaterial. Surface resistivity applies to both surfaces and materials with constant volume conductivity and has the value of ohms per square.}}
+\newglossaryentry{Triboelectric}{type={term},name={Triboelectric},description={Pertaining to electricity generated by friction.}}
+\newglossaryentry{Electrostatic Field}{type={term},name={Electrostatic Field},description={A voltage gradient between an electrostatically charged surface and another surface of a different electrostatic potential.}}
+\newglossaryentry{Ground}{type={term},name={Ground},description={A mass such as earth, a ship, or a vehicle hull, capable of supplying or accepting a large electrical charge.}}
+\newglossaryentry{Groundable Point}{type={term},name={Groundable Point},description={Any point with low impedance to ground where grounding may be attached. Usually it is the common point ground.}}
+\newglossaryentry{Hard Ground}{type={term},name={Hard Ground},description={A connection to earth ground either directly or through low impedance.}}
+\newglossaryentry{Insulative Material}{type={term},name={Insulative Material},description={A material having a surface resistivity ≥1012 ohms/square or a volume resistivity ≥1011 ohms-cm.}}
+