Skip to content

Commit

Permalink
Add coments on report V0 #23
Browse files Browse the repository at this point in the history
  • Loading branch information
JavierCladellas committed Mar 25, 2024
1 parent 96387a3 commit 2aac5e3
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions project/report/v0/report-benchmarking.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
\usepackage{csquotes}
\usepackage{hyperref}
\usepackage{graphicx}
\usepackage{xcolor}

\usepackage{tocloft}
\renewcommand{\cftsecleader}{\cftdotfill{\cftdotsep}}
Expand Down Expand Up @@ -43,7 +44,16 @@ \section{Introduction}
As launching tests on supercomputers isn't always easy because of their availability and costs, there is a real need to store the results.
It is exactly what the \textit{Dashboard Performances} project is about: providing a clear and easy to use interface between tests and results.
This interface is already available at \url{https://feelpp.github.io/benchmarking/benchmarking/index.html}.

\textcolor{red}{
Tu pourrais ajouter une ligne pour dire que les tests de regression
sont non seulement pour la performance du calcul parallel,
mais aussi par rapport à la précision des résultats
(pour s'assurer que n'importe quel developpement fait ne dégrade
pas la qualité des résultats ).
Aussi du fait qu'il y a un besoin de connaître, et enregistrer, l'historique des tests.
Ceci dans le but de faire une analyse de données prenant en compte toute sorte d'aggrégations
(temporelles, par machine, par application, etc.)
}

\section{Tools description}

Expand All @@ -54,8 +64,11 @@ \section{Tools description}

For reporting the results, we will use \textit{Antora}\cite*{Antora}. Antora gives the opportunity to publish documentation on the web.
The documentation needs to be written in \textit{AsciiDoc}. Once it's done, \textit{AsciiDoctor} will handle the conversion to \textit{html}
for responsiveness.
In this way, it also call python functions and print their output, graphs for example, like you would do it in a notebook.
for responsiveness \textcolor{red}{ (and browser compatibility) }.
In this way, it also call python functions and print their output, graphs for example, like you would do it in a notebook. \textcolor{red}{(, enabling having dynamic content in the documentation.)}
\textcolor{red}{
Tu pourrais aussi ajouter Plotly dans les outils utilisés.
}

\newpage
\section{Objectives}
Expand All @@ -70,6 +83,11 @@ \section{Objectives}
within the created Report python class. Then, it should automatically create an AsciiDoc file which will be used from Antora
for the deployment on the website.

\textcolor{red}{
Attention: ReFrame génére des JSON, ensuite template.adoc.j2 est utilisé dans render.py pour produire le fichier .adoc.
La classe Report sert à traiter le JSON et contient des méthodes pour produire des figures. Je ne suis pas sûr d'avoir compris la même chose dans le dernier paragraphe.
}

%A first objective would be to work on a first test case and getting all the necessary files ready for publishing
%In a first phase, we will only focus on heat problems.
% A further goal would be to create a whole database
Expand Down

0 comments on commit 2aac5e3

Please sign in to comment.