Initial Overleaf Import
This commit is contained in:
Joost van den Born committed
commit
dcf2889aa1
9 files changed
+653
No files matched your search
Binary file not shown.
@@ -0,0 +1,208 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% MICADO housestyle template %
|
||||
% For technical notes, memos and reviews %
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% CHANGES %
|
||||
% -Adapted from gitlab.astro-wise.org %
|
||||
% -Updated to use Helvetica font %
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% Document preamble, adds useful packages and sets up the document.
|
||||
% The micado-housestyle, based on the dmd-doc.sty file, accepts several arguments:
|
||||
% technote - removes title page, change record page and table of contents page.
|
||||
% review - Version ready for review
|
||||
% draft - Adds warning to title page that the document concerns a draft version.
|
||||
|
||||
\documentclass[twoside,11pt,a4paper]{article}
|
||||
\input{template_files/layout}
|
||||
\usepackage[technote]{template_files/housestyle-micado} % Place argument within brackets
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% General Document information
|
||||
|
||||
\dmdTitle{Document title} % Document title
|
||||
\dmdDocId{XXX-XXX-XXX-XXXXX-XXXX} % Document number
|
||||
\dmdIssue{0.2} % Version number
|
||||
\dmdDate{\today} % Date
|
||||
\dmdPreparedBy{Author Name} % Author(s)
|
||||
\dmdPreparedOn{\today} % Date to appear on the document?
|
||||
\dmdPreparedSig{} % Who is submitting the document?
|
||||
\dmdApprovedBy{} % Who approved the document?
|
||||
\dmdApprovedOn{} % When is the document approved?
|
||||
\dmdApprovedSig{} % Signature of the person approving the document
|
||||
\dmdReleasedBy{} % Who releases the document?
|
||||
\dmdReleasedOn{} % When is the document being released?
|
||||
\dmdReleasedSig{} % Signature of the person releasing the document
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
|
||||
|
||||
\begin{document}
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% Title page
|
||||
\dmdmaketitle % Generates a title page (if necessary) with the provided info
|
||||
% For a full document, the table of contents and change record is printed.
|
||||
% For a technical note, this is omitted
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% The MICADO documentation typically contain the following sections:
|
||||
% - Scope
|
||||
% - References (incl. applicable documents, reference documents and acronyms)
|
||||
% - Sections with content (introduction, other sections, conclusion).
|
||||
% - If applicable: Appendices
|
||||
|
||||
\section{Scope}
|
||||
% Similar to an abstract. States the reason for writing the document, and what the
|
||||
% document content should achieve.
|
||||
\blindtext % Prints some filler text.
|
||||
|
||||
|
||||
|
||||
\section{References}
|
||||
% Use the bibliography (.bib) files to fill in applicable documents and/or reference
|
||||
% documents. All bibliographic items in the applicable documents file
|
||||
% (ApplicableDocuments.bib) will be printed automatically.
|
||||
% For reference documents, only those documents that are cited in the text are printed.
|
||||
\subsection{Applicable Documents}\label{sec:AD}
|
||||
The following \ac{AD} of the exact issue contain provisions (statements, instructions, recommendations or requirements) that are ruling over - and implicate provisions in the present document.
|
||||
|
||||
\nocite{*} % This nocite is necessary for printing all applicable documents!
|
||||
\begin{refcontext}[labelprefix=AD]
|
||||
\printbibliography[heading=none, notkeyword={RD}]
|
||||
\end{refcontext}
|
||||
|
||||
\subsection{Reference Documents}\label{sec:RD}
|
||||
The following \ac{RD} contains useful information relevant to the subject of the present document.
|
||||
\begin{refcontext}[labelprefix=RD]
|
||||
\printbibliography[heading=none, keyword={RD}]
|
||||
\end{refcontext}
|
||||
|
||||
\subsection*{Acronyms}
|
||||
% A list of Acronyms is often useful to go back to the meaning of an acronym.
|
||||
% Acronyms used in the text with \ac{}, \acs{}, \acl{} or anything similar
|
||||
% will be printed automatically in the following list. If you want all
|
||||
% acronyms to be printed, check under OTHER in template_files/layout.tex and
|
||||
% set \usepackage[printonlyused]{acronym} to \usepackage[]{acronym}
|
||||
|
||||
\input{template_files/acronyms.tex}
|
||||
\pagebreak
|
||||
|
||||
|
||||
% Start of document contents
|
||||
\section{Introduction}
|
||||
\blindtext
|
||||
|
||||
\subsection{A subsection with references}
|
||||
There is no reference to AD1, but there is a reference to \cite{old-stuff}. Nonetheless, both get printed in Section~\ref{sec:AD}!
|
||||
|
||||
This is a reference to a Reference Document: \cite{MICADO-operational_concept}. Only reference documents that are cited in the text are printed in Section~\ref{sec:RD}.
|
||||
|
||||
\acs{PSF} is shorthand for \acl{PSF}. A quick way to say the same, would have been to write: \ac{PSF}.
|
||||
|
||||
\section{A section with a table, figures and an equation}
|
||||
\begin{figure}
|
||||
\centering
|
||||
\includegraphics[width=0.7\textwidth]{ELT-MICADO_paraxial.pdf}
|
||||
\caption{A paraxial model that we use to model the ELT-MICADO system.}
|
||||
\label{fig:paraxial}
|
||||
\end{figure}
|
||||
|
||||
\begin{table}
|
||||
\centering
|
||||
\caption{The system model constants as used in the analyses. Since the three smaller wheels are identical, these generally have the same values for the constants.}
|
||||
\begin{tabular}{llSll}
|
||||
\toprule
|
||||
Type & Constant & \multicolumn{1}{c}{Value} & Unit & Note \\ \midrule
|
||||
Friction & $B_1$ & 0.05 & Nm s deg$^{-1}$ & Complete guess \\
|
||||
& $B_2$ & 0 & Nm s deg$^{-1}$ & By design (?) \\
|
||||
& $B_3$ & 0.05 & Nm s deg$^{-1}$ & Complete guess \\
|
||||
& $B_4$ & 0.05 & Nm s deg$^{-1}$ & Complete guess \\
|
||||
Mass & $m_1$ & 0.033 & kg & From technical drawing \\
|
||||
& $m_2$ & 5.0 & kg & From ADC prototype design\\
|
||||
& $m_3$ & 0.033 & kg & From technical drawing \\
|
||||
& $m_4$ & 0.033 & kg & From technical drawing \\
|
||||
Radius & $r_1$ & 0.016 & m & From technical drawing \\
|
||||
& $r_2$ & 0.101 & m & Derived from $r_1$ and gear ratio. \\
|
||||
& $r_3$ & 0.016 & m & From technical drawing \\
|
||||
& $r_4$ & 0.016 & m & From technical drawing \\
|
||||
Spring constant & $K$ & 0.924 & Nm deg$^{-1}$ & Torsional stiffness of axial coupling\\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\label{table:constants}
|
||||
\end{table}
|
||||
Table~\ref{table:constants} shows the constants and values used in a model. Figure~\ref{fig:paraxial} is interesting, but Figs.~\ref{fig:small_fig1} and \ref{fig:small_fig2} are the same!
|
||||
|
||||
We could also discuss some equations. Look at eq.~\eqref{eq:einstein}, for example.
|
||||
\begin{equation}
|
||||
E = mc^2 \label{eq:einstein}
|
||||
\end{equation}
|
||||
|
||||
\blindtext
|
||||
|
||||
\begin{figure}
|
||||
\centering
|
||||
\begin{minipage}[t]{.47\textwidth}
|
||||
\centering
|
||||
\captionsetup{width=0.95\linewidth}
|
||||
\includegraphics[width=0.6\linewidth]{template_files/Micado_logo.png}
|
||||
\captionof{figure}{Here's one image of the MICADO logo}
|
||||
\label{fig:small_fig1}
|
||||
\end{minipage}%
|
||||
\hfill
|
||||
\begin{minipage}[t]{.47\textwidth}
|
||||
\centering
|
||||
\captionsetup{width=0.95\linewidth}
|
||||
\includegraphics[width=0.6\linewidth]{template_files/Micado_logo.png}
|
||||
\captionof{figure}{Here's another copy of the MICADO logo}
|
||||
\label{fig:small_fig2}
|
||||
\end{minipage}%
|
||||
\end{figure}
|
||||
|
||||
\phantom{Invisible text!}
|
||||
|
||||
|
||||
\newpage
|
||||
\section*{Appendices}
|
||||
\appendix
|
||||
|
||||
\section{Some very useful code}
|
||||
You could place some code that you used in the Appendix.
|
||||
|
||||
\begin{lstlisting}[language=Python]
|
||||
import numpy as np
|
||||
import astropy.units as u
|
||||
from scopesim import UserCommands, OpticalTrain
|
||||
from scopesim_templates.basic.stars import stars
|
||||
|
||||
stars = stars( filter_name="Ks",
|
||||
amplitudes=np.linspace(18, 23, 6)*u.mag,
|
||||
spec_types=["A0V", "G2V", "K0III"]*2,
|
||||
x=np.linspace(-1, 1, 6),
|
||||
y=[0]*6)
|
||||
|
||||
cmds = UserCommands(use_instrument="MICADO_Sci",
|
||||
set_modes=["SCAO", "SPEC"],
|
||||
properties={"!OBS.dit": 3600,
|
||||
"!SIM.spectral.wave_mid": 1.578,
|
||||
"!SIM.spectral.spectral_resolution": 0.00001,
|
||||
"!DET.height": 2048,
|
||||
"!DET.width": 800})
|
||||
|
||||
micado_spec = OpticalTrain(cmds)
|
||||
micado_spec.observe(stars)
|
||||
micado_spec.readout(filename="basic_spectral_trace.fits")
|
||||
\end{lstlisting}
|
||||
|
||||
|
||||
|
||||
|
||||
\vspace{4cm}
|
||||
\centering \textbf{End of Document}
|
||||
\end{document}
|
||||
@@ -0,0 +1,20 @@
|
||||
%%%%% APPLICABLE DOCUMENTS
|
||||
|
||||
@Manual{611,
|
||||
title = {Dataflow for ESO Observatories Deliverables Standard},
|
||||
version = 4,
|
||||
number = {ESO-037611},
|
||||
keywords = {applicable},
|
||||
note = {2020-03-02},
|
||||
organization = {ESO}
|
||||
}
|
||||
|
||||
@book{old-stuff,
|
||||
author = {Harvey, Jr., Dennis E.},
|
||||
booktitle = {Penguin Land and Further North: Human Influence},
|
||||
title = {Penguin Land and Further North: Human Influence},
|
||||
publisher = {Someone \& Daughters},
|
||||
year = 1567,
|
||||
address = {Oxford},
|
||||
bookpagination = {paragraph},
|
||||
keywords = {penguin}}
|
||||
@@ -0,0 +1,9 @@
|
||||
%%%% REFERENCE DOCUMENTS
|
||||
|
||||
|
||||
@Manual{MICADO-operational_concept,
|
||||
title = {MICADO Operational Concept Description},
|
||||
version = {2-0},
|
||||
number = {ELT-PLA-MCD-56301-0004},
|
||||
keywords = {reference},
|
||||
note = {2018-03-09}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
@@ -0,0 +1,52 @@
|
||||
This document employs several abbreviations and acronyms to refer concisely to an item, after it has been introduced. The following list is aimed to help the reader in recalling the extended meaning of each short expression:
|
||||
|
||||
\begin{acronym}[AAAAAA]
|
||||
\acro{AD}{Applicable Documents}
|
||||
\acro{ADC}{Atmospheric Dispersion Corrector}
|
||||
\acro{A-IMA}{Astrometric Imaging}
|
||||
\acro{AO}{Adaptive Optics}
|
||||
\acro{AWG}{Astrometry Working Group}
|
||||
\acro{CAM}{Cold Astrometric Mask}
|
||||
\acro{CDS}{Correlated Double Sampling}
|
||||
\acro{C-IMA}{Coronagraphic Imaging}
|
||||
\acro{CWM}{Central Wheel Mechanism}
|
||||
\acro{CPL}{Common Pipeline Library}
|
||||
\acro{DIT}{Detector Integration Time}
|
||||
\acro{DFS}{Data Flow Subsystem}
|
||||
\acro{DM}{Deformable Mirror}
|
||||
\acro{DPS}{Data Processing Subsystem}
|
||||
\acro{DRLS}{Data Reduction Library Specification document}
|
||||
\acro{DRS}{Data Reduction System}
|
||||
\acro{ELT}{Extremely Large Telescope}
|
||||
\acro{ESO}{European Southern Observatory}
|
||||
\acro{FDR}{Final Design Review}
|
||||
\acro{FITS}{Flexible Image Transport System}
|
||||
\acro{GD}{Green Donut}
|
||||
\acro{HCI}{High Contrast Imaging}
|
||||
\acro{HDRL}{High-level Data Reduction Library}
|
||||
\acro{ICS}{Instrument Control System}
|
||||
\acro{MAIT}{Manufacture, Assembly, Integration, Test}
|
||||
\acro{MAORY}{Multi-conjugate Adaptive Optics RelaY for the ELT}
|
||||
\acro{MCAO}{Multi Conjugate Adaptive Optics}
|
||||
\acro{MCD}{MICADO}
|
||||
\acro{MICADO}{Multi-AO Imaging CamerA for Deep Observations}
|
||||
\acro{MSM}{Mode Switching Mechanism}
|
||||
\acro{NCPA}{Non Common Path Aberrations}
|
||||
\acro{PDR}{Preliminary Design Review}
|
||||
\acro{PreCADO}{Observations Preparation Software System}
|
||||
\acro{PSF}{Point Spread Function}
|
||||
\acro{PSF-R}{PSF Reconstruction}
|
||||
\acro{RD}{Reference Documents}
|
||||
\acro{RRR}{Read-Reset-Read}
|
||||
\acro{SCAO}{Single Conjugate Adaptive Optics}
|
||||
\acro{SED}{Spectral Energy Distribution}
|
||||
\acro{S-IMA}{Standard Imaging}
|
||||
\acro{SimCADO}{Instrument Data Simulator for MICADO}
|
||||
\acro{SPE}{Spectroscopy}
|
||||
\acro{TBC}{To Be Confirmed}
|
||||
\acro{TBD}{To Be Defined}
|
||||
\acro{TBW}{To Be Written}
|
||||
\acro{TLI}{Threshold Limited Integration}
|
||||
\acro{WAM}{Warm Astrometric Mask}
|
||||
\acro{WFS}{Wave Front Sensing}
|
||||
\end{acronym}
|
||||
@@ -0,0 +1,19 @@
|
||||
\begin{center}
|
||||
\textbf{Change record}\vspace{0.5cm}
|
||||
|
||||
% \tablehead{\hline
|
||||
% \multicolumn{1}{|c|}{Issue/Rev.} &
|
||||
% \multicolumn{1}{|c|}{Date} &
|
||||
% \multicolumn{1}{|c|}{Section/Parag.\ affected} &
|
||||
% \multicolumn{1}{|c|}{Reason/Initiation/Documents/Remarks} \\
|
||||
% \hline}
|
||||
% \tabletail{\hline}
|
||||
\setlength\LTleft{0pt}
|
||||
\setlength\LTright{0pt}
|
||||
\begin{longtable}{@{\extracolsep{\fill}}|c|c|c|c|@{}}
|
||||
\hline Issue/Rev. & Date & Affected Section & Reason/Initiation/Documents/Remarks\endhead
|
||||
\hline
|
||||
0.1 & 20/02/2021 & All & Initial document \\
|
||||
\hline
|
||||
\end{longtable}
|
||||
\end{center}
|
||||
@@ -0,0 +1,236 @@
|
||||
%%%
|
||||
%%% DMD - LaTeX Document Style v0.2, 2002
|
||||
%%%
|
||||
\RequirePackage{epsfig}
|
||||
\RequirePackage{fancyhdr}
|
||||
\RequirePackage{lastpage}
|
||||
\RequirePackage{mathptmx}
|
||||
\RequirePackage{array}
|
||||
\RequirePackage{multirow}
|
||||
|
||||
\newif\if@dmddraft
|
||||
\newif\if@dmdreview
|
||||
\newif\if@dmdexternal
|
||||
\newif\if@openright
|
||||
\newif\if@technote
|
||||
|
||||
|
||||
\DeclareOption{draft}{\@dmddrafttrue}
|
||||
\DeclareOption{review}{\@dmdreviewtrue}
|
||||
\DeclareOption{external}{\@dmdexternaltrue}
|
||||
\DeclareOption{openright}{\@openrighttrue}
|
||||
\DeclareOption{openany}{\@openrightfalse}
|
||||
\DeclareOption{technote}{\@technotetrue}
|
||||
\ProcessOptions
|
||||
|
||||
\newlength\LogoWidth
|
||||
\newlength\LogoHeight
|
||||
\newlength\VLTheadWidth
|
||||
|
||||
\setlength{\LogoHeight}{2.25cm}
|
||||
\setlength{\LogoWidth}{0.8\LogoHeight}
|
||||
\setlength{\VLTheadWidth}{\linewidth minus \LogoWidth}
|
||||
% \setlength{\topmargin}{-2.5cm}
|
||||
% \setlength{\textheight}{21.8cm}
|
||||
% \setlength{\textwidth}{17.1cm}
|
||||
\setlength{\headwidth}{\textwidth}
|
||||
\setlength{\headheight}{2.75cm}
|
||||
|
||||
% \setlength{\oddsidemargin}{-3.0mm}
|
||||
% \setlength{\evensidemargin}{-3.0mm}
|
||||
% \setlength{\marginparwidth}{1.4cm}
|
||||
% \setlength{\marginparsep}{1.0mm}
|
||||
|
||||
|
||||
% \setlength{\parindent}{0pt}
|
||||
% \setlength{\parskip}{1.5ex plus 0.1ex minus 0.1ex}
|
||||
|
||||
\def\@dmdPreparedBy{}
|
||||
\def\@dmdPreparedOn{}
|
||||
\def\@dmdPreparedSig{}
|
||||
\def\@dmdApprovedBy{}
|
||||
\def\@dmdApprovedOn{}
|
||||
\def\@dmdApprovedSig{}
|
||||
\def\@dmdReleasedBy{}
|
||||
\def\@dmdReleasedOn{}
|
||||
\def\@dmdReleasedSig{}
|
||||
|
||||
|
||||
\def\dmdTitle#1{\gdef\@dmdTitle{#1}}
|
||||
\def\dmdDocId#1{\gdef\@dmdDocId{#1}}
|
||||
\def\dmdIssue#1{\gdef\@dmdIssue{#1}}
|
||||
\def\dmdDate#1{\gdef\@dmdDate{ #1}}
|
||||
\def\dmdPreparedBy#1{\gdef\@dmdPreparedBy{\texttt{#1}}}
|
||||
\def\dmdApprovedBy#1{\gdef\@dmdApprovedBy{\texttt{#1}}}
|
||||
\def\dmdReleasedBy#1{\gdef\@dmdReleasedBy{\texttt{#1}}}
|
||||
\def\dmdPreparedOn#1{\gdef\@dmdPreparedOn{\texttt{#1}}}
|
||||
\def\dmdApprovedOn#1{\gdef\@dmdApprovedOn{\texttt{#1}}}
|
||||
\def\dmdReleasedOn#1{\gdef\@dmdReleasedOn{\texttt{#1}}}
|
||||
\def\dmdPreparedSig#1{\gdef\@dmdPreparedSig{#1}}
|
||||
\def\dmdApprovedSig#1{\gdef\@dmdApprovedSig{#1}}
|
||||
\def\dmdReleasedSig#1{\gdef\@dmdReleasedSig{#1}}
|
||||
|
||||
\fancyhead{}
|
||||
\fancyfoot[C]{MICADO Consortium}
|
||||
\fancyhead[C]{%
|
||||
\setlength{\tabcolsep}{0.125cm}
|
||||
% \begin{tabular}{|p{2.cm}|p{8.1cm}|p{1cm}p{5.0cm}|}
|
||||
\begin{tabular}{|p{2.cm}|p{7cm}|p{1cm}p{5.0cm}|}
|
||||
\hline
|
||||
\multirow{4}{1.5cm}{%
|
||||
% \parbox[c]{2cm}{\centering \includegraphics[width=1.5cm]{template_files/Micado_logo.png}}
|
||||
\parbox[c][][c]{2cm}{\centering \vspace{0.5cm} MICADO\\Consortium}
|
||||
} &
|
||||
\multirow{4}{7cm}{%
|
||||
\centering{\large \@dmdTitle}
|
||||
} & \small Doc:\rule[1ex]{0pt}{1.1ex} &
|
||||
\hspace*{\fill}\small \@dmdDocId \\ %\cline{3-4}
|
||||
& & \small Issue:\rule[1ex]{0pt}{1.1ex} &
|
||||
\hspace*{\fill}\small \@dmdIssue \\ %\cline{3-4}
|
||||
& & \small Date:\rule[1ex]{0pt}{1.1ex} &
|
||||
\hspace*{\fill}\small \@dmdDate \\ %\cline{3-4}
|
||||
& & \small Page: \rule[1ex]{0pt}{1.1ex} &
|
||||
\hspace*{\fill}\small \thepage\ of \pageref{LastPage}\\
|
||||
\hline
|
||||
\end{tabular}
|
||||
}
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
\renewcommand{\footrulewidth}{1pt}
|
||||
\pagestyle{fancy}
|
||||
|
||||
\newcommand{\MIChead}{%
|
||||
\vspace*{-\headheight}
|
||||
\vspace*{-\headsep}
|
||||
\vspace*{-\topskip}
|
||||
\begin{center}
|
||||
\resizebox{1.32in}{1.64in}{\includegraphics{template_files/Micado_logo.png}}\\
|
||||
\vspace{0.5in}
|
||||
{\Huge ELT -- MICADO}\\[7ex]
|
||||
{\Large Phase C}
|
||||
\end{center}
|
||||
}
|
||||
|
||||
\newcommand{\dmdsignature}{%
|
||||
\tabular{llllr}
|
||||
\rule{4.8em}{0pt} & \rule{4.5cm}{0pt} & \rule{1.7cm}{0pt} &
|
||||
\rule{3cm}{0pt} & \rule{0.7cm}{0pt} \\
|
||||
Prepared: & {\hspace*{0.5em}\@dmdPreparedBy} &
|
||||
{\hspace*{0.5em}\@dmdPreparedOn} &
|
||||
{\hspace*{0.5em}\@dmdPreparedSig} & \\[-1.7ex]
|
||||
& \multicolumn{4}{c}{\mbox{}\dotfill\mbox{}}\\[-1ex]
|
||||
& {\hspace*{0.5em}\small Name} &
|
||||
{\hspace*{0.5em}\small Date} &
|
||||
{\hspace*{0.5em}\small Signature} & \\[1cm]
|
||||
|
||||
Approved: & {\hspace*{0.5em}\@dmdApprovedBy} &
|
||||
{\hspace*{0.5em}\@dmdApprovedOn} &
|
||||
{\hspace*{0.5em}\@dmdApprovedSig} & \\[-1.7ex]
|
||||
& \multicolumn{4}{c}{\mbox{}\dotfill\mbox{}}\\[-1ex]
|
||||
& {\hspace*{0.5em}\small Name} &
|
||||
{\hspace*{0.5em}\small Date} &
|
||||
{\hspace*{0.5em}\small Signature} & \\[1cm]
|
||||
|
||||
Released: & {\hspace*{0.5em}\@dmdReleasedBy} &
|
||||
{\hspace*{0.5em}\@dmdReleasedOn} &
|
||||
{\hspace*{0.5em}\@dmdReleasedSig} & \\[-1.7ex]
|
||||
& \multicolumn{4}{c}{\mbox{}\dotfill\mbox{}}\\[-1ex]
|
||||
& {\hspace*{0.5em}\small Name} &
|
||||
{\hspace*{0.5em}\small Date} &
|
||||
{\hspace*{0.5em}\small Signature} & \\
|
||||
\endtabular}
|
||||
|
||||
% To generate one or multipple empty pages
|
||||
\newcommand{\emptypage}[1]{%
|
||||
\newpage
|
||||
\thispagestyle{empty}
|
||||
\vspace*{\fill}\par
|
||||
\begin{center}
|
||||
#1
|
||||
\end{center}
|
||||
\vspace*{\fill}
|
||||
\clearpage}
|
||||
|
||||
% Generate a title page, change record table and table of contents
|
||||
\newcommand{\dmdmaketitle}{%
|
||||
\begin{titlepage}
|
||||
\setlength{\topmargin}{-0.5cm}
|
||||
\setlength{\topsep}{0pt}
|
||||
|
||||
\setlength{\oddsidemargin}{-3.0mm}
|
||||
\setlength{\evensidemargin}{-3.0mm}
|
||||
\setlength{\marginparwidth}{1.4cm}
|
||||
\setlength{\marginparsep}{1.0mm}
|
||||
|
||||
\setlength{\parindent}{0pt}
|
||||
|
||||
\thispagestyle{empty}
|
||||
|
||||
\MIChead
|
||||
\vspace*{\fill}
|
||||
\begin{center}
|
||||
\mbox{%
|
||||
\picture(10,1)(0,0)
|
||||
\if@dmddraft
|
||||
\unitlength1cm
|
||||
\put(-5,0){\unitlength1pt\line(0,-1){6}}
|
||||
\put(-5,0){\unitlength1pt\line(1,0){6}}
|
||||
\put(5,0){\unitlength1pt\line(0,-1){6}}
|
||||
\put(5,0){\unitlength1pt\line(-1,0){6}}
|
||||
\fi
|
||||
\endpicture
|
||||
}
|
||||
\par
|
||||
\vskip0.25cm
|
||||
\parbox{9.5cm}{\begin{center}\textbf{\LARGE\@dmdTitle}\end{center}}\par
|
||||
\vspace{0.5cm}
|
||||
\normalsize
|
||||
\parbox{9.5cm}{\begin{center}\large\@dmdDocId\end{center}}\par
|
||||
\vspace{0.5cm}
|
||||
\parbox{9.5cm}{\begin{center}Issue: \@dmdIssue\end{center}}\par
|
||||
\parbox{9.5cm}{\begin{center}Date: \@dmdDate\end{center}}\par
|
||||
\mbox{%
|
||||
\picture(10,1)(0,0)
|
||||
\if@dmddraft
|
||||
\unitlength1cm
|
||||
\put(-5,0){\unitlength1pt\line(0,1){6}}
|
||||
\put(-5,0){\unitlength1pt\line(1,0){6}}
|
||||
\put(5,0){\unitlength1pt\line(0,1){6}}
|
||||
\put(5,0){\unitlength1pt\line(-1,0){6}}
|
||||
\fi
|
||||
\endpicture
|
||||
}
|
||||
\par
|
||||
\vspace*{\fill}
|
||||
\if@dmddraft
|
||||
\vskip0.75cm
|
||||
\textbf{\Large -- DRAFT -- }\par
|
||||
\vskip0.5cm
|
||||
\if@dmdreview
|
||||
\if@dmdexternal
|
||||
\textbf{\Large -- DISTRIBUTED FOR REVIEW ONLY --}\par
|
||||
\else
|
||||
\textbf{\Large -- DISTRIBUTED FOR INTERNAL REVIEW --}\par
|
||||
\fi
|
||||
\else
|
||||
\textbf{\Large -- DISTRIBUTED FOR INTERNAL USE ONLY --}\par
|
||||
\fi
|
||||
\vskip1.0cm
|
||||
\else
|
||||
\vskip3.5cm
|
||||
\fi
|
||||
\vspace*{\fill}
|
||||
\dmdsignature
|
||||
\end{center}
|
||||
\vspace*{1.5cm}
|
||||
\end{titlepage}
|
||||
\input{template_files/change-record}
|
||||
\newpage
|
||||
\tableofcontents
|
||||
\newpage
|
||||
}
|
||||
|
||||
% A technical note does not require a cover page
|
||||
\if@technote
|
||||
\renewcommand{\dmdmaketitle}{}
|
||||
% \input{template_files/change-record} % Why does it not take the proper font?!
|
||||
\fi
|
||||
@@ -0,0 +1,109 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%Document preamble, adds useful packages and sets up the document.
|
||||
|
||||
%FONT AND TYPESETTING
|
||||
\usepackage[english]{babel} % makes latex aware of your language, so better hyphenating etc
|
||||
\usepackage[T1]{fontenc} % use the T1 for proper searching and use of ligatures etc
|
||||
\usepackage[utf8]{inputenc} % use UTF8 encoding for reading source code
|
||||
\usepackage{helvet} % use the helvetica font. This is very similar to the Arial font
|
||||
% used in the Office templates.
|
||||
\usepackage{inconsolata} % use the inconsolata font for code as it looks nice.
|
||||
\renewcommand{\familydefault}{\sfdefault} % set the text font to helvetica
|
||||
\usepackage{microtype} % enables microtypesetting
|
||||
\usepackage{csquotes} % package for writing quotes. Used by 'babel'.
|
||||
|
||||
%PAGE LAYOUT
|
||||
\usepackage{geometry} % adjusts page layout including margins
|
||||
\geometry{left=2.5cm,right=2.5cm,top=2.5cm,bottom=5cm} % the page geometry as defined, A4=210x297mm
|
||||
|
||||
%MATHS
|
||||
\usepackage{mathtools} % for the rendering of maths, mathtools includes amsmath
|
||||
\numberwithin{equation}{section} % reset numbering within a structural object
|
||||
\numberwithin{figure}{section} % reset numbering within a structural object
|
||||
|
||||
%SCIENCE
|
||||
\usepackage{siunitx} % typesetting of units and quantities with uncertainties etc
|
||||
\sisetup{detect-all, detect-weight=true, detect-family=true} % if the rest of the text is bold the units will be as well
|
||||
\sisetup{range-units=single} % don't include units in both parts of an \SIrange
|
||||
\sisetup{multi-part-units=single} % don't repeat units for multi-part numbers such as numbers with uncertainties
|
||||
\sisetup{separate-uncertainty} % list values with uncertanties as X\pm Y rather than X(Y).
|
||||
|
||||
%FIGURES AND TABLES
|
||||
\usepackage[labelfont=bf]{caption} % adds bold labels, but normal captions for the figures and tables.
|
||||
\usepackage{graphicx} % for the rendering of floating graphics
|
||||
\usepackage{array} % for creating tables
|
||||
\usepackage{booktabs} % professional looking tables, provides /toprule etc
|
||||
\usepackage{longtable} % for creating tables that continue on the next page
|
||||
\usepackage{chngcntr} % for labeling tables such that the section number is included
|
||||
\counterwithin{table}{section} % change 'section' to 'subsection' or 'subsubsection' if desired.
|
||||
|
||||
% PROGRAMMING CODE
|
||||
\usepackage{listings} % for nicely rendering programming code
|
||||
\lstloadlanguages{csh, python}
|
||||
\usepackage{xcolor}
|
||||
\definecolor{codegreen}{rgb}{0,0.6,0}
|
||||
\definecolor{codegray}{rgb}{0.5,0.5,0.5}
|
||||
\definecolor{codepurple}{rgb}{0.58,0,0.82}
|
||||
\definecolor{backcolour}{rgb}{0.95,0.95,0.92}
|
||||
|
||||
% Defining the way code looks in the document
|
||||
\lstdefinestyle{mystyle}{
|
||||
backgroundcolor=\color{backcolour},
|
||||
commentstyle=\color{codegreen},
|
||||
keywordstyle=\color{magenta},
|
||||
numberstyle=\tiny\color{codegray},
|
||||
stringstyle=\color{codepurple},
|
||||
basicstyle=\ttfamily\footnotesize,
|
||||
breakatwhitespace=false,
|
||||
breaklines=true,
|
||||
captionpos=b,
|
||||
keepspaces=true,
|
||||
numbers=left,
|
||||
numbersep=5pt,
|
||||
showspaces=false,
|
||||
showstringspaces=false,
|
||||
showtabs=false,
|
||||
tabsize=2
|
||||
}
|
||||
\lstset{style=mystyle}
|
||||
|
||||
|
||||
%BIBLIOGRAPHY
|
||||
% relies on .bib files of the applicable documents and the reference documents to be in the right place.
|
||||
\usepackage[backend=biber,citestyle=numeric-comp,bibstyle=numeric,sorting=none,url=false,eprint=false,isbn=true,doi=true,defernumbers=true]{biblatex}
|
||||
\addbibresource{references/ApplicableDocuments.bib}
|
||||
\addbibresource{references/ReferenceDocuments.bib}
|
||||
|
||||
%Function that automatically adds keyword to all Reference Documents
|
||||
\DeclareSourcemap{
|
||||
\maps[datatype=bibtex]{
|
||||
\map[overwrite]{
|
||||
\perdatasource{references/ReferenceDocuments.bib}
|
||||
\step[fieldset=keywords, fieldvalue={,RD}, append]
|
||||
}
|
||||
}
|
||||
}
|
||||
% Function that enables applicable documents to appear without citation, using \nocite(*)
|
||||
\DeclareSourcemap{
|
||||
\maps[datatype=bibtex]{
|
||||
\map{
|
||||
\step[nocited, final]
|
||||
\step[fieldsource=keywords, notmatch={RD}, final]
|
||||
% \step[entrynull]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
% OTHER
|
||||
\usepackage{blindtext} %to print filler text
|
||||
\usepackage[printonlyused]{acronym} %for defining acronyms. Only acronyms used at least once will appear in the list.
|
||||
\usepackage{hyperref, bookmark} %turns the references and citations into hyperlinks. This needs to be last on the preamble.
|
||||
\hypersetup{colorlinks=true,linkcolor=black,citecolor=black,urlcolor=blue} %sets colors of links within the text.
|
||||
|
||||
%useful shorthands for common Astronomical Journals
|
||||
\newcommand{\aap}{Astronomy \& Astrophysics}
|
||||
\newcommand{\aaps}{Astronomy \& Astrophysics, Supplement}
|
||||
\newcommand{\mnras}{Monthly Notices of the Royal Astronomical Society}
|
||||
\newcommand{\procspie}{Proceedings of the International Society for Optical Engineering}
|
||||
\newcommand{\pasp}{Publications of the Astronomical Society of the Pacific}
|
||||
\newcommand{\apjs}{The Astrophysical Journal, Supplement}
|
||||
Reference in new issue
Block a user