1
0
mirror of https://github.com/TREX-CoE/fparser.git synced 2024-11-03 20:54:11 +01:00

Initial commit

This commit is contained in:
Ravindra Shinde 2021-02-08 08:13:43 +01:00
commit c3e469ff5e
15 changed files with 694 additions and 0 deletions

10
.gitignore vendored Normal file
View File

@ -0,0 +1,10 @@
\#*\#
*.aux
*.glo
*.idx
*.lof
*.log
*.lot
*.out
*.toc
auto/

70
01-title.tex Normal file
View File

@ -0,0 +1,70 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Title Page
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagestyle{empty}
\begin{center}
\phantom{} \\ \vspace{2cm}
\includegraphics[width=0.6\textwidth]{images/trex-logo.png}
\vspace{2cm}
{\Huge \DelNumber{} -- \DelTitle}\\\vspace{1cm}
{Version \DelVersion}
\vspace*{\fill}
{\Huge {GA no 952165}}
\vspace{1cm}
\end{center}
\noindent
Dissemination Level\\[5mm]
\newcommand{\Dissemination}{PU} % TODO <------
\begin{tabular*} {\textwidth}{rl}
$\boxtimes$ & PU: Public \\ % TODO <------
$\Box$ & PP: Restricted to other programme participants (including the Commission) \\
$\Box$ & RE: Restricted to a group specified by the consortium (including the Commission) \\
$\Box$ & CO: Confidential, only for members of the consortium (including the Commission)
\end{tabular*} \\
\clearpage
\pagestyle{fancy}
\fancyhf{}
\rhead{Overleaf}
\lhead{Guides and tutorials}
\renewcommand{\footrulewidth}{1pt}
\lhead{ \includegraphics[width=1in]{images/trex-logo.png} }
\rhead{ \DelNumber -- \DelTitle }
\lfoot{
%\setlength{\tabcolsep}{0.3em}
\begin{tabular*}{0.9\textwidth}{l @{\extracolsep{\fill}}l}
\begin{tabular}{c}
\includegraphics[width=0.1\textwidth]{images/EU_flag.png} \\
\end{tabular}
&
\begin{tabular}{p{0.75\textwidth}}
\footnotesize
TREX: Targeting Real Chemical Accuracy at the Exascale project has received
funding from the European Union Horizon 2020 research and innovation program
under Grant Agreement No. 952165.
\end{tabular}
\end{tabular*}
}
\rfoot{ \thepage\ of \pageref{LastPage}}

61
02-info.tex Normal file
View File

