diff --git a/deliverable.template.tex b/deliverable.template.tex index 4a5311d..2ab24b9 100644 --- a/deliverable.template.tex +++ b/deliverable.template.tex @@ -1,170 +1,135 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% numpex Deliverable Template -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% NumPEx Delivrable Template (in LateX) +% -------------------------------------------------- \documentclass[11pt]{report} -\usepackage{numpex} % numpex specific definitions and styles -\usepackage[utf8]{inputenc} % UTF8 package +% -------------------------------------------------- +% Packages +\usepackage{numpex} % NumPEx +\usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} -\usepackage{textcomp} % common special chars -\usepackage{amsmath} % math formula +\usepackage{textcomp} +\usepackage{amsmath} \usepackage{fancybox} -\usepackage{anyfontsize} % fonts +\usepackage{anyfontsize} \usepackage{lipsum} \usepackage{cleveref} \usepackage[printonlyused]{acronym} -\hypersetup{ - pdftitle={[Title as appears in the DoA]}, - pdfauthor={[Names of co-authors (partners short names)]}, - pdfkeywords={[List of free keywords relevant to the deliverable]}, -} +\usepackage{tikz} +\usepackage{svg} +\usepackage{multirow} +% -------------------------------------------------- +% Path to figures \graphicspath{ {graphics/} } -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Definitions -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +% -------------------------------------------------- +% Definitions \input{defs} -% CHANGE %'s below to make subsection headings visible/invisible in TOC -%\newcommand{\xsubsubsection}[1]{\subsection{#1}} -%\newcommand{\xsubsubsection}[1]{\subsubsection{#1}} - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% URL style same as regular text -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +% -------------------------------------------------- +% URL style \urlstyle{same} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Deliverable Information -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% Project Meta Information -\ProjectFullTitle{Methods and Algorithms at Exascale} -\ProjectAcronym{Exa-MA} -\ProjectRefNo{ANR-22-EXNU-0002} - -% Work Package Number and Title (according to DoA) -\delivWP{WPx} -\delivWPName{[Title as appears in the DoA]} - -% Deliverable Number and Title (according to DoA) -\delivNumber{Dx.y} -\delivName{[Title as appears in the DoA]} - -% DOI Number (will be provided by the coordinator) -\doiNumber{10.5281/zenodo.5115579} % leave empty if no DOI Number is provided - -% Deliverable Short Title -\delivShortTile{[Short title for deliverable document]} - -% Deliverable Responsible Partner -\delivResponsible{UNISTRA} - -% Deliverable Version, Contractual and Actual Date, Dissemination Level, Type -\delivVersion{vn.n} -\ContractualDate{dd/mm/yyyy} -\ActualDate{dd/mm/yyyy} -\delivDissLevel{PU} % PU, PP, RE, CO -\delivType{[Report, Prototype, Other]} - -% List of Main Authors (usually from the responsible partner) -\delivAuthor{[Names of co-authors (partners short names)]} - -% List of Co-Authors (all other co-authors should be listed here) -\delivFPAuthor{[Names of co-authors (partners short names)]} - -% Provision of Keywords (about 5-10) -\delivKeywords{[List of free keywords relevant to the deliverable]} - -% Deliverable Status -\delivStatus{d} %% d = draft, f = final, s = submitted - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Change Log -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +% -------------------------------------------------- +% Required for change log \istChange{dd/mm/yyyy}{v1.0}{Name (Partner short name)}{Draft report template} \istChange{}{}{}{} +% -------------------------------------------------- +% Subsections in TOCs +%\newcommand{\xsubsubsection}[1]{\subsection{#1}} +%\newcommand{\xsubsubsection}[1]{\subsubsection{#1}} -\begin{document} +% -------------------------------------------------- +% Label end delivrable +\AtEndDocument{\label{PageEnd}} + +% -------------------------------------------------- +% General information: TO DO +% > Project +\newcommand\ProjectAcronym{Exa-Soft} % Exa-MA % Exa-DoST +\newcommand\ProjectTitle{Exascale Software and Tools} % Methods and algorithms for Exascale % Data-oriented Software and Tools for the Exascale +\newcommand\ProjectId{ANR-22-EXNU-0003} % ANR-22-EXNU-0002 % ANR-22-EXNU-0004 +\newcommand\ProjectKeywords{\textcolor{numpexred}{Exascale, Software stack}} +\newcommand\ProjectManager{Lucas Pernollet} +\newcommand\ProjectWebSite{https://numpex.org/exasoft-hpc-software-and-tools/} % https://numpex.org/exama-methods-and-algorithms-for-exascale/ % https://numpex.org/exadost-data-oriented-software-and-tools-for-the-exascale/ +\newcommand\ProjectConsortium{Inria, CEA, CNRS, Télécom SudParis, \\ Université Paris Saclay} % Inria, CEA, CNRS, Sorbonne Université, \\ Ecole Polytechnique % Inria, CEA, CNRS, Observatoire de Paris, \\ Observatoire de la Côte d'Azur + +% > Delivrable +\newcommand\DelivrableId{\textcolor{numpexred}{DX}} +\newcommand\DelivrableTitle{\textcolor{numpexred}{XXX}} +\newcommand\DelivrableVersion{\textcolor{numpexred}{V1.0}} +\newcommand\DelivrableDate{\textcolor{numpexred}{DD MM YYYY}} +\newcommand\DelivrableContractualDate{\textcolor{numpexred}{DD MM YYYY}} + +% > Control +\newcommand\DelivrableAuthors{\textcolor{numpexred}{XXX}} +\newcommand\DelivrableContributors{\textcolor{numpexred}{XXX}} +\newcommand\DelivrableReview{\textcolor{numpexred}{XXX}} +\newcommand\DelivrableApproval{\textcolor{numpexred}{XXX}} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Cover Page -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\makecover + +\begin{document} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Table of Contents -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% Cover page +\makecover +% -------------------------------------------------- +% Table of contents \clearpage \fancypagestyle{plain}{} \settableofcontents \tableofcontents -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% List of Figures -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\clearpage -\setlistoffigures -\listoffigures +% -------------------------------------------------- +% Content +\input{sections/introduction} +\input{sections/guidelines} +\input{sections/conclusions} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% List of Tables -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% References -\clearpage -\setlistoftables -\listoftables +\cleardoublepage +\addcontentsline{toc}{section}{References} +\bibliography{literature/references} +\bibliographystyle{apacite} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% List of Abbreviations -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% List of Abbreviations \input{sections/abbreviations} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Deliverable Content -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +% -------------------------------------------------- +% List of tables -\input{sections/summary} -\input{sections/introduction} -\input{sections/guidelines} -\input{sections/conclusions} +\cleardoublepage +\addcontentsline{toc}{section}{\listtablename} +\setlistoftables +\listoftables -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% References -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% List of Figures -\clearpage -\bibliography{literature/references} -\bibliographystyle{apacite} +\cleardoublepage +\addcontentsline{toc}{section}{\listfigurename} +\setlistoffigures +\listoffigures -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Appendix -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% Appendix \appendix \input{sections/appendix-a} \input{sections/appendix-b} - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Back Page -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\makedisclaimer +% End +\label{PageEnd} \end{document} diff --git a/graphics/cartouche.png b/graphics/cartouche.png new file mode 100644 index 0000000..02fde1d Binary files /dev/null and b/graphics/cartouche.png differ diff --git a/graphics/hyperride-coverbkg.svgz b/graphics/hyperride-coverbkg.svgz deleted file mode 100644 index 97a79c3..0000000 Binary files a/graphics/hyperride-coverbkg.svgz and /dev/null differ diff --git a/graphics/hyperride-logo.pdf b/graphics/hyperride-logo.pdf deleted file mode 100644 index 614ee1a..0000000 Binary files a/graphics/hyperride-logo.pdf and /dev/null differ diff --git a/graphics/hyperride-partners.pdf b/graphics/hyperride-partners.pdf deleted file mode 100644 index 0922115..0000000 Binary files a/graphics/hyperride-partners.pdf and /dev/null differ diff --git a/graphics/logo-cea-rouge-sur-blanc.svg b/graphics/logo-cea-rouge-sur-blanc.svg deleted file mode 100644 index 785b278..0000000 --- a/graphics/logo-cea-rouge-sur-blanc.svg +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - - - - diff --git a/graphics/logo-cnrs-blanc.png b/graphics/logo-cnrs-blanc.png deleted file mode 100644 index d0a9ec9..0000000 Binary files a/graphics/logo-cnrs-blanc.png and /dev/null differ diff --git a/graphics/logo-numex-partners.pdf b/graphics/logo-numex-partners.pdf deleted file mode 100644 index 423edc3..0000000 Binary files a/graphics/logo-numex-partners.pdf and /dev/null differ diff --git a/graphics/logo-numpex-exama-vector.png b/graphics/logo-numpex-exama-vector.png deleted file mode 100644 index b5ced05..0000000 Binary files a/graphics/logo-numpex-exama-vector.png and /dev/null differ diff --git a/graphics/logo-numpex-exama-web.png b/graphics/logo-numpex-exama-web.png deleted file mode 100644 index beb4e21..0000000 Binary files a/graphics/logo-numpex-exama-web.png and /dev/null differ diff --git a/graphics/logo-numpex.png b/graphics/logo-numpex.png deleted file mode 100644 index 3f3cda0..0000000 Binary files a/graphics/logo-numpex.png and /dev/null differ diff --git a/graphics/numpex-cover-bkg.pdf b/graphics/numpex-cover-bkg.pdf deleted file mode 100644 index 0eb2215..0000000 Binary files a/graphics/numpex-cover-bkg.pdf and /dev/null differ diff --git a/graphics/spirale_numpex.png b/graphics/spirale_numpex.png new file mode 100644 index 0000000..9653d8c Binary files /dev/null and b/graphics/spirale_numpex.png differ diff --git a/istcover.sty b/istcover.sty index 29c00d6..9c28a57 100644 --- a/istcover.sty +++ b/istcover.sty @@ -1,150 +1,100 @@ %% istcover.sty -%% -%% Cover page for ERIGrid 2.0 deliverables (adapted from EMBEDDIA, TALK, FRACAS and TRINDI) -%% -%% -%% History: -%% 03/21/94 - MP, created (from urcstitlepage.sty and -%% DYANA titlepage) -%% 03/27/94 - MP, added ftp directory and email address -%% 03/28/94 - RC, added HCRC -%% 20 April 98 -- RC, adapted to TRINDI -%% 30 APRIL 98 -- RC, adapted distribution data -%% Thu Feb 24 17:54:25 2000 JC adapted to M-PIRO -%% Wed Apr 5 16:51:40 2000 JC generalized for IST -%% Tue Dec 4 10:22:54 2001 CM changed copyright date -%% Tue Nov 16 2004 OL changed copyright date, logos, etc for TALK -%% Wed Nov 17 14:36:44 2004 TB added empty pagestyle for overflow page -%% (deliverable identification sheet) -%% 2019/05/31 Adaptations for Embeddia -%% 2020/05/18 Adaptations for ERIGrid 2.0 (TS) -%% 2020/10/27 Adaptations for numpex (TS) -%% $Id: istcover.sty,v 1.2 2007/01/05 12:05:33 olemon Exp $ - -%% -%% makefront -%% Frontpage content -%% +%% NumPEx deliverable front page style file. + +% Data box +\newcommand{\databox}[4]{% + \begin{center} + \begin{tikzpicture}[overlay, remember picture] + \node[inner sep=0.2cm, rectangle, text + width=\textwidth, draw=numpexlightergray, thin, font=\large, fill=numpexlightergray!10] (txt) + {Delivrable: #1 \\[0.25cm] + Title : #2 \\[0.25cm] + Author(s) : #3 \\[0.25cm] + Date : #4 }; + \end{tikzpicture} + \end{center} +} + +% -------------------------------------------------- +% Front page \def\makefront{ \newpage \newgeometry{top=8.5mm,left=8.5mm,right=15mm,bottom=-14mm} - % shadowed frame - \ThisCenterWallPaper{1}{graphics/numpex-cover-bkg} - % \global\@topnum\z@ % prevents figures from going at top of page - \thispagestyle{empty} % so we get no page number on title page - \setcounter{footnote}{0} + + \thispagestyle{empty} % No numbering on this page + \setcounter{footnote}{0} % Set page counter to 0 - \begingroup - % \renewcommand{\shadowsize}{2pt} - % \renewcommand{\shadowsize}{1pt} - % \shadowbox{% - % \begin{minipage}{\textwidth} - % redefine \@makefnmark so footnote marks take zero space - % (this make centering look better) - \def\thefootnote{\fnsymbol{footnote}} - \def\@makefnmark{\hbox to 0pt{$^{\@thefnmark}$\hss}} + \begingroup % > + + \def\thefootnote{\fnsymbol{footnote}} % Footnotes with dagger etc. symbols (9 max) + \def\@makefnmark{\hbox to 0pt{$^{\@thefnmark}$\hss}} % Footnote identifier without parenthesis \null - - % Titles block - \vspace*{34mm} - \hspace*{14mm} - \begin{minipage}{.85\linewidth} - \begin{center} - {\fontsize{16}{20}\bf \color{numpexblue} Methods and Algorithms at Exascale} \\[10ex] - \textit{Work Package \deliv@wp} \\[.6ex] - {\fontsize{14}{16}\bf \deliv@wpname} \\[10ex] - \textit{Deliverable \deliv@number} \\[.6ex] - {\fontsize{14}{16}\bf \deliv@name} \\[10ex] - \end{center} - \end{minipage} - - \begin{textblock*}{1.00\linewidth}(2.50cm,18cm) - \begin{tabular}{p{.21\linewidth}p{.64\linewidth}} - \textit{Funding Instrument:} & France 2030\\ - \textit{Call:} & PEPR \\ - \textit{Call Topic:} & Exascale computing \\ - & \\ - \textit{Project Start:} & 1 Janvier 2023 \\ - \textit{Project Duration:} & 48 months \\ - & \\ - \textit{Beneficiary in Charge:} & \deliv@owner \\ - & \\ - \ifx\doi@number\empty - \else - \textit{Document Identifier:} & doi:\href{https://doi.org/\doi@number}{\doi@number} - \fi - \\ - \end{tabular} - \end{textblock*} - - \begin{textblock*}{0.85\linewidth}(2.50cm,24cm) - {\fontsize{9}{11}\selectfont - \setlength{\parindent}{0pt} - \def\arraystretch{1.25} - \arrayrulecolor{numpexgray} - \begin{tabular}[t]{!{\color{numpexgray}\vrule}p{4em}!{\color{numpexgray}\vrule}p{.8\linewidth}!{\color{numpexgray}\vrule}p{2em}!{\color{numpexgray}\vrule}} - \rowcolor{numpexgray}\multicolumn{3}{c} - {\rule{0pt}{2.5ex}\color{white}\bf Dissemination Level \rule[-1ex]{0pt}{2.5ex}} - \\ - \rowcolor{white} - PU & Public & \istTestDisseminationLevel{PU} \\ - \rowcolor{numpexlightergray} - PP & Restricted to other programme participants (including the - Commission Services) - & \istTestDisseminationLevel{PP} \\ - \rowcolor{white} - RE & Restricted to a group specified by the Consortium (including the Commission Services) - & \istTestDisseminationLevel{RE} \\ - \rowcolor{numpexlightergray} - CO & - Confidential, only for members of the Consortium (including the Commission Services) - & \istTestDisseminationLevel{CO} \\ - \hline - \end{tabular} - } - \end{textblock*} - - \endgroup + + % Optional top left logos + % \begin{tikzpicture}[remember picture,overlay] + % \node [shift={(1cm,-1cm)}] at (current page.north west) [anchor=north west]{\includegraphics[width=60pt]{graphics/logo-ep.jpeg}}; + % \end{tikzpicture} + + % Mandatory bottom right logos + \begin{tikzpicture}[remember picture,overlay] + \node [shift={(-5cm,1cm)}] at (current page.south east) [anchor=south east]{\includesvg[width=40pt]{graphics/logo-cea.svg}}; + \node [shift={(-3cm,1cm)}] at (current page.south east) [anchor=south east]{\includesvg[width=40pt]{graphics/logo-cnrs.svg}}; + \node [shift={(-0.5cm,1.35cm)}] at (current page.south east) [anchor=south east]{\includegraphics[width=60pt]{graphics/logo-inria-rouge.png}}; + \end{tikzpicture} + + % Mandatory top right logos + \begin{tikzpicture}[remember picture,overlay] + \node [shift={(-1cm,-1cm)}] at (current page.north east) [anchor=north east]{\includegraphics[width=50pt]{graphics/spirale_numpex.png}}; + \end{tikzpicture} + + \vspace{2cm} + + \centerline{\textcolor{numpexblue}{\rule{0.5\linewidth}{1pt}}} + \vspace{0.5cm} + \centerline{\Huge \textcolor{numpexblue}{PEPR NumPEx}} + \vspace{0.25cm} + \centerline{\textcolor{numpexblue}{\rule{0.5\linewidth}{1pt}}} + + \vspace{1.5cm} + + \includegraphics[width=\textwidth]{graphics/cartouche.png} + + \vspace{1.5cm} + + \centerline{\huge \textcolor{numpexblue}{\ProjectAcronym}} + + \vspace{0.5cm} + + \centerline{\LARGE \textcolor{numpexblue}{\ProjectTitle}} + + \vspace{3.5cm} + + \databox{\DelivrableId}{\DelivrableTitle}{\DelivrableAuthors}{\DelivrableDate} + + \endgroup % < \clearpage \restoregeometry - % reset footnote counter - \setcounter{footnote}{0} - % clean up title page macros - % Not yet! - % \let\maketitle\relax - % \gdef\@thanks{}\gdef\@author{}\gdef\@title{} - % \gdef\@funding{}\gdef\@techrepdept{}\gdef\@techrepname{}\gdef\@techrepnum{} - % \let\thanks\relax - - % margins + \setcounter{footnote}{0} % Set page counter to 0 } -%end of makefront - -%% -%% \makeback -%% Back page of the cover -%% +% -------------------------------------------------- +% Back page \def\makeback{ \clearpage \newgeometry{a4paper,top=2.50cm,left=2.50cm,right=2.50cm,bottom=3.30cm,headsep=0.50cm,footskip=-0.77cm} \vspace*{-0.05cm} - \istdis %%%%% see istprog.sty - \istmakechangelog + \istdis % Definition in istprog.sty + \clearpage + \clearpage + \istmakechangelog } -%% -%% \makecover -%% cover page (front + back) -%% +% -------------------------------------------------- +% Cover page (front and back) \def\makecover{ \makefront \makeback } -\newcommand\Thickvrule[1]{% - \multicolumn{1}{!{\vrule width 2pt}c!{\vrule width 1pt}}{#1}% -} - \endinput \ No newline at end of file diff --git a/istprog.sty b/istprog.sty index f4903dc..f9cfcb2 100644 --- a/istprog.sty +++ b/istprog.sty @@ -1,28 +1,22 @@ -%% $Id: istprog.sty,v 1.1 2006/10/17 11:13:53 poller Exp $ -%% History: -%% Tue Dec 4 10:26:29 2001: CM tweaked to stop tables messing up -%% Tue Dec 4 10:35:09 2001: CM hacked again to fix page height -%% Tue Nov 16 2004: OL various changes for TALK -%% Wed Nov 17 15:05:09 2004: TB more changes for TALK -%% 2014/01/10 Adaptations for Metalogue -%% 2019/05/31 Adaptations for Embeddia -%% 2020/05/18 Adaptations for ERIGrid 2.0 (TS) -%% 2020/05/18 Adaptations for numpex (TS) -%% 2025/08/18 Adaptations for NUMPEX (TS) +%% istprog.sty +%% NumPEx deliverable genenral information style file. + \ProvidesPackage{istprog} -%\usepackage{xstring} -\usepackage{lastpage} +%\usepackage{lastpage} \usepackage{fancyhdr} \usepackage{stringstrings} \usepackage{ifthen} \usepackage{amssymb} +\usepackage{makecell} -% table of content alias +% -------------------------------------------------- +% Alias for table of contents \newcommand{\maketoc}{ \thispagestyle{empty}\pagenumbering{roman}\tableofcontents\newpage\pagenumbering{arabic} } -% redefine elements styles +% -------------------------------------------------- +% Redefine styles \@ifclassloaded{report}{ \renewcommand{\section}{\@startsection {section}{1}{\z@}% {-3.5ex \@plus -1ex \@minus -.2ex}% @@ -46,64 +40,65 @@ % {\normalfont\normalsize\sffamily\bfseries}} } -%%% Deliverable information sheet. +% -------------------------------------------------- +% Back page with information +\newcommand{\istdis}{ -\newcommand{\GetDeliverableID}{% -\capitalizewords[e]{\deliv@stitle} -\alphabetic[e]{\thestring} -\edef\deliv@captitle{\thestring} -\testmatchingchar{\deliv@status}{1}{d} -\proj@acronym-\convertchar{\deliv@number}{.}{}-\noblanks{\deliv@captitle}-\deliv@status\ifmatchingchar{-\deliv@version}\else{}\fi -%\IfBeginWith{\deliv@status}{d}{-\deliv@version}{} -} + % Title + \centerline{\LARGE \textcolor{numpexblue}{Project and Deliverable Information Sheet}} -% istdis project refs -\newcommand{\istdis}{ - {\fontsize{12}{15}\bf\color{numpexblue}Deliverable Information}\\[1.5ex] - \setlength{\parindent}{0pt} - \def\arraystretch{1.25} - \arrayrulecolor{numpexgray} - {\fontsize{9}{11}\selectfont - \begin{tabular}[t]{!{\color{numpexgray}\vrule}p{.25\linewidth}!{\color{numpexgray}\vrule}p{.6885\linewidth}!{\color{numpexgray}\vrule}} - \rowcolor{numpexgray}\multicolumn{2}{c} - {\rule{0pt}{2.5ex}\color{white}\bf Document Administrative Information} \\ - \rowcolor{white} - Project Acronym: & \proj@acronym \\ - \rowcolor{numpexlightergray} - Project Number: & \proj@ref@no \\ - \rowcolor{white} - Deliverable Number: & \deliv@number\\ - \rowcolor{numpexlightergray} - Deliverable Full Title: & \parbox{\linewidth}{\deliv@name} \\ - \rowcolor{white} - Deliverable Short Title: & \deliv@stitle \\ - \rowcolor{numpexlightergray} - Document Identifier: & \GetDeliverableID{} \\ - \rowcolor{white} - Beneficiary in Charge: & \deliv@owner \\ - \rowcolor{numpexlightergray} - Report Version: & \deliv@version \\ - \rowcolor{white} - Contractual Date: & \deliv@contrdate \\ - \rowcolor{numpexlightergray} - Report Submission Date: & \deliv@actdate \\ - \rowcolor{white} - Dissemination Level: & \deliv@disslevel \\ - \rowcolor{numpexlightergray} - Nature: & \deliv@type \\ - \rowcolor{white} - Lead Author(s): & \deliv@authors \\ - \rowcolor{numpexlightergray} - Co-author(s):& \deliv@FPauthors \\ - \rowcolor{white} - Keywords: & \deliv@keywords \\ - \rowcolor{numpexlightergray} - Status: & \deliv@status@table \\ - \hline + \vspace{0.75cm} + + \renewcommand{\arraystretch}{1.25} + \begin{tabular}{ |l|l l| } + \hline + + \multirow{3}{4em}{\ProjectAcronym} & Program: & \makecell[tl]{Programme et équipement prioritaire de \\ recherche (PEPR) NumPEx} \\ + & Acronym: & \ProjectAcronym \\ + & Project Title: & \ProjectTitle \\ + & Project Identifier & \ProjectId \\ + & Keywords: & \ProjectKeywords \\ + & Project Manager: & \ProjectManager \\ + & Project Web Site & \url{\ProjectWebSite} \\ + & Consortium: & \makecell[tl]{\ProjectConsortium} \\ + \hline + + \end{tabular} + + \vspace{0.75cm} + + \renewcommand\arraystretch{1.25} + \begin{tabular}{ |l|l l| } + \hline + \multirow{3}{5em}{NumPEX Deliverable} & Deliverable Identifier: & \DelivrableId\\ + & Deliverable Title: & \DelivrableTitle\\ + & Status: & \DelivrableVersion\\ + & Contractual Date of Delivery: & \DelivrableDate\\ + & Report Delivery Date: & \DelivrableContractualDate\\ + \hline + \end{tabular} + + \vspace{1.5cm} + + % Title + \centerline{\LARGE \textcolor{numpexblue}{Document Control Sheet}} + + \vspace{0.75cm} + + \renewcommand\arraystretch{1.25} + \begin{tabular}{ |l|l l| } + \hline + \multirow{3}{5em}{Authorship} & Written by: & \DelivrableAuthors \\ + & Contributors: & \DelivrableContributors \\ + & Reviewed by: & \DelivrableReview \\ + & Approved by: & \DelivrableApproval \\ + \hline \end{tabular} -}\\[3ex] } + +% -------------------------------------------------- +% Change Log \newcommand{\istmakechangelog} {% \InputIfFileExists {\jobname.chl}{}{% \ClassWarning{france2030proposal}{Change log not complete yet. Recompile to include all data.}}% @@ -142,94 +137,6 @@ \writechlog } -% disclaimer -\newcommand{\makedisclaimer}{ - \cleardoublepage - \thispagestyle{empty} - \ThisCenterWallPaper{1}{graphics/numpex-cover-bkg} - - \vspace*{5cm} - - {\fontsize{12}{15}\bf\color{numpexblue}Consortium}\\[2ex] - {\includegraphics[width=0.98\linewidth,page=2]{graphics/numpex-cover-bkg.pdf}}\\[1ex] - - {\fontsize{12}{15}\bf\color{numpexblue}Disclaimer}\\[2ex] - {\small All information provided reflects the status of the \projacronym{} project at the time of writing and may be subject to change. - - Neither the \projacronym{} Consortium as a whole nor any single party within the \projacronym{} Consortium warrant that the information contained in this document is capable of use, nor that the use of such information is free from risk. - Neither the \projacronym{} Consortium as a whole nor any single party within the \projacronym{} Consortium accepts any liability for loss or damage suffered by any person using the information. - - This document does not represent the opinion of the French National Research Agency, and the French National Research Agency is not responsible for any use that might be made of its content. - }\\[1ex] - - \renewcommand{\doclicenseLongText}{\textcopyright~\the\year~by the authors, the \projacronym{} Consortium. \doclicenseText} - - {\fontsize{12}{15}\bf\color{numpexblue}Copyright Notice}\\[2.0ex] - \ifthenelse{\equal{\deliv@disslevel}{PU}} - {\vspace*{-3.0ex}\small\doclicenseLicense} - {\small\textcopyright~\the\year~by the authors, the \numpex{} Consortium.} -} -\makeatletter -\def\ProjectRefNo#1{\gdef\proj@ref@no{#1}\gdef\projrefno{#1}} -\def\ProjectFP#1{\gdef\proj@fp{#1}} -\def\ProjectAcronym#1{\gdef\proj@acronym{#1}\gdef\projacronym{#1}} - -\def\ProjectFullTitle#1{\gdef\proj@title{#1}\gdef\projtitle{#1}} -\def\ProjectInstrument#1{\gdef\proj@instrument{#1}} -\def\ProjectStartDuration#1{\gdef\proj@start@duration{#1}} -\def\Security#1{\gdef\deliv@security{#1}} -\def\ContractualDate#1{\gdef\deliv@contrdate{#1}} -\def\ActualDate#1{\gdef\deliv@actdate{#1}} -\def\delivNumber#1{\gdef\deliv@number{#1}} -\def\delivName#1{\gdef\deliv@name{#1}} -\def\doiNumber#1{\gdef\doi@number{#1}} -\def\delivShortTile#1{\gdef\deliv@stitle{#1}} -\def\delivType#1{\gdef\deliv@type{#1}} -\def\delivStatus#1{% - %\StrLeft{#1}{1}[\firstchar]% - %\edef\temparg{\firstchar}% - \substring[e]{#1}{1}{2} - \def\temparg{\thestring}% - \edef\tempf{\detokenize{f}}% final - \edef\temps{\detokenize{s}}% submitted - \if\temparg\tempf% - {\gdef\deliv@status{final}% - \gdef\deliv@status@table{\underline{~~~} draft, \underline{\deliv@checkmark} final, \underline{~~~} submitted}} - \else % - \if\temparg\temps% - {\gdef\deliv@status{submitted}% - \gdef\deliv@status@table{\underline{~~~} draft, \underline{~~~} final, \underline{\deliv@checkmark} submitted}} - \else - {\gdef\deliv@status{draft}% - \gdef\deliv@status@table{\underline{\deliv@checkmark} draft, \underline{~~~} final, \underline{~~~} submitted}} - \fi - \fi% - % \ifthenelse{\equal{#1}{f}}%\or\equal{\lowercase{#1}}{\string final}}% - % {\gdef\deliv@status{final}% - % \gdef\deliv@status@table{\_ draft, $\underline{\checkmark}$ final, \_ submitted (tick one)}}% - % {\gdef\deliv@status{\lowercase{#1}}% - % \gdef\deliv@status@table{$\underline{\checkmark}$ draft, \_ final, \_ submitted (tick one)}}% -} -\def\delivVersion#1{\gdef\deliv@version{#1}\gdef\delivversion{#1}} -\def\NumberOfPages#1{\gdef\deliv@pages{#1}} -\def\delivMonth#1{\gdef\deliv@month{#1}} -\def\delivYear#1{\gdef\deliv@year{#1}} -\def\delivDissLevel#1{\gdef\deliv@disslevel{#1}} - -\def\delivWP#1{\gdef\deliv@wp{#1}} -\def\delivWPName#1{\gdef\deliv@wpname{#1}} -\def\delivTask#1{\gdef\deliv@task{#1}} -\def\delivResponsible#1{\gdef\deliv@owner{#1}} -\def\delivOtherContributors#1{\gdef\deliv@others{#1}} -\def\delivAuthor#1{\gdef\deliv@authors{#1}\author{#1}} -\def\delivFPAuthor#1{\gdef\deliv@FPauthors{#1}\author{#1}} -\def\delivProjectOfficer#1{\gdef\deliv@officer{#1}} -\def\delivKeywords#1{\gdef\deliv@keywords{#1}} -\def\delivAbstract#1{\gdef\deliv@abstract{#1}} -\def\delivExecSummary#1{\gdef\deliv@abstract{#1}} -\def\delivExecSummary#1{\gdef\deliv@abstract{#1}} - - \newcounter{@changecount} \setcounter{@changecount}{0} \newcounter{@row} @@ -245,96 +152,23 @@ @changesummary\arabic{@changecount}\endcsname{\detokenize{#4}} } -%%% Headers and footers - +% -------------------------------------------------- +% Headers and footers \renewcommand{\headrulewidth}{0pt} \lhead{\fancyplain{}{}} \chead{\fancyplain{}{ - \begin{tabular}{m{0.25\linewidth} m{0.47\linewidth} m{0.25\linewidth}} - {\footnotesize Exa-MA} & - \centering{\footnotesize{\deliv@stitle}} + \begin{tabular}{m{0.72\linewidth} m{0.25\linewidth}} + \footnotesize{Delivrable short title here} & - \makebox[0.24\textwidth][r]{\includegraphics[width=0.18\linewidth]{graphics/logo-numpex-exama-vector.png}} \\ + \makebox[0.24\textwidth][r]{\includegraphics[width=0.18\linewidth]{graphics/spirale_numpex.png}} \\ \hline \end{tabular} }} \rhead{\fancyplain{}{}} \lfoot{\fancyplain{}{}} -\cfoot{\fancyplain{}{ - \begin{tabular}{m{0.25\linewidth} m{0.47\linewidth} m{0.25\linewidth}} -% \hline - {\footnotesize Deliverable \deliv@number} & - \ifx\doi@number\empty - \else - \centering {\footnotesize doi:\href{https://doi.org/\doi@number}{\doi@number}} - \fi - & - \makebox[0.24\textwidth][r]{\footnotesize{\thepage{} of \pageref{LastPage}}} \\ - \end{tabular} -}} -\rfoot{\fancyplain{}{}} - -% Some reasonable defaults. - -\Security{??} -\ContractualDate{} -\ActualDate{\today{}} -\delivNumber{Dn.n} -\delivName{??} -\delivType{??} - -\delivWP{??} -\delivWPName{??} -\delivResponsible{??} -\delivOtherContributors{??} -\delivAuthor{??} -\delivProjectOfficer{??} -\delivKeywords{??} -\delivAbstract{??} - -\ProjectRefNo{ANR-22-EXNU-0002} -\ProjectAcronym{Exa-MA} -\ProjectFullTitle{Methods and Algorithms at Exascale} -\Security{Restricted} -\ContractualDate{\_\_\_\_ \_\_\_\_\_ 202\_} -\delivMonth{Month} -\delivYear{202x} -\ActualDate{\_\_\_\_\_\_ 202\_} -\delivNumber{Dn.n} -\delivName{[Title as appears in the DoA]} -\delivShortTile{Report Short Title Here} -\delivDissLevel{PP} -\delivType{[Report, Prototype, Other]} -\delivStatus{d} -\delivWP{WPx} % Workpackage x -\delivWPName{[Title as appears in DoA]} % WP name -\delivResponsible{[Responsible partner]} -\delivOtherContributors{[List of partners contributed to the deliverable]} -\delivVersion{\today} -\delivAuthor{[List of individuals contributed to the deliverable]} -\delivFPAuthor{...} - -\delivOtherContributors{All partners} -\delivProjectOfficer{Project officer} - -\delivKeywords{[List of free keywords relevant to the deliverable]} - -\delivDissLevel{CO} -\delivTask{Tn.n} -\delivVersion{0.0} -\NumberOfPages{\pageref{LastPage(excluding front matter)}} - -\newcommand{\istTestDisseminationLevel}[1]{% - \ifthenelse{\equal{\deliv@disslevel}{#1}} - {~~\checkmark} - {} +\cfoot{\fancyplain{}{\footnotesize{\thepage{} of \pageref{PageEnd}}} } +\rfoot{\fancyplain{}{}} -%% Stuff for other than in the identification page - -\def\partners#1{\gdef\proj@partners{#1}} -\def\webAddress#1{\gdef\proj@web{#1}} -\def\principalContact#1{\gdef\proj@contact{#1}} -\def\logo#1{\gdef\proj@logo{#1}} \makeatother \endinput diff --git a/numpex.sty b/numpex.sty index a70a68a..c1340b8 100644 --- a/numpex.sty +++ b/numpex.sty @@ -30,11 +30,11 @@ linkcolor=black, filecolor=black, citecolor=black, - urlcolor=blue, - pdftitle=\deliv@stitle, - pdfauthor=\deliv@authors, - pdfsubject=NumPEX Exa-MA Project Deliverable, - pdfkeywords=\deliv@keywords, + urlcolor=numpexblue, + pdftitle=delivrable, + pdfauthor=authors, + pdfsubject=exa-soft, + pdfkeywords=keywords, pdfcreator=pdflatex, pdfproducer=Overleaf, } @@ -54,33 +54,6 @@ %\ExecuteOptions{checkmark} \ProcessOptions -%%%%%%%%%%%%%%%%%%%% -% Project references -%%%%%%%%%%%%%%%%%%%% - -\ProjectRefNo{ANR-22-EXNU-0002} -\ProjectFP{France 2030} -\ProjectAcronym{Exa-MA} -\ProjectFullTitle{Methods and Algorithms at Exascale} -\ProjectInstrument{PEPR} -\ProjectStartDuration{1 Septembre 2023 / 60 Months} -\Security{Public} - -% \partners{ -% \textbf{AIT Austrian Institute of Technology} \\ -% } - -% \webAddress{https://numpex.eu} -% \principalContact{ERIGrid 2.0 Project Co-ordinator \\ -% Dr.\ Gerhard Jambrich \\ -% AIT Austrian Institute of Technology \\ -% Electric Energy Systems -- Center for Energy \\ -% Giefinggasse 2 \\ -% 1210 Vienna, Austria \\ -% gerhard.jambrich@ait.ac.at \\ -% Phone +43 664 88335404 -- Fax +43 50550 6390 -% } - \usepackage{graphicx} \usepackage[usenames,dvipsnames,svgnames]{xcolor} \usepackage{colortbl} @@ -171,8 +144,6 @@ \renewcommand{\cfttabaftersnum}{:~} } -\logo{\includegraphics[scale=0.465]{graphics/logo-numpex-exama-vector.png}} - \newcommand{\ignore}[1]{} % subsubsections processing diff --git a/sections/abbreviations.tex b/sections/abbreviations.tex index 7f045f5..5b10fce 100644 --- a/sections/abbreviations.tex +++ b/sections/abbreviations.tex @@ -3,14 +3,13 @@ %%% List of Abbreviations %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\clearpage +\cleardoublepage +\addcontentsline{toc}{section}{List of Abbreviations} \section*{List of Abbreviations} \label{sec:abbreviations} \begin{acronym}[ABCDEF] \acro{Exa-MA}{Methods and Algorithms for Exascale Computing} - \acro{DoA}{Description of Action} - \acro{EC}{European Commission} \acro{WP}{Work Package} \end{acronym} diff --git a/sections/conclusions.tex b/sections/conclusions.tex index ea8f8d8..91bce2c 100644 --- a/sections/conclusions.tex +++ b/sections/conclusions.tex @@ -1,16 +1,14 @@ %!TEX root = ../deliverable.template.tex -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Conclusions -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% --------------------------------------------------> \clearpage \section{Conclusions} \label{sec:conclusions} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Section content, please change! -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% TO DO +% -------------------------------------------------- Each deliverable should end with conclusions and plans for further work. -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ No newline at end of file +% <-------------------------------------------------- \ No newline at end of file diff --git a/sections/guidelines.tex b/sections/guidelines.tex index c91297e..dd2c1bb 100644 --- a/sections/guidelines.tex +++ b/sections/guidelines.tex @@ -1,102 +1,17 @@ %!TEX root = ../deliverable.template.tex -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Guidelines -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% --------------------------------------------------> +% Guidelines \clearpage \section{Guidelines} \label{sec:guidelines} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Section content, please change! -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +This section provides guidelines for the use of this \LaTeX\ \cite{bib:lamport1994} template for the work done in the \ac{WP} of your project. -\subsection{Report Titles} -\label{sec:report-titles} +Please adapt the MACROs in the main file in order to generate the delivrable with correct information on the front page and in the general information tables. These MACROs are used in the \texttt{istcover.sty} and \texttt{istprog.sty} files. In the first, uncomment code associated to the upper left logo if you wish to add one (optional). To change the header and footers refer to \texttt{istprog.sty}. -Deliverables have a title that is defined in the \ac{DoA}. -This title is referred to as the full title of the deliverable. -Please stick to the official spelling. -It has turned out useful to also have a short title (max 60 characters) for each deliverable, as it can be cumbersome if one always has to use the full title. - -\subsection{File Naming} -\label{sec:file-naming} - -The project will generate many documents (deliverable reports) and versions of these reports. -It is beneficial to consistently use an agreed file naming format. - -\texttt{\projacronym-Dnn-ShortTitle-Status-vx.y.z.Extension} - -\begin{itemize} - \item Notice the hyphen between the various elements of the file name. - \item {\bf \projacronym}: Each \projacronym{} report should be preceded by the project acronym. Notice, there is only one correct spelling of the acronym: ‘\projacronym’. - \item {\bf Dn.n}: Indicates the deliverable identifier, e.g., ‘D34’ for ‘D3.4’ following the numbering of the \ac{DoA} (Part A of Annex 1 of the Grant Agreement). Notice, there is no dot between the two parts of the deliverable number. - \item {\bf ShortTitle}: This should be based on the formal short title of deliverables but ‘contracted’ into a single (no spaces) character string using Java class naming convention, e.g., ‘ExploitationPlan’, or ‘ProjectWebSite’. Avoid underscore, space and other unusual characters. - \item {\bf Status}: - \begin{itemize} - \item \textit{draft} = Draft Version – indicates that the drafting of the report is in progress; - \item \textit{final} = Final Version as checked and updated by the reviewers/WP leader/quality manager; - \item \textit{submitted} = submitted version as submitted to the EC by the project coordinator/administrator. - \end{itemize} - \item {\bf vx.y.z}: The version of the report starting from v1.0. - \item {\bf Extension}: File extension, e.g., ‘pdf’ for Portable Document Format. -\end{itemize} - -Examples: - -\begin{itemize} - \item ERIGrid2-D82-InternalCommunication-draft-v1.0.docx - \item ERIGrid2-D84-QualityAssurancePlan-submitted.pdf -\end{itemize} - -\subsection{Change Log} -\label{sec:change-log} - -The Change Log is there to keep track of the changes made to the document. Whenever changes are made to the document, a new version should be created and the changes should be briefly summarised in the Change Log. We anticipate a minimum of three phases of Change Log entries. (1) The researcher responsible for the given Deliverable enters the changes as he/she develops the document. (2) The two reviewers register the changes made in the quality assurance phase. Once the responsible researcher passes the report on to the Project Coordinator, the status should be changed from ‘draft’ to ‘final’. (3) The Project Coordinator submits the report to the EC, the status should be changed from ‘final’ to ‘submitted’. - -\subsection{Document Formatting} -\label{sec:document-formatting} - -\subsubsection{Headings} -\label{sec:headings} - -Like in many journals and books, it is a good practice not to use more than 3 levels of headings. If you really need more, then by all means do so, but you may first consider how to structure the document with a maximum of three heading levels. - -Use the following capitalisation style for all headings: All terms should be capitalised and do not use a full stop at the end. - -\subsubsection{Captions and Citations} -\label{sec:captions-and-citations} - -Use the following for captions and cross referencing: - -\begin{itemize} - \item ‘Table 1’ for tables, not ‘table 1’ or ‘Tab. 1’, etc. - \item ‘Figure 1’ for figures, not ‘figure 1’ or ‘Fig. 1’, etc. - \item ‘Section 1.1.1’ to cross-reference other sections, not ‘section 1.1.1’ or ‘S. 1.1.1’, etc. -\end{itemize} - -Do not abbreviate the word ‘Equation’ to ‘eq’, ‘Eqn’, etc. - -Table captions should be placed above the table and figure captions should be placed below the figure. The captions should succinctly describe the content of the table or figure. - -\subsubsection{Tables} -\label{sec:tables} - -Producing informative tables is not easy. Avoid grid lines around each table cells (typical for people with little experience in drafting technical papers). The table below (\Cref{tab:graphicastable}) is a good example how tables should look like. Make sure that caption appears on the same page as the table. The table caption is above the table! - -The table caption should follow the sentence style layout and end with a full stop. The caption as well as the table should be centred. - -Each table must be introduced in the deliverable text. Make sure that cross references to tables are correct before submitting the deliverable. - -\begin{table}[htb] - \centering - \caption{Summary of properties of different modelling formalisms. The table below is inserted as graphic.} - \label{tab:graphicastable} - \includegraphics[width=1.00\linewidth]{graphics/graphicastable} -\end{table} - -The same (simplified) table using the \LaTeX\ table feature is shown below (\Cref{tab:latextable}). +Let us provide as a reminder some standard features which might be usefull to write a delivrable. Let us start with a table(\Cref{tab:latextable}). \begin{table}[htb] \centering @@ -114,188 +29,18 @@ \subsubsection{Tables} \end{tabular} \end{table} -\subsubsection{Figures} - -Good figures/diagrams are even more difficult to produce than tables. Figures should contain legends explaining the symbols in the figure. Avoid surrounding the figure with a box outline. If there are different parts of a figure (e.g., (a), (b), (c)), indicate these clearly. Make sure that the labels within a figure/diagram are spelled consistently within the figure/diagram and are also consistently spelled in the text. Make sure that caption appears on the same page as the figure. The figure caption is below the figure. See an example of a figure and its caption below (\Cref{fig:figure}). - -Each figure must be introduced in the deliverable text. Make sure that cross references to figures are correct before submitting the deliverable. - -The figure caption should follow the sentence style layout and end with a full stop. The figure caption as well as the figure should be centred. +Let us now insert a figure. \begin{figure}[htb] \centering - \includegraphics[width=.89\linewidth]{graphics/figure} + \includegraphics[width=.4\linewidth]{graphics/spirale_numpex.png} \caption{Caption caption caption caption caption caption caption caption caption. (a) Caption caption caption, (b) Caption caption caption, (c) Caption caption caption.} \label{fig:figure} \end{figure} -\subsubsection{Footnotes} -\label{sec:footnotes} - -This\footnote{The footnote is at the bottom of the same page where the footnote is cited and the font size is only 9 pt. Footnotes are useful to for including nasty-looking long Web references which would look terrible if used in the main flow of the text.} is a footnote. - -\subsection{Language and Notation} -\label{sec:language-and_notation} - -There are a few things we should consider when writing documents in terms of language. The question is not deeply philosophical in the sense of whether one or the other approach is fundamentally correct (or wrong). It is more the case of maintaining a certain level of consistency across the project. - -Since British/UK English is the official version of English within the EC, we should by default use UK English spelling (and adopt a spell-checker set to UK English). Nevertheless, US spelling is also fine – the main issue to ensure is to be consistent within a given deliverable. - -Quotation marks. UK English (unlike US), use single quotation marks (‘X’) instead of double quotation marks (``X''). At least maintain consistency within a document. - -\begin{itemize} - \item It is claimed that Y is ‘superior’ to X. - \item ‘Good morning, Dave,’ greeted HAL. -\end{itemize} - -Do not use quotation marks to indicate emphasis – use italics, bold or underline style instead. - -The accepted standard for separating orders of magnitude in large figures is not ‘,’ or ‘’’ (quotation mark) or ‘.’, but a non-breaking (small) space. - -\begin{itemize} - \item This is inappropriate: 1,000,000 or 1.000.000 or 1’000’000 (very bad!) - \item This is good: $1\,000\,000$. -\end{itemize} - -Capitalisation. Use capitalisation according to English grammar rules. If someone is interested, see -capitalisation rules:\footnote{\url{http://andromeda.rutgers.edu/~jlynch/Writing/c.html}, \url{http://www.grammarbook.com/punctuation/capital.asp}} - -Tense. Use past tense when describing activities and tasks (experiments, developments, etc) carried out in the past. - -\begin{itemize} - \item A test bed was set up to ... - \item The evaluation revealed that ... -\end{itemize} - -Use present tense when describing the ideas, design, systems, etc. that exist in the present. - -\begin{itemize} - \item The system supports the following exchange formats ... - \item A key property of the system is its ability to ... -\end{itemize} - -Large numbers. Use explicit format or scientific notation for large numbers - -\begin{itemize} - \item Use $1\,200\,000\,000$, not 1.2bn or 1,200,000,000 - \item Or use $1.20\,10^9$ or $1.20 \times 10^9$ -\end{itemize} - -Small numbers. As usual, unless in tables and similar elements, use {one, two, ... , twelve} for numbers < 13, and {13, 14, ..., } for large numbers. - -Numbers and units. Use small space (In \LaTeX: \, or ~) to separate figures from units. E.g., - -\begin{itemize} - \item 10~GB, not 10GB - \item 2.13~s not 2.13s -\end{itemize} - -Bits, bytes and pieces. Use the following terms and abbreviations for bytes (sometimes it is better to use the full term than the abbreviation). - -Bits:\\ -\begin{tabular}{lll} - kb or Kb& kilobit& 103\\ - Mb& megabit& 106\\ - Gb& gigabit& 109\\ - Tb& terabit& 1012\\ -\end{tabular} - -Bytes:\\ -\begin{tabular}{lll} - kB or KB& kilobyte& 103\\ - MB& megabyte&106\\ - GB &gigabyte &109\\ - TB &terabyte &1012\\ -\end{tabular} - -Number of decimals. When a number is expressed in the scientific notation, the number of significant digits (or significant figures) is the number of digits needed to express the number to within the uncertainty of calculation. For example, if a quantity is known to be 1.234 ± 0.002, four figures would be significant\footnote{\url{http://mathworld.wolfram.com/SignificantDigits.html}}. - -Unless there is a good reason, do not use more than three fractional digits or places (the number of digits following the point). - -Other issues. Avoid overly long sentences. Certain rules suggest that sentence over approximately 20 words become difficult to understand and should therefore be avoided. - -\subsection{\LaTeX\ Style Files} -\label{sec:latex-style-files} - -\newcommand{\macro}[1]{{\tt \textbackslash #1}} - -To use the latex template, copy the contents of this directory and use {\tt template.tex} as the master file of your deliverable (after renaming it as required). The necessary files are: - -\begin{itemize} - \item erigrid2.sty - \item istcover.sty - \item istprog.sty - \item graphics/ - \begin{itemize} - \item erigrid2-coverbkg.pdf - \item erigrid2-logo.pdf - \item erigrid2-partners.pdf - \end{itemize} -\end{itemize} - -Use the following macros to populate the tables on the cover and on page two: - -\begin{itemize} - \item \macro{istChange\{\}\{\}\{\}\{\}}: for setting change log items. The first argument is the date, the second is the deliverable's version number, the third, the author's name, and the fourth the summary of changes made. You may add as many of these commands as you like. They will be stored and added to the table on the second page. - \item \macro{ProjectAcronym\{\}}, \macro{ProjectFullTitle\{\}}, \macro{ProjectRefNo\{\}}: these are pre-set to the obvious values. - \item \macro{delivNumber\{\}}: the deliverable number, Dx.y - \item \macro{delivName\{\}}: deliverable's title, as appears in the DoA - \item \macro{delivShortTile\{\}}: Short Title - \item \macro{delivResponsible\{\}}: partner in charge of the deliverable - \item \macro{delivVersion\{\}}: version as vn.n - \item \macro{ActualDate\{\}}: date of submission - \item \macro{delivDissLevel\{\}}: PU, PP, RE or CO - \item \macro{delivType\{\}}: R = report or O = other - \item \macro{delivWP\{\}}: not used - \item \macro{delivAuthor\{\}}: Lead author(s) - \item \macro{delivFPAuthor\{\}}: Co-author(s) - \item \macro{delivStatus\{\}}: (d)raft, (f)inal, or (s)ubmitted - \item \macro{delivKeywords\{\}}: well... -\end{itemize} - -These declarations must appear before you issue the \macro{makecover} command, at the beginning of the report. - -\subsection{Formatting Bibliographical References} -\label{sec:formatting-bibliographical-references} - -By default, references should use APA style (as, e.g., used in Google Scholar) and be ordered in alphabetic order. See for example \cite{bib:tan2004}, in the list below. - -Other styles are also OK, nevertheless the authors should make sure that within a single document the notation to references and their citation should be consistent. In the text, the references should ideally be referred to by the author name and year, e.g., \cite{bib:lamport1994}; however, referencing by reference number is also acceptable. - -\subsection{Associated Outputs} -\label{sec:associated-outputs} - -\textit{If appropriate, please include a section with details of any datasets, code or other resources being released with this deliverable.} - -The work described in this deliverable has resulted in the following resources: +\subsection{Change Log} +\label{sec:change-log} -\begin{center} - \def\arraystretch{1.25} - \begin{tabular}{|c|c|c|} - \hline - \rowcolor{numpexgray} - \color{white} Description & - \color{white} URL & - \color{white} Availability - \\\hline - - \rowcolor{white}\color{numpexfont} - My Dataset 1 & - \url{http://hdl.handle.net/12345} & - Public (Apache 2.0) \\ - - \rowcolor{numpexlightergray}\color{numpexfont} - My Dataset 2 & - \url{http://hdl.handle.net/54321} & - Private (consortium only) \\ - - \rowcolor{white}\color{numpexfont} - My Code & - \url{github.com/numpex/xxx} & - Public (GPL3) \\ - - \hline - \end{tabular} -\end{center} +The Change Log is there to keep track of the changes made to the document. Whenever changes are made to the document, a new version should be created and the changes should be briefly summarised in the Change Log. We anticipate a minimum of three phases of Change Log entries. (1) The researcher responsible for the given Deliverable enters the changes as he/she develops the document. (2) The two reviewers register the changes made in the quality assurance phase. Once the responsible researcher passes the report on to the Project Coordinator, the status should be changed from ‘draft’ to ‘final’. (3) The Project Coordinator submits the report to the EC, the status should be changed from ‘final’ to ‘submitted’. -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ No newline at end of file +% <-------------------------------------------------- \ No newline at end of file diff --git a/sections/introduction.tex b/sections/introduction.tex index 148d2f6..fdde18c 100644 --- a/sections/introduction.tex +++ b/sections/introduction.tex @@ -1,24 +1,21 @@ %!TEX root = ../deliverable.template.tex -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Introduction -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% --------------------------------------------------> +% Introduction \clearpage \section{Introduction} \label{sec:introduction} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Section content, please change! -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% -------------------------------------------------- +% TO DO +% -------------------------------------------------- -\subsection{Purpose and Scope of the Document} -\label{sec:purpose} +Suggested information for the introduction is: +\begin{itemize} + \item Structure of the delivrable ; + \item Relation with other delivrables and tasks ; + \item Methodology ; + \item Terminology. +\end{itemize} -Briefly describe the purpose and scope of the document (also in accordance with the \ac{DoA}). - -\subsection{Structure of the Document} -\label{sec:structure} - -This document is organised as follows: \Cref{sec:introduction} provides information about the report content whereas \Cref{sec:guidelines} introduces guides for writing \projacronym{} deliverables. The deliverable is concluded in \Cref{sec:conclusions}. Finally, additional information is provided in the \nameref{sec:appendix-a} and \nameref{sec:appendix-b}. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ No newline at end of file +% <-------------------------------------------------- \ No newline at end of file diff --git a/sections/summary.tex b/sections/summary.tex deleted file mode 100644 index 5838fc7..0000000 --- a/sections/summary.tex +++ /dev/null @@ -1,37 +0,0 @@ -%!TEX root = ../deliverable.template.tex -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Executive Summary -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\clearpage -\section*{Executive Summary} -\addcontentsline{toc}{section}{Executive Summary} -\label{sec:summary} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%% Section content, please change! -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -From Wikipedia:\footnote{\url{https://en.wikipedia.org/wiki/Executive_summary}} - -An executive summary, or management summary, is a short document or section of a document, produced for business purposes, that summarises a longer report or proposal or a group of related reports in such a way that readers can rapidly become acquainted with a large body of material without having to read it all. It usually contains a brief statement of the problem or proposal covered in the major document(s), background information, concise analysis and main conclusions. -It is intended as an aid to decision-making by managers and has been described as the most important part of a business plan. - -An executive summary differs from an abstract in that an abstract will usually be shorter and is intended to provide a neutral overview or orientation rather than being a condensed version of the full document. Abstracts are extensively used in academic research where the concept of the executive summary would be meaningless. ``An abstract is a brief summarising statement~\dots read by parties who are trying to decide whether or not to read the main document'', while ``an executive summary, unlike an abstract, is a document in miniature that may be read in place of the longer document''. - -Structure: -\begin{itemize} - \item Be approximately 1-2 pages long - \item Be written in language appropriate for the target audience - \item Consist of short, concise paragraphs - \item Begin with a summary - \item Be written in the same order as the main report - \item Only include material present in the main report - \item Make recommendations - \item Provide a justification - \item Have a conclusion - \item Be readable separately from the main report - \item Sometimes summarise more than one document -\end{itemize} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ No newline at end of file diff --git a/svg-inkscape/logo-cea_svg-tex.pdf b/svg-inkscape/logo-cea_svg-tex.pdf new file mode 100644 index 0000000..4ef6d18 Binary files /dev/null and b/svg-inkscape/logo-cea_svg-tex.pdf differ diff --git a/svg-inkscape/logo-cea_svg-tex.pdf_tex b/svg-inkscape/logo-cea_svg-tex.pdf_tex new file mode 100644 index 0000000..88bd488 --- /dev/null +++ b/svg-inkscape/logo-cea_svg-tex.pdf_tex @@ -0,0 +1,58 @@ +%% Creator: Inkscape 1.1.2 (0a00cf5339, 2022-02-04), www.inkscape.org +%% PDF/EPS/PS + LaTeX output extension by Johan Engelen, 2010 +%% Accompanies image file 'logo-cea_svg-tex.pdf' (pdf, eps, ps) +%% +%% To include the image in your LaTeX document, write +%% \input{.pdf_tex} +%% instead of +%% \includegraphics{.pdf} +%% To scale the image, write +%% \def\svgwidth{} +%% \input{.pdf_tex} +%% instead of +%% \includegraphics[width=]{.pdf} +%% +%% Images with a different path to the parent latex file can +%% be accessed with the `import' package (which may need to be +%% installed) using +%% \usepackage{import} +%% in the preamble, and then including the image with +%% \import{}{.pdf_tex} +%% Alternatively, one can specify +%% \graphicspath{{/}} +%% +%% For more information, please see info/svg-inkscape on CTAN: +%% http://tug.ctan.org/tex-archive/info/svg-inkscape +%% +\begingroup% + \makeatletter% + \providecommand\color[2][]{% + \errmessage{(Inkscape) Color is used for the text in Inkscape, but the package 'color.sty' is not loaded}% + \renewcommand\color[2][]{}% + }% + \providecommand\transparent[1]{% + \errmessage{(Inkscape) Transparency is used (non-zero) for the text in Inkscape, but the package 'transparent.sty' is not loaded}% + \renewcommand\transparent[1]{}% + }% + \providecommand\rotatebox[2]{#2}% + \newcommand*\fsize{\dimexpr\f@size pt\relax}% + \newcommand*\lineheight[1]{\fontsize{\fsize}{#1\fsize}\selectfont}% + \ifx\svgwidth\undefined% + \setlength{\unitlength}{150.03750229bp}% + \ifx\svgscale\undefined% + \relax% + \else% + \setlength{\unitlength}{\unitlength * \real{\svgscale}}% + \fi% + \else% + \setlength{\unitlength}{\svgwidth}% + \fi% + \global\let\svgwidth\undefined% + \global\let\svgscale\undefined% + \makeatother% + \begin{picture}(1,1)% + \lineheight{1}% + \setlength\tabcolsep{0pt}% + \put(0,0){\includegraphics[width=\unitlength,page=1]{logo-cea_svg-tex.pdf}}% + \end{picture}% +\endgroup% diff --git a/svg-inkscape/logo-cnrs_svg-tex.pdf b/svg-inkscape/logo-cnrs_svg-tex.pdf new file mode 100644 index 0000000..6e01149 Binary files /dev/null and b/svg-inkscape/logo-cnrs_svg-tex.pdf differ diff --git a/svg-inkscape/logo-cnrs_svg-tex.pdf_tex b/svg-inkscape/logo-cnrs_svg-tex.pdf_tex new file mode 100644 index 0000000..d202ee1 --- /dev/null +++ b/svg-inkscape/logo-cnrs_svg-tex.pdf_tex @@ -0,0 +1,58 @@ +%% Creator: Inkscape 1.1.2 (0a00cf5339, 2022-02-04), www.inkscape.org +%% PDF/EPS/PS + LaTeX output extension by Johan Engelen, 2010 +%% Accompanies image file 'logo-cnrs_svg-tex.pdf' (pdf, eps, ps) +%% +%% To include the image in your LaTeX document, write +%% \input{.pdf_tex} +%% instead of +%% \includegraphics{.pdf} +%% To scale the image, write +%% \def\svgwidth{} +%% \input{.pdf_tex} +%% instead of +%% \includegraphics[width=]{.pdf} +%% +%% Images with a different path to the parent latex file can +%% be accessed with the `import' package (which may need to be +%% installed) using +%% \usepackage{import} +%% in the preamble, and then including the image with +%% \import{}{.pdf_tex} +%% Alternatively, one can specify +%% \graphicspath{{/}} +%% +%% For more information, please see info/svg-inkscape on CTAN: +%% http://tug.ctan.org/tex-archive/info/svg-inkscape +%% +\begingroup% + \makeatletter% + \providecommand\color[2][]{% + \errmessage{(Inkscape) Color is used for the text in Inkscape, but the package 'color.sty' is not loaded}% + \renewcommand\color[2][]{}% + }% + \providecommand\transparent[1]{% + \errmessage{(Inkscape) Transparency is used (non-zero) for the text in Inkscape, but the package 'transparent.sty' is not loaded}% + \renewcommand\transparent[1]{}% + }% + \providecommand\rotatebox[2]{#2}% + \newcommand*\fsize{\dimexpr\f@size pt\relax}% + \newcommand*\lineheight[1]{\fontsize{\fsize}{#1\fsize}\selectfont}% + \ifx\svgwidth\undefined% + \setlength{\unitlength}{41.55bp}% + \ifx\svgscale\undefined% + \relax% + \else% + \setlength{\unitlength}{\unitlength * \real{\svgscale}}% + \fi% + \else% + \setlength{\unitlength}{\svgwidth}% + \fi% + \global\let\svgwidth\undefined% + \global\let\svgscale\undefined% + \makeatother% + \begin{picture}(1,1)% + \lineheight{1}% + \setlength\tabcolsep{0pt}% + \put(0,0){\includegraphics[width=\unitlength,page=1]{logo-cnrs_svg-tex.pdf}}% + \end{picture}% +\endgroup%