uo-ethesis.tex

%======================================================================
% Type the following fields to automatically appear in the right places
%======================================================================
\newcommand{\thesisauthor}{Wail Gueaieb}
\newcommand{\thesistitlecoverpage}{University of Ottawa's Unofficial E-Thesis \LaTeX Template}
\newcommand{\thesisdegree}{Master of Applied Science} % possible values are:
                            % Master of Applied Science / Doctor of Philosophy
\newcommand{\nameofprogram}{Electrical and Computer Engineering}
\newcommand{\graduationyear}{2021}
%======================================================================




% --------------------- Start of Document Preamble -----------------------

% Specify the document class, default style attributes, and page dimensions
% For hyperlinked PDF, suitable for viewing on a computer, use this:
\documentclass[letterpaper,12pt,titlepage,oneside,final]{book}
% For PDF, suitable for double-sided printing, change the PrintVersion variable below
% to "true" and use this \documentclass line instead of the one above:
%\documentclass[letterpaper,12pt,titlepage,openright,twoside,final]{book}

% the following two packages are necessary for using T1 fonts
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
% \usepackage[latin1]{inputenc}
% Or whatever. Note that the encoding and the font should match. If T1
% does not look nice, try deleting the line with the fontenc. 


% Some LaTeX commands I define for my own nomenclature.
% If you have to, it's better to change nomenclature once here than in a 
% million places throughout your thesis!
\newcommand{\package}[1]{\textbf{#1}} % package names in bold text
\newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font 
\newcommand{\href}[1]{#1} % does nothing, but defines the command so the
    % print-optimized version will ignore \href tags (redefined by hyperref pkg).
%\newcommand{\texorpdfstring}[2]{#1} % does nothing, but defines the command
% Anything defined here may be redefined by packages added below...

% This package allows if-then-else control structures.
\usepackage{ifthen}
\newboolean{PrintVersion}
\setboolean{PrintVersion}{false} 
% CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies
% by overriding some options of the hyperref package below.


% Citation packages
\usepackage{cite}  % For better handling of numeric citations
% \usepackage[bibencoding=auto,style=numeric,sorting=nyt,backend=biber]{biblatex}  % to handle utf-8 encoding in bibliography
% \addbibresource{bibliography/thesis_lit_review_resources.bib}
%
\usepackage{bibentry} % Needed for inline bibliographic citation, such as in the "Scholarly Outcome" section
\nobibliography* % Tells bibentry to (re)use the bibliographic data from the standard BibTeX setup \bibliography{...}

% Math packages
\usepackage{amsmath,amssymb,amstext,amsfonts} % Lots of math symbols and environments
\usepackage{mathtools}
\usepackage{array}
\usepackage{siunitx}  % To type units
\sisetup{
  per-mode=symbol,
  input-symbols=\pi,
}
\usepackage{physics}  % Convenient for many mathematical notations
\usepackage{bm}
%
\usepackage{amsthm}  % to create theorem-like environments
\newtheorem{lemma}{Lemma}[chapter]
\newtheorem{theorem}{Theorem}[chapter]
\newtheorem{corollary}{Corollary}[chapter]
\newtheorem{definition}{Definition}[chapter]
\newtheorem{example}{Example}[chapter]
\newtheorem{proposition}{Proposition}[chapter]

% Graphic packages
\usepackage[pdftex]{graphicx} % For including graphics N.B. pdftex graphics driver
% To arrange subfigures within the same figure, it is
% recommended to use the package subcaption instead of
% packages subfig or subfigure, for example.
\usepackage{caption}
\usepackage[list=true,labelformat=simple]{subcaption}
\captionsetup[sub]{skip=2pt}
\renewcommand\thesubfigure{(\alph{subfigure})} % for reference like Figure 2(b)

\graphicspath{% figure paths
  {figures/Inkscape/}
  {Figures/Matlab/}
}

% tikz if needed
\usepackage{tikz}
\usetikzlibrary{positioning}
\tikzset{>=stealth}

% List packages
\usepackage{enumitem}

% Table packages
\usepackage{booktabs}  % Nice looking tables


% Algorithm packages
% It is recommended to use algorithmx, as done below, instead of
% using package algorithm2e, for instance.
\usepackage{algorithm,algpseudocode,float}
\usepackage{setspace}
\renewcommand{\algorithmicrequire}{\textbf{Input:}}
\renewcommand{\algorithmicensure}{\textbf{Output:}}
\algnewcommand{\algorithmicand}{\textbf{and }}
\algnewcommand{\algorithmicor}{\textbf{or }}
\algnewcommand{\algAnd}{\algorithmicand}
\algnewcommand{\algOr}{\algorithmicor}

\makeatletter
\@addtoreset{algorithm}{chapter}% algorithm counter resets every chapter
\makeatother
\renewcommand{\thealgorithm}{\arabic{chapter}.\arabic{algorithm}}



% Feedback notes
\usepackage{xargs} % Use more than one optional parameter in a new commands
\usepackage[colorinlistoftodos,prependcaption,textsize=tiny]{todonotes}
%\newcommand\setuptodonotes{tickmarkheight=1pt}
%
\newcommandx{\unsure}[2][1=]{\todo[linecolor=red,backgroundcolor=red!25,bordercolor=red,#1]{#2}}
\newcommandx{\change}[2][1=]{\todo[linecolor=blue,backgroundcolor=blue!25,bordercolor=blue,#1]{#2}}
\newcommandx{\info}[2][1=]{\todo[linecolor=OliveGreen,backgroundcolor=OliveGreen!25,bordercolor=OliveGreen,#1]{#2}}
\newcommandx{\improvement}[2][1=]{\todo[linecolor=Plum,backgroundcolor=Plum!25,bordercolor=Plum,#1]{#2}}
\newcommandx{\thiswillnotshow}[2][1=]{\todo[disable,#1]{#2}}




% sin added for subsubsections to show up
\setcounter{secnumdepth}{5}
\setcounter{tocdepth}{5}


%=== ADD MORE PACKAGES AS NEEDED. TYPICALLY, hyperref (INCLUDED BELOW)
%=== IS THE LAST PACKAGE TO BE LOADED 


%====================================================

% Hyperlinks make it very easy to navigate an electronic document.
% In addition, this is where you should specify the thesis title
% and author as they appear in the properties of the PDF document.
% Use the "hyperref" package 
% N.B. HYPERREF MUST BE THE LAST PACKAGE LOADED; ADD ADDITIONAL PKGS ABOVE
\usepackage[pdftex,pagebackref=false,pdfa]{hyperref} % with basic options
		% N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing.
\hypersetup{
    plainpages=false,       % needed if Roman numbers in frontpages
    unicode=false,          % non-Latin characters in Acrobat’s bookmarks
    pdftoolbar=true,        % show Acrobat’s toolbar?
    pdfmenubar=true,        % show Acrobat’s menu?
    pdffitwindow=false,     % window fit to page when opened
    pdfstartview={FitH},    % fits the width of the page to the window
    % pdftitle={Thesis Title},    % title: CHANGE THIS TEXT!
    % pdfauthor={Author's Name},    % author: CHANGE THIS TEXT! and uncomment this line
    % pdfsubject={Robotics},  % subject: CHANGE THIS TEXT! and uncomment this line
    % pdfkeywords={Robotics} {machine learning} {control systems}, % list of keywords, and uncomment this line if desired
    pdfnewwindow=true,      % links in new window
    colorlinks=true,        % false: boxed links; true: colored links
    linkcolor=blue,         % color of internal links
    citecolor=green,        % color of links to bibliography
    filecolor=magenta,      % color of file links
    urlcolor=cyan           % color of external links
}
\ifthenelse{\boolean{PrintVersion}}{   % for improved print quality, change some hyperref options
\hypersetup{	% override some previously defined hyperref options
%    colorlinks,%
    citecolor=black,%
    filecolor=black,%
    linkcolor=black,%
    urlcolor=black}
}{} % end of ifthenelse (no else)

\usepackage[noabbrev]{cleveref}  % automatically sort references

% Make document PDF-A compliant (for archiving and long-term preservation)
% https://ruor.uottawa.ca/submit-thesis.jsp
% https://webpages.tuni.fi/latex/pdfa-guide.pdf
\usepackage{colorprofiles}
\usepackage[a-3b,mathxmp]{pdfx}

\usepackage[automake,toc,abbreviations]{glossaries-extra} % Exception to the rule of hyperref being the last add-on package


% Setting up margins and other spaces 
\input{private/spaces} 


% By default, each chapter will start on a recto (right-hand side)
% page.  We also force each section of the front pages to start on 
% a recto page by inserting \cleardoublepage commands.
% In many cases, this will require that the verso page be
% blank and, while it should be counted, a page number should not be
% printed.  The following statements ensure a page number is not
% printed on an otherwise blank verso page.
\let\origdoublepage\cleardoublepage
\newcommand{\clearemptydoublepage}{%
  \clearpage{\pagestyle{empty}\origdoublepage}}
\let\cleardoublepage\clearemptydoublepage

% Define Glossary terms (This is properly done here, in the preamble. Could be \input{} from a file...)
\input{src/glossary} 
\makeglossaries

%======================================================================
%   L O G I C A L    D O C U M E N T -- the content of your thesis
%======================================================================
\begin{document}

% For a large document, it is a good idea to divide your thesis
% into several files, each one containing one chapter.
% To illustrate this idea, the "front pages" (i.e., title page,
% declaration, borrowers' page, abstract, acknowledgements,
% dedication, table of contents, list of tables, list of figures,
% nomenclature) are contained within the file "uo-ethesis-frontpgs.tex" which is
% included into the document by the following statement.
%----------------------------------------------------------------------
% FRONT MATERIAL
%----------------------------------------------------------------------
\input{private/uo-ethesis-frontpgs}

% Insert list of to do's if needed
% \listoftodos

%----------------------------------------------------------------------
% MAIN BODY
%----------------------------------------------------------------------
% Because this is a short document, and to reduce the number of files
% needed for this template, the chapters are not separate
% documents as suggested above, but you get the idea. If they were
% separate documents, they would each start with the \chapter command, i.e, 
% do not contain \documentclass or \begin{document} and \end{document} commands.
%======================================================================
\input{src/introduction}
\input{src/observations}
\input{src/recommendations} 


%----------------------------------------------------------------------
% END MATERIAL
%----------------------------------------------------------------------

% B I B L I O G R A P H Y
% -----------------------

% The following statement selects the style to use for references.  It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels.
\bibliographystyle{plain}
% This specifies the location of the file containing the bibliographic information.  
% It assumes you're using BibTeX (if not, why not?).
\cleardoublepage % This is needed if the book class is used, to place the anchor in the correct page,
                 % because the bibliography will start on its own page.
                 % Use \clearpage instead if the document class uses the "oneside" argument
\phantomsection  % With hyperref package, enables hyperlinking from the table of contents to bibliography             
% The following statement causes the title "References" to be used for the bibliography section:
\renewcommand*{\bibname}{References} 

% Add the References to the Table of Contents
\addcontentsline{toc}{chapter}{\textbf{References}}

% Commented below to include my own bib file
\bibliography{bibliography/uo-ethesis}
%\printbibliography



% The \appendix statement indicates the beginning of the appendices.
\appendix
% Add a title page before the appendices and a line in the Table of Contents
\chapter*{APPENDICES}
\addcontentsline{toc}{chapter}{APPENDICES}
% %======================================================================
\input{src/matlab-plots}

\end{document}