template: sohpc-template.tex

File sohpc-template.tex, 17.7 KB (added by leon, 9 years ago)

LaTeX template

Line 
1\documentclass[a4paper, twoside]{article}
2\usepackage[margin=12mm, bottom=0.75in, verbose]{geometry}
3\usepackage{graphicx}
4\usepackage{here, multicol, fancyhdr}
5\usepackage{charter, courier}
6\usepackage[OT1,T1]{fontenc} %use TeX encoding then Type 1.
7\usepackage[protrusion=true, expansion=true]{microtype} % Better typography
8\usepackage[english]{babel} % English language/hyphenation
9\usepackage{amsmath,amsfonts,amsthm} % Math packages
10\usepackage{lettrine} % dropped capital letter
11\usepackage{booktabs} % Horizontal rules in tables
12\usepackage[small, labelfont=bf, up, textfont=up]{caption}
13\usepackage[rgb]{xcolor} % Should be CMYK if supported by the system
14\definecolor{prace-orange}{rgb}{1.0,0.42, 0.1} % 255, 107, 25
15% Colours by PRACE graphics guidelines
16%\definecolor{prace-darkblue}{rgb}{0.1, 0.19, 0.48} % 25, 49, 123
17%\definecolor{prace-lightblue}{rgb}{0.52, 0.81, 0.94} %132, 206, 239
18% Colours by SoHPC logo pipette measurements
19\definecolor{prace-darkblue}{rgb}{0.08, 0.31, 0.58} % #155195 = 21,81,149
20\definecolor{prace-lightblue}{rgb}{0.32, 0.73, 0.93} % #51bbed = 81,187,237
21\newcommand{\highlight}[1]{\textcolor{prace-orange}{#1}}
22\definecolor{link}{rgb}{0.1, 0.19, 0.48} 
23\usepackage{sectsty} % Enables custom section titles
24\allsectionsfont{\large\color{prace-orange}\usefont{OT1}{phv}{m}{n}}
25\usepackage[superscript,biblabel]{cite}
26\usepackage{calc,float,wrapfig}\restylefloat{figure}
27\usepackage{lipsum} % Used for inserting dummy 'Lorem ipsum'
28
29\usepackage[colorlinks=true, linkcolor=link, anchorcolor=link,citecolor=link,
30filecolor=link, menucolor=link,urlcolor=prace-darkblue]{hyperref}
31
32%To automatically convert Inkscape SVG into PDF or EPS use:
33% pdflatex -synctex=1  --enable-write1 sohpc-template.tex
34\newcommand{\includegraphicsvg}[2][]{%
35  \ifnum\pdfstrcmp{\pdffilemoddate{./#2.svg}}%
36  {\pdffilemoddate{../gen/#2.pdf}}>0%
37  {\immediate\write18{inkscape -z -D --file=./#2.svg %
38      --export-pdf=#2.pdf --export-eps=#2.eps %
39      --export-area-drawing}}\fi%
40  \includegraphics[#1]{#2}%
41}
42
43% http://tex.stackexchange.com/questions/59166/span-column-in-a-multicols-environment
44\newcounter{tempcolnum}
45\makeatletter
46\newcommand{\multicolinterrupt}[1]{% Stuff to span rows
47\setcounter{tempcolnum}{\col@number}
48\end{multicols}
49#1%
50\begin{multicols}{\value{tempcolnum}}
51}
52\makeatother
53
54\hyphenation{SoHPC AntiSpam} % do not hyphenate
55
56\usepackage{titling}
57
58\pretitle{\vspace{-30pt} \begin{flushleft}
59    \usefont{OT1}{phv}{m}{n}\selectfont\large}
60
61\title{Long Title Describing Short Title can Consist of
62    up to 3 lines} % Your article title
63
64\posttitle{\par\end{flushleft}\vskip 0.5ex}
65
66\renewcommand{\maketitlehookb}{\par\noindent\flushleft%
67\fontsize{45}{50}\usefont{OT1}{phv}{m}{n}\selectfont%
68\highlight{Short Title} for SoHPC} 
69
70\preauthor{\vskip 0.9ex \begin{flushleft}\large
71    \usefont{OT1}{phv}{b}{sl} \color{prace-orange}}
72
73\author{Leon Kos} % Name and surname
74
75\postauthor{\par\end{flushleft}}
76
77\predate{}\date{}\postdate{\vspace{-50pt}}
78\pagestyle{empty}
79% Do not enable page numbering below as it will be inserted by the publication
80%\pagestyle{fancy}\fancyhf{}\renewcommand{\headrulewidth}{0pt}\renewcommand{\footrulewidth}{0pt}\fancyfoot[C]{\colorbox{orange}{\raisebox{0mm}[4mm][7mm]{\textcolor{white}{\usefont{OT1}{phv}{m}{n}\selectfont~\thepage~}}}}
81
82\begin{document}
83\noindent
84\begin{minipage}{0.44\linewidth}
85  \maketitle
86  \thispagestyle{empty}
87  \fontsize{14pt}{20pt}\usefont{OT1}{phv}{m}{n}\selectfont
88  \raggedright
89  Describe motivation of the project and main results in an abstract like  manner. The size of this description should not be large. Several lines  will do the job of attracting readers. It can state some highlights of the project.
90\end{minipage}\hfill
91\begin{minipage}{0.5\textwidth}
92  \includegraphics[width=\linewidth]{sohpc-logo}
93  %\includegraphicsvg[width=\linewidth]{sohpc-logo}
94\end{minipage}
95\vskip 30pt
96\frenchspacing
97
98\begin{multicols}{3}
99
100\lettrine[lines=4,nindent=0em]{\highlight{T}}{}his template is used for
101PRACE Summer of HPC project newsletter report in popular science format that should be 2-3 pages long with graphics. The target audience is an educated adult, without scientific education in the field of the project. The report should contain a title, abstract, references and acknowledgements.
102% http://ctan.ijs.si/tex-archive/macros/latex/contrib/wrapfig/multiple-span.txt
103\vspace{13\baselineskip} % we enforce space here for figure in right column
104The report should cover an introduction, methods, results and conclusions but does not have to contain these as section headings. Tone should be more informal than a journal article. Your enthusiasm should show. You can use your blog posts as a basis for this report.
105
106Graphics should be your own. Short title should be just few words. Highlight word or two to give some separation within the short title. Long name preceding short title is not necessarily the title of your project as facts about the projects, mentors and the author(s) are given at the end. Usually in magazines no two articles are the same in terms of formatting. You are free to do figure positioning and column spans. Bear in mind that with multiple columns spanning in \LaTeX is non-trivial.
107\begin{wrapfigure}[13]{l}[\columnwidth+\columnsep]{1.3\columnwidth}
108  \color{yellow}\rule{\linewidth}{3cm}\color{black}
109  %\includegraphics[width=\linewidth]{fig1}
110  \caption{Use \href{http://www.ctan.org/pkg/wrapfig}{WrapFig} only if you are wrapping a text around the figure that flows on more that one column. See \href{http://ctan.ijs.si/tex-archive/macros/latex/contrib/wrapfig/multiple-span.txt}{instructions} on how to find breaking point on each column. Note that captions are not preferred.}
111  \label{fig:myfig1}
112\end{wrapfigure}
113\noindent Example nearby shows how can wrapfig be used for spanning into two columns. Don't be afraid of large screenshots. To get an idea on the style take a look into PRACE digest, newsletter and other popular scientific texts available on Internet. Google for \highlight{writing popular scientific}. For example: \url{http://awelu.srv.lu.se/genres-and-text-types/writing-in-academic-genres/popular-science-writing/}
114
115\section*{Paper format}
116We use A4 paper size with 10pt Charter or Georgia font. Text at the end and captions should be 9pt. Short title Helvetica (Arial) medium or light 45pt with 50pt spacing. Long title and Abstract 12pt. Margins should be 12mm everywhere except ob the bottom where 0.75 inch is reserved for page number. Other important dimensions:
117\begin{description}
118  \item[column separation]  \the\columnsep
119  \item[column width] \the\columnwidth
120  \item[textwidth] \the\textwidth
121\end{description}
122For compiling \LaTeX it is recommended (if having troubles) to use latest \TeX live distribution. Use pdf\LaTeX instead of classical \LaTeX as it outputs PDF directly, wraps URLs correctly and can include PNG files directly. Do not use JPEG for screenshots! JPEG is for photos only. For sketching use \href{http://www.inkscape.org}{Inkscape}.
123
124\section*{General guidelines}
125\newcommand{\itempar}[1]{\noindent\highlight{\textsf #1}\par\noindent}
126\begin{itemize}
127  \setlength{\itemsep}{0pt plus 3pt}\setlength{\topsep}{0pt plus 4pt}
128  \setlength{\partopsep}{0pt}\setlength{\parsep}{0pt}\setlength{\parskip}{0pt}
129\item All articles should be in English.
130\item Articles should be a maximum of 3 pages.
131\item All articles should contain at least 2 images.
132\end{itemize}
133
134\itempar{Who Am I writing for?}This article should be in the style of a popular science article. This means that is should be relatively simple to understand and entertaining.
135
136\noindent The audience are not specialists in the field in questions, but rather interested laypeople. Adapt your content to the level of general knowledge of an educated adult who is not a computer scientist or scientist in your field Let your enthusiasm for your project show! Explain terms well.
137
138\noindent Use vivid language. Use illustrations, graphics and examples.
139
140\itempar{Formatting}%
141Final formatting will consist of a three column article 2-3 pages long. Please follow the formatting in the templates. Please provide links to hi-res version of any images submitted.
142
143\itempar{Title}%
144This should succinctly describe the content of the article. Be descriptive!
145%
146
147The title should be at the top of your first page and centred.
148Do not use a title page.
149%Headings with an asterisk(*) must be included
150
151\itempar{Content}%
152The following is the suggested content of the article. You do not have to include section heading to match, but should match the general flow and content.
153
154\itempar{Author}
155Author's names and institutional affiliation at the end.
156
157\itempar{Abstract -- What did I do - in brief}  An abstract is a one-paragraph summary of the entire article. It should describe the question/problem or research topic addressed in the project and the methods used to answer or explore this area. It should highlight the important parts of the article. This is easiest to write once you have completed the rest of the article. Include a sentence summarising the introduction, methods, results and discussion section. The abstract should not contain citations. Equations should be avoided if possible. And not numbered if not referenced in text.
158
159\itempar{Introduction -- What is the project?}%
160The introduction should describe the question/problem/research area addressed by the project and set the context for your work. It should explain why your project is an interesting or important. It should introduce the techniques and approach you used to complete the project.
161
162\itempar{Methods -- How did I complete the project?}%
163Briefly describe what was actually done. This should include more detail on techniques and approaches, with enough detail that an interested person could attempt to reproduce your work (You do not have to include every detail, but use citations to give the required background).
164
165\itempar{Results -- What did I find out?}%
166Focus on what worked! Outline the outcomes and results of your project
167
168\itempar{Discussion \& Conclusion}
169(What does that mean?) Explain your conclusions and your interpretation of your results. How did it compare to what was to be expected or previous work? What implications does this have for other work?
170
171\itempar{References} (what work did I reference?)
172
173\itempar{Acknowledgements} (who helped me?) PRACE acknowledgement will be given together at the colophon. Site acknowledgement if required. Other acknowledgement if requested.
174\multicolinterrupt{\textcolor{prace-darkblue}{\lipsum[16]}}
175
176\subsection*{Project form update}
177%Strange why the following macro needs to be repeated due to multicolinterrupt
178\newcommand{\itempar}[1]{\noindent\highlight{\textsf #1}\par\noindent}
179
180Week 3 plans are given separately and contain the following items:
181
182\itempar{Workplan} Please append and up-to-date workplan (Week 3 reports) outlining what you did week by week. Introduction can be used for final report too.
183
184\itempar{Appendices} (Extra information)
185Optional --- anything else you want to include, but not publish
186
187\itempar{Appendices} (Compulsory)
188
189
190\itempar{Award statement}%
191Please amend a section to ``Week 3 plans'' at end of the programme stating why you think you should win
192\begin{enumerate}
193  \item The HPC Ambassador Award.
194  \item The Best Visualisation Award.
195\end{enumerate}
196Information given as an update will be used to aid reviewers in evaluation of the projects and will not be publicly available.
197
198\subsection*{Tables and Figures}
199
200All tables and figures should be captioned. All tables and figures should be put into context in the text. Give your main figure instead of SoHPC logo figure nearby the title. Tables and figures should sequentially numbered. Make sure that there isn't a page break in the middle. Sometimes it is easier to add more text to get good balancing between columns.
201
202\noindent\begin{minipage}[H]{2\columnwidth+\columnsep}
203 %\vspace{-15pt}
204  \begin{figure}[H]
205  \centering
206  \color{yellow}\rule{\linewidth}{3.8cm}\color{black}
207  %\includegraphics{}
208  \caption{Captions for figures should be used only if necessary and referenced in text.}
209\label{fig:my_label}
210\end{figure}
211\end{minipage}
212
213
214\itempar{Acronyms, technical terms}%
215Symbols, abbreviations and acronyms should be defined the first time they are used and then used consistently from there on. Note that too technical slang is not desired here.
216
217
218\begin{table}[H]
219 \caption{Random table}
220 \centering
221 \begin{tabular}{llr}
222 \toprule
223 \multicolumn{2}{c}{Name} \\
224 \cmidrule(r){1-2}
225 First name & Last Name & Grade \\
226 \midrule
227 John & Doe & $7.5$ \\
228 Richard & Miles & $2$ \\
229 \bottomrule
230 \end{tabular}
231\end{table}
232
233\vspace*{5cm}
234
235\begin{figure*}[t]
236  \color{yellow}\rule{2\columnwidth+\columnsep}{10cm}%
237  %\includegraphics[width=2\columnwidth+\columnsep]{fig4}
238  \hspace{\columnsep}
239  \begin{minipage}[b]{1.0\columnwidth}
240    \color{yellow}\rule{\linewidth}{4.6cm}\\[\columnsep]
241    \color{prace-lightblue}\rule{\linewidth}{5cm}
242    % \includegraphics[width=\linewidth]{fig5}
243    % \includegraphics[width=\linewidth]{fig6}
244  \end{minipage}
245  \color{black}
246  \vspace{-3ex}
247  \caption*{Large figures should be placed at top and can be combination of
248    several sub-figures. With or without caption. Do not number figures if
249    they are not referenced in text. Several sentences can be used to
250    describe the figures.}
251  \label{fig:large}
252\end{figure*}
253\noindent Answers to the questions of general interest will be published at the page \url{http://trac.lecad.fs.uni-lj.si/sohpc/wiki/template} where also all template files are available for download.
254
255\section*{Videos and final presentations}
256We recommend that videos are prepared in \href{https://support.google.com/youtube/answer/1722171}{720p HD resolution} (19:6). Screen casts can be recorded by \href{http://atomisystems.com/activepresenter/free-edition/}{Active Presenter --  free edition}. It is advisable that you prepare a text that you will be recording along with the presentation. For quick check of how recording goes try the following:
257\begin{enumerate}
258 \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}
259 \item Enter Full Motion Recording (FMR).
260 \item Select Custom resolution (1280x720) and portion of screen you will be capturing.
261\item Disable Floating Toolbar (bottom left).
262\item Unmute microphone on the desktop.
263\end{enumerate}
264Once a capture has finished, one can:
265\begin{itemize}
266  \item Edit the capture (Cut, delete, copy, part of the captured video)
267  \item Insert text, shapes, spotlights, higlight boxes, images
268  \item Other elements possible.
269  \item Each added feature appears in the timeline and you can edit for how long it will appear, where it will appear and how it will appear/disappear through transitions
270  \item Position of these can also be altered to give a sense of ``animation''.
271  \item Export it into MP4 or AVI format.
272\end{itemize}
273There are many other ways to record a screen and edit such as \href{http://geekthis.net/blog/98/virtualbox-video-capture}{VirtualBox screen recording} and \href{https://youtu.be/WDh1CrL2344}{Windows Movie Maker}. For video encoding one can use \href{http://www.erightsoft.com/SUPER.html}{Super~\copyright} or similar software. Please visit examples of \href{https://www.youtube.com/playlist?list=PLhpKvYInDmFXMg1WcPTaMQVt-gUTx7HPV}{SoHPC 2013 videos} on Youtube.
274
275
276\section*{Section 1}
277Section names should not be to technical. No numbering should be used. Sections can be even questions for the text that follows. Section names can state the fact explained in continuation.
278
279\begin{figure}[H]
280  \color{yellow}\rule{\linewidth}{4cm}\color{black}
281  % \includegraphics[width=\linewidth]{vortex}
282  \caption{Quickly explain the content of the figure if you reference it in
283    the text.}
284  \label{fig:vortex}
285\end{figure}
286
287
288%\subsection*{Subsection 1}
289\begin{align}
290 A =
291 \begin{bmatrix}
292 A_{11} & A_{21} \\
293 A_{21} & A_{22}
294 \end{bmatrix}
295 \end{align}
296Please balance the size of figures and text in such way that you will have the complete page filled. It should not be half way ended. Use citations as superscript\cite{Figueredo:2009dg} if absolutely necessary.
297
298\newcommand{\sohpcinfo}[1]{\par\vspace{1ex}\footnotesize
299  \textcolor{prace-lightblue}{PRACE SoHPC}%
300  \textcolor{prace-darkblue}{#1}\\[0.5ex]\scriptsize
301}
302
303\renewcommand\refname{\usefont{OT1}{phv}{m}{n}\selectfont\small{References}}
304\begin{thebibliography}{9}
305\vspace*{-1ex}  % adjust this
306\scriptsize
307\bibitem[1]{Figueredo:2009dg}
308Figueredo, A.~J. and Wolf, P. S.~A. (2009).
309\newblock Assortative pairing and life history strategy - a cross-cultural
310  study.
311\newblock {\em Human Nature}, 20:317--330.
312\end{thebibliography}
313
314\vfill
315\noindent\begin{minipage}[b]{0.7\linewidth}
316\begin{flushleft}
317  \usefont{OT1}{phv}{m}{n}\selectfont
318  \sohpcinfo{Project Title}
319  \href{http://summerofhpc.prace-ri.eu} Official title of the project
320  \sohpcinfo{Site}
321  Institution, Country
322  \sohpcinfo{Authors}
323  \href{mailto:name@example.com}{\theauthor},
324  [association,] country
325  \sohpcinfo{Mentor}
326  \href{mailto:summerofhpc@ichec.ie}{Emma Hogan}, ICHEC, Ireland
327\end{flushleft}
328\end{minipage}\hfill%
329\begin{minipage}[b]{0.3\linewidth}
330  \color{prace-darkblue}\rule{\linewidth}{2.5cm}\par
331  \tiny\theauthor
332\end{minipage}%
333\vspace{-1.5ex}% any of information below is optional
334\begin{flushleft}
335  \sohpcinfo{Contact}
336  Name, Surname, Institution\\
337  Phone: +12 324 4445 5556\\
338  E-mail: \href{mailto:leon.kos@lecad.si}{leon.kos@lecad.fs.uni-lj.si}
339  \sohpcinfo{Software applied}
340  Virtuoso
341  \sohpcinfo{More Information}
342  \href{http://www.virtouso.org}{www.virtouso.org}
343  \sohpcinfo{Acknowledgement}
344  Write any requested acknowledgements or thanks here. Mentors should be
345  asked for them too.
346\sohpcinfo{Project ID} 15xx
347\end{flushleft}
348\end{multicols}
349\end{document} 
350
351%%Local Variables:
352%%% mode: latex
353%%% TeX-parse-self: t
354%%% TeX-auto-save: t
355%%% TeX-source-specials-mode: t
356%%% TeX-PDF-mode: t
357%%% LaTeX-command: "pdflatex -synctex=1  --enable-write1"
358%%% TeX-master: t
359%%% ispell-local-dictionary: "british"
360%%% End: