Merge pull request #2 from henze-research-group/add-thesis-class

Add PhD Thesis Class

.gitignore

@@ -4,11 +4,13 @@
 *.aux
 *.bbl
 *.blg
+*.fdb_latexmk
+*.fls
 *.ist
 *.lof
 *.log
 *.lol
 *.lot
 *.out
 *.synctex.gz
-*.toc
+*.toc

.vscode/settings.json

@@ -0,0 +1,33 @@
+{
+    "latex-workshop.latex.recipes":[
+        {
+            "name": "Build with glossaries",
+            "tools": [
+                "pdflatex",
+                "makeglossaries",
+                "pdflatex",
+                "pdflatex"
+            ]
+        },
+    ],
+    "latex-workshop.latex.tools":[
+        {
+            "name": "pdflatex",
+            "command": "pdflatex",
+            "args": [
+                "-synctex=1",
+                "-interaction=nonstopmode",
+                "-file-line-error",
+                "%DOC%"
+            ]
+        },
+        {
+            "name": "makeglossaries",
+            "command": "makeglossaries",
+            "args": [
+              "%DOCFILE%"
+            ]
+          }
+    ],
+    "cSpell.words": []
+}

README.md

@@ -1,12 +1,58 @@
-# CU Boulder's LaTeX Template
+# CU Boulder's LaTeX Templates
 
 This repository contains an updated version of CU's LaTeX class with support for a couple other features including:
 
 * table of acronyms
 * table of code snippets
 
-The resulting PDF contains examples on how to best use LaTeX for a PhD Prospectus.
+The resulting PDF contains examples on how to best use LaTeX for a PhD Prospectus or PhD Thesis.
 
-To use, open `main-cu-prospectus.tex` in your favorite Tex editor. I use TexStudio. You can also upload this entire package to Overleaf to edit collaboratively online.
+To use, open `main-cu-prospectus.tex` in your favorite Tex editor such as TexStudio or VSCode. You can also upload this entire package to Overleaf to edit collaboratively online.
 
