264 lines
11 KiB
TeX
264 lines
11 KiB
TeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% MICADO housestyle template %
|
|
% For technical notes, memos and reviews %
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% CHANGES %
|
|
% -Adapted from gitlab.astro-wise.org %
|
|
% -Updated to use Helvetica font %
|
|
% -Took inspiration from SRON document %
|
|
% template (https://personal.sron.nl/~pault/) %
|
|
% -Update to include references in tables %
|
|
% -Addition of a memo format %
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% Document preamble, adds useful packages and sets up the document.
|
|
% The micado document 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 and header that the document is a draft
|
|
% version.
|
|
% memo - minimal document. Removes the title page, change record table, table
|
|
% of contents, document number and issue number. It is up to the user
|
|
% to leave or remove other sections of the main document.
|
|
|
|
\documentclass[twoside,11pt,a4paper]{article}
|
|
\usepackage[memo]{micado} % micado.sty defines the layout of the document. Place
|
|
% argument within brackets
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% General Document information
|
|
\dmdTitle{MICADO Document Template} % Document title
|
|
\dmdDocId{XXX-XXX-XXX-XXXXX-XXXX} % Document number
|
|
\dmdIssue{1.2} % Version number
|
|
\dmdDate{18.05.2021} % Issue Date
|
|
\dmdPreparedBy{Author Name} % Author(s)
|
|
\dmdPreparedOn{\today} % Date that document was signed
|
|
|
|
% Change record
|
|
\dmdChangeRecord{ % Change record table. Fill as a four column table.
|
|
1.0 & 09/03/2021 & All & Initial document \\
|
|
1.1 & 22/04/2021 & 2 & Update to place references in tabular environment.\\
|
|
1.2 & 18/05/2021 & Style file & Addition of a memo template format.\\
|
|
}
|
|
|
|
% Only for (draft)review
|
|
\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
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% Definition required to get references in tables
|
|
% A future update of TeX Live (more specifically, v.0.12b of biblatex-ext-tabular) will
|
|
% allow the definition of bibtabular to be moved to the micado.sty file. For now, it is
|
|
% necessary to have it in the main .tex file.
|
|
\makeatletter
|
|
\def\fixextblx@setrefcontext{%
|
|
\expandafter\blx@setdefaultrefcontext\expandafter{\abx@field@entrykey}}
|
|
|
|
% Defines the function that prints references in a table
|
|
\defbibtabular{bibtabular}{
|
|
\begin{center}
|
|
% \setlength\LTleft{10pt}
|
|
% \setlength\LTright{0pt}
|
|
\begin{longtable}{@{\extracolsep{\fill}}|c|p{0.3\linewidth}|p{0.3\linewidth}|c|c|@{}}
|
|
\hline \textbf{RD Nr} & \textbf{Document Number} & \textbf{Document Title} & \textbf{Issue} & \textbf{Date}\endhead
|
|
\hline
|
|
}
|
|
{
|
|
\hline
|
|
\end{longtable}
|
|
\end{center}}{
|
|
\anchorlang{%
|
|
\fixextblx@setrefcontext
|
|
\printtext[labelnumberwidth]{%
|
|
\printfield{labelprefix}%
|
|
\printfield{labelnumber}}}
|
|
& \plainlang{\printfield{label}}
|
|
& \plainlang{\usebibmacro{title}} \plainlang{\usebibmacro{author}}
|
|
& \plainlang{\printfield{issue}}
|
|
& \plainlang{\printdate}\\ \hline}
|
|
\makeatother
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\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, only the change record table is printed.
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
|
|
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% 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}
|
|
\defbibnote{ADnote}{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!
|
|
\newrefcontext[labelprefix=AD]
|
|
\printbibtabular[prenote=ADnote, heading=none, notkeyword={RD}]
|
|
|
|
\subsection{Reference Documents}\label{sec:RD}
|
|
\defbibnote{RDnote}{The following \ac{RD} contains useful information relevant to the subject of the present document.}
|
|
\newrefcontext[labelprefix=RD]
|
|
\printbibtabular[prenote=RDnote, heading=none, keyword={RD}]
|
|
|
|
\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}. Note
|
|
% that this might raise a lot of warnings, but does work (on overleaf).
|
|
\input{acronyms}
|
|
\newpage
|
|
|
|
|
|
% 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, MICADO_template, Matsushima2003}. Only reference documents that are cited in the text are printed in Section~\ref{sec:RD}.
|
|
|
|
The \ac{MICADO} is an upcoming instrument for the \ac{ELT}. \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]{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]{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}
|