@ -0,0 +1,61 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Second Page
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Document Information}
\renewcommand{\arraystretch}{1.5}
\begin{tabular*}{\textwidth}{l p{12cm}}
Project Title & Targeting Real Chemical accuracy at the EXascale \\
Project Acronym & TREX \\
Grant Agreement No & 952165 \\
Instrument & Call: H2020-INFRAEDI-2019-1 \\
Topic & INFRAEDI-05-2020 Centres of Excellence in EXascale computing \\
Start Date of Project & 01-10-2020 \\
Duration of Project & 36 Months \\
Project Website & \url{https://trex-coe.eu/} \\
& \\
Deliverable Number & \DelNumber \\
Deliverable title & \DelNumber{} -- \DelTitle, as seen in GA \\
Due Date & \DueDate (from GA) \\
Actual Submission Date & \SubDate \\
& \\
Work Package & WP\WorkPackage{} -- \WorkPackageTitle \\
Lead Author (Org) & \LeadAuthor \\
Contributing Author(s) (Org) & \Contributors \\
Reviewers (Org) & \Reviewers \\
Version & \DelVersion \\
& \\
Dissemination level & \Dissemination \\
Nature & Report \\
Draft / final & \DraftOrFinal \\
No. of pages including cover & \pageref{LastPage} \\
\end{tabular*}
\clearpage
\section*{Disclaimer}
\setlength{\tabcolsep}{0.3em}
\begin{tabular*}{\textwidth}{l @{\extracolsep{\fill}}l}
\begin{tabular}{c}
\includegraphics[width=0.15\textwidth]{images/EU_flag.png} \\
\end{tabular}
&
\begin{tabular}{p{0.8\textwidth}}
TREX: Targeting Real Chemical Accuracy at the Exascale project has received
funding from the European Union Horizon 2020 research and innovation program
under Grant Agreement No. 952165.
\end{tabular}
\end{tabular*}
\noindent The content of this document does not represent the opinion of the European
Union, and the European Union is not responsible for any use that might be made
of such content.
\clearpage

34
03-versioning.tex Normal file
View File

@ -0,0 +1,34 @@
\section*{Versioning and contribution history}
\begin{tabular*}{\textwidth}{|l|@{\extracolsep{\fill}}l|p{2.2in}|p{2.2in}|}
\hline
Version & Date & Authors & Notes \\
\hline
% Version
0.5
&
% Date
DD.MM.YYYY
&
% Contributor
Contributor (Institution)
&
% Description
Description
\\
\hline
% Version
0.6
&
% Date
DD.MM.YYYY
&
% Contributor
Contributor (Institution)
&
% Description
Description
\\
\hline
\end{tabular*}
\clearpage

64
04-abbreviations.tex Normal file
View File

@ -0,0 +1,64 @@
%% COMMANDS
%%
%% \acresetall flushes the memory of the macro \ac (ie all "used" marks flushed)
%%
%% \ac{label} singular (first time Full Name + (ACRO) and mark as used)
%% \acp{label} plural (as \ac but makes short and/or long forms into plurals)
%%
%% \acs{lable} short (ACRO)
%% \acf{lable} “full acronym” (Full Name + (ACRO))
%% \acl{lable} long (_without_ ACRO)
%%
%% \acsp{label} short plural (ACROs)
%% \acfp{label} “full acronym” plural (Full Names + (ACROs))
%% \aclp{label} long plural (_without_ ACRO)
%%
%% \acrodef{label}[acronym]{written out form} definition
%% for example \acrodef{etacar}[$\eta$ Car]{Eta Carinae},
%% with the restriction that the label should be simple ASCII
%% PACKAGE & OPTIONS
%% acronym package must be loaded (in the preamble):
%% \usepackage[option1,option2,etc.]{acronym}
%% OPTIONS:
%% footnote The option footnote makes the full name appear as a
%% footnote.
%% nohyperlinks If hyperref is loaded, all acronyms will link to their
%% glossary entry. With the option nohyperlinks these
%% linkscan be suppressed.
%% printonlyused Only list used acronyms
%% withpage In printonlyused-mode show the page number where
%% each acronym was first used.
%% smaller Make the acronym appear smaller.
%% dua The option dua stands for “dont use acronyms”. It
%% leads to a redefinition of \ac and \acp, making the
%% full name appear all the time and suppressing all
%% acronyms but the explicity requested by \acf or \acfp.
%% nolist The option nolist stands for “dont write the list of
%% acronyms”.
%% INCLUSION
%%
\section*{Abbreviations}
\label{sec:abbrev}
\begin{acronym}[TRUST-IT] %width of the longest acronym should be matched here
\acro{UT}{Universiteit Twente}
\acro{CNRS}{Centre National de la Recherche Scientifique}
\acro{SISSA}{Scuola Internazionale Superiore di Studi Avanzati di trieste}
\acro{CINECA}{Consorzio Interuniversitario del Nord Est italiano per il Calcolo Automatico}
\acro{FZJ}{Forschungszentrum Jülich GmbH}
\acro{MPG}{Max Planck Gesellschaft zur forderung der wissenschaften}
\acro{UVSQ}{Université de Versailles Saint-Quentin-en-yvelines}
\acro{Megware}{Megware computer vertrieb und service GmbH}
\acro{STUBA}{Slovenská technická univerzita v Bratislave}
\acro{UNIVIE}{Universität Wien}
\acro{TUL}{Politechnika Łódzka}
\acro{TRUST-IT}{TRUST-IT SRL}
\end{acronym}
\clearpage

9
05-content.tex Normal file
View File

@ -0,0 +1,9 @@
\section{Introduction}
This repository contains the \Latex template for TREX reports.
To use it, you should first create a
\section{Example}
I am testing the acronyms of \ac{TUL} and \ac{CNRS}.

121
LICENSE Normal file
View File

@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

20
Makefile Normal file
View File

@ -0,0 +1,20 @@
WP=2
NUMBER=1
TITLE=main
NAME=D$(WP).$(NUMBER)-$(TITLE)
TEX=$(NAME).tex
PDF=$(NAME).pdf
default: $(TEX) references.bib
pdflatex $(TEX)
pdflatex $(TEX)
bibtex $(TEX)
pdflatex $(TEX)
create:
@test -f $(TEX) && \
echo "File $(TEX) already exists" ||\
cp main.tex $(TEX)

123
README.org Normal file
View File

@ -0,0 +1,123 @@
#+TITLE: TREX Reports latex template
* Installation
To use this template, create a new GitHub repository by using this one
as a template.
#+begin_important
Make sure that both the /draft/ and /final/ branches are imported by checking
the box when you create your repository.
#+end_important
In your new repository, start working on the /draft/ branch. When you submit
the pdf for review, create a pull request to the /final/ branch from
the /draft/ branch.
The reviewers can then use the GitHub code-review system to make
reviews of the document. When all the reviews are accepted, the pull
request is accepted to the /final/ branch.
#+begin_important
When the versions of the file are changed, be sure that you create a
git tag accordingly.
#+end_important
** List of required LaTex Packages
- lastpage
- graphicx
- fancyhdr
- amsmath
- amssymb
- titlesec
- colortbl
- acronym
- tocloft
- hyperref
- xcolor
- xparse
* Manual
** Initialization
Edit the ~Makefile~ and provide:
- the Work Package (~WP~) number
- the ~NUMBER~ of the deliverable
- a ~TITLE~
Create the main file with the adapted name:
#+BEGIN_SRC sh
make create
#+END_SRC sh
This will create a file named =D$(WP).$(NUMBER)-$(TITLE).tex=,
which will be the main \LaTeX file.
Now, you can compile the example provided using
#+BEGIN_SRC sh
make
#+END_SRC sh
The output =pdf= file will contain a starting example of the report.
** Meta-data
Open the main =tex= file (=D$(WP).$(NUMBER)-$(TITLE).tex=), and
fill in the macros in the prepared block. This information will be
re-used in multiple places in the document.
** Title Page
Search for the string ~TODO~ in the =01-title.tex= file.
You will need to change the ~\Dissemination~ macro according to the
chosen dissemination level. Default is /PU/.
You will also need to check the appropriate box of the front page.
Use ~$\boxtimes$~ for the checked box and ~$\Box$~ for the empty boxes.
** The main document
The main text of your report will be written in the
=05-content.tex= file.
The references can be handled with bibtex in the =references.bib=
file.
The appendices should be written in the =appendix.tex= file.
The images and figures should be put in the =images= directory.
** Versioning
When the version changes, please create a git tag associated with
the commit containing the change.
** Abbreviations
Every time you use an abbreviation, don't do it inline in the
text. We use the [[http://mirrors.ctan.org/macros/latex/contrib/acronym/acronym.pdf][acronym]] \LaTeX package which allows to define the
acronym the 1st time it occurs in the text, and to create
automatically a list of acronyms, keeping only the ones that were
used in the text.
To add a new acronym, add it in the =04-abbreviations.tex=
file. For example:
#+begin_src latex
\acro{QMC}{Quantum Monte Carlo}
#+end_src
and to use it in the text, use the =\ac= macro, for example
#+begin_src latex
Thanks to the \ac{TREX} \ac{CoE}, \ac{QMC} methods will produce amazing results.
#+end_src

110
TREX.cls Normal file
View File

@ -0,0 +1,110 @@
\ProvidesClass{TREX}
\LoadClass[a4paper,twoside,final,12pt]{article}
\usepackage[paper=a4paper,
top=1.18in,bottom=1in,right=0.75in,left=0.75in]{geometry}% http://ctan.org/pkg/geometry
\usepackage[utf8]{inputenc}
\usepackage{lastpage}
\usepackage{graphicx}
\usepackage{fancyhdr}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{titlesec}
\usepackage{colortbl}
\renewcommand{\familydefault}{\sfdefault}
\usepackage[printonlyused,nohyperlinks]{acronym}
\usepackage[pdftex, pdfusetitle, hyperfigures, hyperindex,
bookmarksnumbered,colorlinks, bookmarks, breaklinks,
linktocpage, citecolor=blue, urlcolor=blue, linkcolor=black]{hyperref}
\usepackage[titles]{tocloft}
\renewcommand{\contentsname}{Table of Contents}
\renewcommand{\cftsecfont}{\normalfont}% titles in bold
\renewcommand{\cftsecpagefont}{\normalfont}% page numbers in bold
\renewcommand{\cftdotsep}{1}
\renewcommand{\cftsecleader}{\cftdotfill{\cftsecdotsep}}% dot leaders in bold
\renewcommand{\cftsecdotsep}{\cftdotsep}
\setlength{\headheight}{1cm}
\setlength{\footskip}{2cm}
\addtolength{\textheight}{-\footskip}
%%--Set the section number depth.
\setcounter{secnumdepth}{3}
\setcounter{tocdepth}{4}
\setcounter{page}{2}
\bibliographystyle{IEEEtran}
\sloppy
%%-----------------------------------------------
%%-- Float related environments and commands.
%%-----------------------------------------------
%%--Modify behavior of the figure and table environment.
\def\fps@figure{hbt}
\def\fnum@figure{\textbf{\figurename~\thefigure}}
\def\fps@table{htb}
\def\fnum@table{\textbf{\tablename~\thetable}}
\def\mathfigure{\thesisfiguretrue\figure}
\def\endmathfigure{\endfigure\thesisfigurefalse}
% --------------------------------------------
% Headers
% --------------------------------------------
\pagestyle{fancyplain}
\renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}}
\usepackage{xcolor}
\definecolor{myblue}{HTML}{2F5496}
\titleformat{\section}
{\color{myblue}\normalfont\Large}
{\color{myblue}\thesection}{1em}{}
\makeatletter
\makeindex
\makeglossary
\setcounter{tocdepth}{4}
\setcounter{secnumdepth}{1}
% Table of contents with section*
\usepackage{xparse}
\let\oldsection\section
\makeatletter
\newcounter{@secnumdepth}
\RenewDocumentCommand{\section}{s o m}{%
\IfBooleanTF{#1}
{\setcounter{@secnumdepth}{\value{secnumdepth}}% Store secnumdepth
\setcounter{secnumdepth}{0}% Print only up to \chapter numbers
\oldsection{#3}% \section*
\setcounter{secnumdepth}{\value{@secnumdepth}}}% Restore secnumdepth
{\IfValueTF{#2}% \section
{\oldsection[#2]{#3}}% \section[.]{..}
{\oldsection{#3}}}% \section{..}
}
\makeatother
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Floating figures
\renewcommand\floatpagefraction{.9}
\renewcommand\topfraction{.9}
\renewcommand\bottomfraction{.9}
\renewcommand\textfraction{.1}
\setcounter{totalnumber}{50}
\setcounter{topnumber}{50}
\setcounter{bottomnumber}{50}
\endinput

0
appendix.tex Normal file
View File

BIN
images/EU_flag.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

BIN
images/trex-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

72
main.tex Normal file
View File

@ -0,0 +1,72 @@
\documentclass{TREX}
%------
% TODO : Fill in this information
% Work package number
\newcommand{\WorkPackage}{2}
% Work package title
\newcommand{\WorkPackageTitle}{Code modularization and interfacing} % 2
% Deliverable number
\newcommand{\DelID}{1}
% Title of the Deliverable
\newcommand{\DelTitle}{Title of this deliverable}
% Due date
\newcommand{\DueDate}{M06 -- 31-03-2021 (from GA)}
% Actual submission date
\newcommand{\SubDate}{21-12-2020}
% Main author (Leader)
\newcommand{\LeadAuthor}{Author (Institution)}
% Contributing authors
\newcommand{\Contributors}{Contributor (Institution), Contributor (Institution)}
% Reviewers
\newcommand{\Reviewers}{Reviewer (Institution), Reviewer (Institution)}
% Deliverable version
\newcommand{\DelVersion}{X.0}
% Draft or final version?
\newcommand{\DraftOrFinal}{Draft}
%------
\newcommand{\DelNumber}{D\WorkPackage.\DelID}
\title{\DelNumber{} -- \DelTitle}
\author{\LeadAuthor}
\begin{document}
\input{01-title}
\input{02-info}
\input{03-versioning}
\input{04-abbreviations}
\tableofcontents
\clearpage
\listoffigures
\clearpage
\listoftables
\clearpage
\input{05-content}
\bibliography{references}
\appendix
\input{appendix.tex}
\end{document}

0
references.bib Normal file
View File