mveril/QUESTDB
1
1
Fork 0
forked from PTEROSOR/QUESTDB
Code Issues Pull Requests Releases Wiki Activity

Add scenar and intro to tools

Browse Source
This commit is contained in:
Mickaël Véril 2020-11-18 09:28:41 +01:00
parent 5ae30a6136
commit 2893edc82c
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -22,6 +22,7 @@
*latexmk *latexmk
*.run.xml *.run.xml
*-blx.bib *-blx.bib
*.thm
# pdf output # pdf output
QUEST_WIREs.pdf QUEST_WIREs.pdf

26
Manuscript/QUEST_WIREs.tex
View File

@ -15,7 +15,7 @@
% \documentclass[blind,alpha-refs]{wiley-article} % \documentclass[blind,alpha-refs]{wiley-article}
% Add additional packages here if required % Add additional packages here if required
\usepackage{graphicx,dcolumn,bm,xcolor,microtype,multirow,amscd,amsmath,amssymb,amsfonts,physics,longtable,mhchem,siunitx,rotating} \usepackage{graphicx,dcolumn,bm,xcolor,microtype,multirow,amscd,amsmath,amssymb,amsfonts,physics,longtable,mhchem,siunitx,rotating,ntheorem}
\usepackage[ \usepackage[
colorlinks=true, colorlinks=true,
@ -736,6 +736,28 @@ The website specification are the following
\item Display a box plot graph to easily show the methods accuracy \item Display a box plot graph to easily show the methods accuracy
\end{itemize} \end{itemize}
This solve the issues described at \ref{sec:websiteIntro} This solve the issues described at \ref{sec:websiteIntro}
%=======================
\subsection{Usage}
%=======================
We built the website to meet mainly two useage.
\theoremstyle{break}
\theorembodyfont{\normalfont}
\newtheorem{scenar}{Scenario}{}
\begin{scenar}
\label{scenar:choose}
The user wants to choose a method for his calculation or a series of calculations.
In this case he wants to compare the accuracy of each method with a subset of excitations data corresponding to his target.
He can optimise the filter to correspond to his target (Molecular size, molecule or excitation type).
If it's possible he can only select the target molecule when this molecule is available in the QUEST data.
\end{scenar}
\begin{scenar}
\label{scenar:new}
The user has created a new method and want to compare it with the methods of the QUEST project.
Fistly the user must create an input file for the Python tools \ref{sec:gentools} by formating the calculated results as a {\LaTeX} \texttt{tabular}.
After the data generation using the same python tools we are used to import the QUEST data, the user must to import the new absorption and the fluorescence data files using the button on the website.
So the new data are used in the same way than the references data to generate statistics and he can use the website to compute the statistics to compare the methods.
\end{scenar}
%======================= %=======================
\subsection{Project} \subsection{Project}
%======================= %=======================
@ -781,6 +803,8 @@ On the website the statistics are forwarded in a table and in a box plot graph.
\subsubsection{Data generation tools} \subsubsection{Data generation tools}
\label{sec:gentools} \label{sec:gentools}
%------------------------------------------------ %------------------------------------------------
There are multiple that we used to generate the data.
These tools can also be used by the user (see scenario \ref{scenar:new})
There are currently two main tools to generate data \texttt{datafileBuilder} and \texttt{ADC25generator} There are currently two main tools to generate data \texttt{datafileBuilder} and \texttt{ADC25generator}
\paragraph{datafileBuilder} \paragraph{datafileBuilder}
The \texttt{datafileBuilder} tool is used to build datafile from {\LaTeX} \texttt{tabular}. The \texttt{datafileBuilder} tool is used to build datafile from {\LaTeX} \texttt{tabular}.