-An example PDF is in this project [here](./main-cu-prospectus.pdf) but a version is created each commit on GitHub. The GitHub veresion is [here](https://github.com/henze-research-group/latex-template/actions). Go to the latest passing workflow run, then click on the PDF text in the Artifacts section. Note that this version does not have the Acronyms listing since the build step does not know how to `makeglossaries`.
+One catch is that to see the acronyms the `makeglossaries` command needs to be in the build step. This repo committed the .vscode/settings.json file with the changes. In TexStudio, this will need to be 
+manually configured as well. Also, it is common to have to call the `pdflatex` command twice to have the glossaries show up correctly.
+
+```
+    "latex-workshop.latex.recipes":[
+        {
+            "name": "Build with glossaries",
+            "tools": [
+                "pdflatex",
+                "makeglossaries",
+                "pdflatex",
+                "pdflatex"
+            ]
+        },
+    ],
+    "latex-workshop.latex.tools":[
+        {
+            "name": "pdflatex",
+            "command": "pdflatex",
+            "args": [
+                "-synctex=1",
+                "-interaction=nonstopmode",
+                "-file-line-error",
+                "%DOC%"
+            ]
+        },
+        {
+            "name": "makeglossaries",
+            "command": "makeglossaries",
+            "args": [
+              "%DOCFILE%"
+            ]
+          }
+    ]
+```
+
+An example PDF is in this project [here](./main-cu-prospectus.pdf) and [here](./main-cu-phd-thesis.pdf) but a version is created each commit on GitHub. The GitHub veresion is [here](https://github.com/henze-research-group/latex-template/actions). Go to the latest passing workflow run, then click on the PDF text in the Artifacts section. Note that the GitHub build version does not have the Acronyms listing since the build step does not know how to `makeglossaries`.
+
+The difference between the prospectus and thesis is minimal. The prospectus version contains language that it is just that, a prospectus, and the thesis.cls has the approval page.
+
+## Notes
+
+If using vscode, then the latex-formatter might require an installation of a PERL library called HomeDir. This can be accomplished (on macOS) with the following brew install command.
+
+```
+brew install latexindent
+```

bibliography.bib

@@ -4,39 +4,39 @@
 BibTeX export options can be customized via Preferences -> BibTeX in Mendeley Desktop
 
 @techreport{EnergyInformationAdministration2020,
-abstract = {Table 1.3 Primary Energy Consumption by Source},
-author = {{U.S. Energy Information Administration}},
-booktitle = {Monthly Energy Review},
-file = {:Users/nlong/Documents/Bibtex/Library/U.S. Energy Information Administration - 2020 - Monthly Energy Review.pdf:pdf},
-institution = {US DOE Energy Information Administration},
-isbn = {2025862792},
-keywords = {biofuels,carbon emissions,coal,consumption,electricity,energy,energy prices,hydroelectric,international energy,natural gas,nuclear,overview,petroleum,renewable energy},
-number = {December},
-pages = {235},
-title = {{Monthly Energy Review}},
-url = {http://www.eia.gov/totalenergy/data/monthly},
-volume = {0035},
-year = {2020}
+  abstract    = {Table 1.3 Primary Energy Consumption by Source},
+  author      = {{U.S. Energy Information Administration}},
+  booktitle   = {Monthly Energy Review},
+  file        = {:Users/nlong/Documents/Bibtex/Library/U.S. Energy Information Administration - 2020 - Monthly Energy Review.pdf:pdf},
+  institution = {US DOE Energy Information Administration},
+  isbn        = {2025862792},
+  keywords    = {biofuels,carbon emissions,coal,consumption,electricity,energy,energy prices,hydroelectric,international energy,natural gas,nuclear,overview,petroleum,renewable energy},
+  number      = {December},
+  pages       = {235},
+  title       = {{Monthly Energy Review}},
+  url         = {http://www.eia.gov/totalenergy/data/monthly},
+  volume      = {0035},
+  year        = {2020}
 }
 @techreport{Landsberg2014,
-abstract = {ASHRAE Guidelines are scheduled to be updated on a five-year cycle; the date following the Guideline number is the year of ASHRAE approval. The latest edition of an ASHRAE Guideline may be purchased on the ASHRAE website (www.ashrae.org) or from ASHRAE Customer Service,},
-address = {Atlanta, GA},
-author = {Landsberg, Dennis R and Shonder, John A and Barker, Kimberly A and Haberl, Jeff S and Judson, Scott A and Jump, David A and Koran, William E and Hall, Richard L and Reindl, Douglass T and Anderson, Joseph R and Barnaby, Charles S and Clark, John A and Dunlap, John F and Earley, James W and Emmerich, Steven J and Graef, Patricia T},
-file = {:Users/nlong/Documents/Bibtex/Library/Landsberg et al. - 2014 - ASHRAE Guideline 14-2014 Measurement of Energy, Demand, and Water Savings.pdf:pdf},
-institution = {ASHRAE},
-title = {{ASHRAE Guideline 14-2014: Measurement of Energy, Demand, and Water Savings}},
-url = {www.ashrae.org/technology.},
-volume = {2014},
-year = {2014}
+  abstract    = {ASHRAE Guidelines are scheduled to be updated on a five-year cycle; the date following the Guideline number is the year of ASHRAE approval. The latest edition of an ASHRAE Guideline may be purchased on the ASHRAE website (www.ashrae.org) or from ASHRAE Customer Service,},
+  address     = {Atlanta, GA},
+  author      = {Landsberg, Dennis R and Shonder, John A and Barker, Kimberly A and Haberl, Jeff S and Judson, Scott A and Jump, David A and Koran, William E and Hall, Richard L and Reindl, Douglass T and Anderson, Joseph R and Barnaby, Charles S and Clark, John A and Dunlap, John F and Earley, James W and Emmerich, Steven J and Graef, Patricia T},
+  file        = {:Users/nlong/Documents/Bibtex/Library/Landsberg et al. - 2014 - ASHRAE Guideline 14-2014 Measurement of Energy, Demand, and Water Savings.pdf:pdf},
+  institution = {ASHRAE},
+  title       = {{ASHRAE Guideline 14-2014: Measurement of Energy, Demand, and Water Savings}},
+  url         = {www.ashrae.org/technology.},
+  volume      = {2014},
+  year        = {2014}
 }
 @techreport{Satchwell2021,
-address = {Washington, DC},
-author = {Satchwell, Andrew; and Piette, Mary Ann; and Khandekar, Aditya; and Granderson, Jessica; and Frick, Natalie Mims; and Hledik, Ryan and Faruqui, Ahmad and Lam, Long and Ross, Stephanie and Cohen, Jesse and Wang, Kitty and Urigwe, Daniela and Delurey, Dan and Neukomm, Monica and Nemtzow, David},
-file = {:Users/nlong/Documents/Bibtex/Library/Satchwell et al. - 2021 - A National Roadmap for Grid-Interactive Efficient Buildings.pdf:pdf},
-institution = {Department of Energy Office of Energy Efficiency and Reneweable Energy's Building Technologies Office},
-keywords = {DER,EE,Energy Solutions,GEB,GHG,Grid-Interactive Efficient Buildings,Lawrence Berkeley National Laboratory,Smart Grid,The Brattle Group,U.S. Department of Energy,Wedgemere Group,decarbonization,distributed energy resources,electrification,energy efficiency,energy policy,green buildings,greenhouse gas emissions},
-mendeley-tags = {GEB},
-title = {{A National Roadmap for Grid-Interactive Efficient Buildings}},
-url = {https://escholarship.org/uc/item/78k303s5},
-year = {2021}
+  address       = {Washington, DC},
+  author        = {Satchwell, Andrew; and Piette, Mary Ann; and Khandekar, Aditya; and Granderson, Jessica; and Frick, Natalie Mims; and Hledik, Ryan and Faruqui, Ahmad and Lam, Long and Ross, Stephanie and Cohen, Jesse and Wang, Kitty and Urigwe, Daniela and Delurey, Dan and Neukomm, Monica and Nemtzow, David},
+  file          = {:Users/nlong/Documents/Bibtex/Library/Satchwell et al. - 2021 - A National Roadmap for Grid-Interactive Efficient Buildings.pdf:pdf},
+  institution   = {Department of Energy Office of Energy Efficiency and Reneweable Energy's Building Technologies Office},
+  keywords      = {DER,EE,Energy Solutions,GEB,GHG,Grid-Interactive Efficient Buildings,Lawrence Berkeley National Laboratory,Smart Grid,The Brattle Group,U.S. Department of Energy,Wedgemere Group,decarbonization,distributed energy resources,electrification,energy efficiency,energy policy,green buildings,greenhouse gas emissions},
+  mendeley-tags = {GEB},
+  title         = {{A National Roadmap for Grid-Interactive Efficient Buildings}},
+  url           = {https://escholarship.org/uc/item/78k303s5},
+  year          = {2021}
 }

chapter1-intro.tex

@@ -1,9 +1,9 @@
 \chapter{Introduction}
 \label{section_introduction}
 
-\singlespacing	
+\singlespacing
 
-Example document showing the features of this \LaTeX\ class. Citations are similar to any other \LaTeX\ document and require a bibtex format of the bibliography to be saved in the project directory. 
+Example document showing the features of this \LaTeX\ class. Citations are similar to any other \LaTeX\ document and require a bibtex format of the bibliography to be saved in the project directory.
 
 \section{Figures}
 
@@ -38,13 +38,13 @@ \section{Tables}
 	\begin{tabular}{|L{4.5cm}|L{5.5cm}|L{5.0cm}|}
 		\hline
 		\rowcolor{lightgray}
-		\textbf{Research Objective} & \textbf{Method of Achievement}  & \textbf{Expected Outcome}   \\ \hline \hline
+		\textbf{Research Objective}                                                                                                                       & \textbf{Method of Achievement} & \textbf{Expected Outcome} \\ \hline \hline
 		% next row
-		Cell 1 & Cell 2 & Cell 2 \\ \hline
+		Cell 1                                                                                                                                            & Cell 2                         & Cell 2                    \\ \hline
 		% next row
-		Another cell &
+		Another cell                                                                                                                                      &
 		And another cell with some text wrapping if there is enough text needed for it to wrap based on the fixed width defined in the tabular definition &
-		Last cell for this row \\ \hline
+		Last cell for this row                                                                                                                                                                                         \\ \hline
 	\end{tabular}
 	\label{tbl_example}
 \end{table}
@@ -80,18 +80,18 @@ \section{Lists and Enumerations}
 
 \begin{enumerate}
 	\item First item
-	\begin{itemize}
-		\item Example of just a bullet item
-		\item Another item
-		\item Last item!
-	\end{itemize}
+	      \begin{itemize}
+		      \item Example of just a bullet item
+		      \item Another item
+		      \item Last item!
+	      \end{itemize}
 
 	\item Second numbered item
-	\begin{enumerate}
-		\item Keep the list going,
-		\item With more items,
-		\item But now I'm done.
-	\end{enumerate}
+	      \begin{enumerate}
+		      \item Keep the list going,
+		      \item With more items,
+		      \item But now I'm done.
+	      \end{enumerate}
 \end{enumerate}
 
 \section{Code Snippets}

listings-modelica.cfg.tex

@@ -20,13 +20,13 @@
 \lstdefinelanguage{modelica}
 {
 	morekeywords=[1]{
-		algorithm,and,annotation,as,assert,block,break,case,class,connect,connector,
-		constant,constrainedby,der,discrete,each,else,elseif,elsewhen,encapsulated,
-		end,enumeration,equality,equation,expandable,extends,external,failure,final,
-		flow,for,function,guard,if,import,in,initial,inner,input,List,local,loop,
-		match,matchcontinue,model,not,operator,Option,or,outer,output,package,parameter,
-		partial,protected,public,record,redeclare,replaceable,return,stream,
-		subtypeof,then,Tuple,type,uniontype,when,while},
+			algorithm,and,annotation,as,assert,block,break,case,class,connect,connector,
+			constant,constrainedby,der,discrete,each,else,elseif,elsewhen,encapsulated,
+			end,enumeration,equality,equation,expandable,extends,external,failure,final,
+			flow,for,function,guard,if,import,in,initial,inner,input,List,local,loop,
+			match,matchcontinue,model,not,operator,Option,or,outer,output,package,parameter,
+			partial,protected,public,record,redeclare,replaceable,return,stream,
+			subtypeof,then,Tuple,type,uniontype,when,while},
 	morekeywords=[2]{true, false},
 	% Do not make true,false keywords because fn(true,x, false ) shows up as fn(true,x, *false*)
 	morekeywords=[3]{optimization,constraint}, % Optimica keywords

macros.tex

@@ -10,14 +10,14 @@
 \newcommand{\vth}{V_{\theta}}
 
 \newcommand{\twochoices}[2]{\left\{ \begin{array}{lcc}
-        \displaystyle #1 \\ \vspace{-10pt} \\
-        \displaystyle #2 \end{array} \right. } %}
+                \displaystyle #1 \\ \vspace{-10pt} \\
+                \displaystyle #2\end{array} \right. } %}
 
 \newcommand{\threechoices}[3]{\left\{ \begin{array}{lcc}
-        #1 \\ #2 \\ #3 \end{array} \right. }    %}
+                #1 \\ #2 \\ #3\end{array} \right. }    %}
 
 \newcommand{\fourchoices}[4]{\left\{ \begin{array}{lcc}
-        #1 \\ #2 \\ #3 \\ #4 \end{array} \right. }      %}
+                #1 \\ #2 \\ #3 \\ #4\end{array} \right. }      %}
 
 \newcommand{\twovec}[2]{\left(\begin{array}{c} #1 \\ #2 \end{array}\right)}
 \newcommand{\threevec}[3]{\left(\begin{array}{c} #1 \\ #2 \\ #3 \end{array}\right)}