2
0
Fork 0

modif doc_procedure_verification.pdf et de quelques README

This commit is contained in:
troufflard 2015-07-28 16:59:03 +00:00
parent 2f7bffcc26
commit 4140e422c5
7 changed files with 45 additions and 37 deletions

View file

@ -14,7 +14,7 @@ ISOELAS
------------------------------------------------------
But du test
------------------------------------------------------
test simple du mode de calcul :
test simple du mode de calcul : dynamique explicite (DFC)
""
TYPE_DE_CALCUL
dynamique_explicite

View file

@ -14,7 +14,7 @@ ISOELAS
------------------------------------------------------
But du test
------------------------------------------------------
test simple du mode de calcul :
test simple du mode de calcul : dynamique implicite (Newmark)
""
TYPE_DE_CALCUL
dynamique_implicite

View file

@ -15,7 +15,7 @@ relaxation dynamique
------------------------------------------------------
But du test
------------------------------------------------------
test simple du mode de calcul :
test simple du mode de calcul : statique explicite (relaxation dynamique avec amortissement cinetique)
""
TYPE_DE_CALCUL
dynamique_relaxation_dynam

View file

@ -15,7 +15,7 @@ ISOELAS
------------------------------------------------------
But du test
------------------------------------------------------
test simple du mode de calcul :
test simple du mode de calcul : statique implicite
""
TYPE_DE_CALCUL
non_dynamique

View file

@ -481,24 +481,24 @@ utiliser le script \verb|verif_existence_repertoire_test.pl| au niveau du r
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Fichiers obligatoires}\label{section_fichiers_obligatoires}
\begin{itemize}
\item[$\bullet$] \verb|README| :\\
1) La trame du fichier est montrée sur la figure \ref{format_fichier_README}. La syntaxe de l'intitulé des deux rubriques obligatoires (en bleu) doit \^etre strictement respectée. Il est fortement encouragé de renseigner les rubriques \it Auteur \rm et \it Mots-cles\rm. Les autres rubriques sont indiquées à titre de proposition et pour des questions d'harmonie sur la forme d'un test à l'autre. Comme montré sur la figure \ref{format_fichier_README}, chaque titre de rubrique est précédé et suivi d'une ligne d'au moins trois tirets (\verb|---| et plus). Les lignes de tirets doivent \^etre réservées aux titres des rubriques (Ce motif sert à repérer la fin d'une rubrique. L'insertion d'une ligne de tirets dans le corps d'une rubrique mettra en défaut le script de génération automatique du catalogue de tests!!).
\subsubsection*{$\bullet$ \texttt{README} :}
1) La trame du fichier est montrée sur la figure \ref{format_fichier_README}. La syntaxe de l'intitulé des deux rubriques obligatoires (en bleu) doit \^etre strictement respectée. Il est fortement encouragé de renseigner les rubriques \it Auteur \rm et \it Mots-cles\rm. Les autres rubriques sont indiquées à titre de proposition et pour des questions d'harmonie sur la forme d'un test à l'autre. Comme montré sur la figure \ref{format_fichier_README}, chaque titre de rubrique est précédé et suivi d'une ligne d'au moins trois tirets (\verb|---| et plus). Les lignes de tirets doivent \^etre réservées aux titres des rubriques (Ce motif sert à repérer la fin d'une rubrique. L'insertion d'une ligne de tirets dans le corps d'une rubrique mettra en défaut le script de génération automatique du catalogue de tests!!).\\
2) Dans les rubriques obligatoires, il est possible d'insérer des figures gr\^ace à l'utilisation des balises \verb|\figures:|, \verb|\legende:| et \verb|\fin_legende|. Ces figures appara\^itront dans le catalogue de tests. Une figure est constituée de un ou plusieurs fichiers image et d'une légende. Pour déclarer une figure, la ligne doit commencer par la balise \verb|\figures:| suivie du noms des fichiers image (il peut y en avoir plusieurs). Ensuite, sur la m\^eme ligne, on doit trouver la balise de début de légende \verb|\legende:|. La légende est constituée de tout le texte compris entre les balises \verb|\legende:| et \verb|\fin_legende|. A noter que le texte de cette légende peut \^etre écrit sur plusieurs lignes mais ces retours à la ligne ne seront pas pris en compte dans la mise en forme du document pdf. Les formats d'images sont ceux supportés par \verb|pdflatex| et \verb|\includegraphics|, c'est-à-dire typiquement : \verb|.pdf|, \verb|.png| et \verb|.jpg|. Les fichiers image doivent \^etre situés dans le répertoire du test (c'est-à-dire le m\^eme répertoire que le fichier \verb|README|). Concernant les dimensions des images, il faut savoir que le corps du texte du catalogue pdf a une largeur de 17cm et une hauteur de 24cm. Il est donc nécessaire de redimensionner les figures en fonction de ces longueurs car les dimensions de l'image seront utilisées telle quelle pour la génération du catalogue de tests. Par exemple, il est inutile d'insérer deux images à la fois de 9cm de large en espérant qu'elles soient cote à cote. L'idée est que les images ne soient pas trop grosses mais lisibles.\\
Exemples :
\begin{itemize}
\item[\hspace*{0.5cm} $>$ Exemple sur une ligne] :\\
\hspace*{0.2cm} \verb|\figures: maillage.pdf \legende: Aperçu du maillage \fin_legende|
\item[\hspace*{0.5cm} $>$ Exemple multilignes] :\\
\hspace*{0.2cm} \verb|\figures: coupe_SIG11.pdf \legende: Vue en coupe de|\\
\hspace*{0.2cm} \verb|la répartition des contraintes x \fin_legende|
\item[\hspace*{0.5cm} $>$ Exemple multilignes avec plusieurs fichiers image] :\\
\hspace*{0.2cm} \verb|\figures: vue_dessus.png vue_cote.png \legende: Vue de dessus|\\
\hspace*{0.2cm} \verb|(à gauche) et vue de côté (à droite) \fin_legende|\\
\end{itemize}
\item[$\bullet$] \verb|.info| :
Exemples :\\
\hspace*{0.5cm} $>$ Exemple sur une ligne :\\
\hspace*{1.5cm} \verb|\figures: maillage.pdf \legende: Aperçu du maillage \fin_legende|\\
\hspace*{0.5cm} $>$ Exemple multilignes :\\
\hspace*{1.5cm} \verb|\figures: coupe_SIG11.pdf \legende: Vue en coupe de|\\
\hspace*{1.5cm} \verb|la répartition des contraintes x \fin_legende|\\
\hspace*{0.5cm} $>$ Exemple multilignes avec plusieurs fichiers image :\\
\hspace*{1.5cm} \verb|\figures: vue_dessus.png vue_cote.png \legende: Vue de dessus|\\
\hspace*{1.5cm} \verb|(à gauche) et vue de côté (à droite) \fin_legende|
\subsubsection*{$\bullet$ \texttt{.info} :}
\begin{itemize}
\item[] Ce fichier est l'unique fichier d'extension \verb|.info| présent dans le répertoire. Il est obligatoire mais peut \^etre vide (par exemple dans le cas d'un création de fichier \verb|.info| avec l'option Herezh \verb|-n|).\\
Il n'y a pas de restriction majeure sur le contenu de ce fichier mais il est important de noter que dans le cas d'un test avec plusieurs fichiers \verb|.CVisu|, chaque calcul ultérieur au n°1 tentera de faire un \verb|RESTART| du calcul précédent. C'est pourquoi il faut faire attention au paramètre \verb|controle|$\rightarrow$\verb|SAUVEGARDE|. Le paramètre suffisant est :\\
@ -512,19 +512,20 @@ controle
\end{minipage}
Si le calcul utilise un menu interactif, un fichier \verb|.commande| sera nécessaire.\\
\end{itemize}
\item[$\bullet$] \verb|.CVisu|[i] :
\subsubsection*{$\bullet$ \texttt{.CVisu[i]} :}
\begin{itemize}
\item[] La présence de ces fichiers est obligatoire mais ils peuvent \^etre vides à partir du moment où le but du test n'est pas de comparer des résultats Herezh maple ou Gmsh
\end{itemize}
\end{itemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Fichiers facultatifs en rapport avec l'exécution du test}\label{section_fichiers_facultatifs}
\begin{itemize}
%%
\item[$\bullet$] \verb|.precision| :
\subsubsection*{$\bullet$ \texttt{.precision} :}
\begin{itemize}
\item[] Ce fichier permet de modifier les précisions par défaut pour la comparaison des données au format maple pour un certain nombre de colonnes du fichier \verb|.maple|. Par défaut, les précisions sont 1e-6 en absolu, 1e-3 en relatif. Le format du fichier est le suivant :\\
\hspace*{2cm}\begin{minipage}{\textwidth}
@ -561,7 +562,7 @@ Il est possible de modifier les pr
\end{itemize}
%%
\item[$\bullet$] \verb|.commande| :
\subsubsection*{$\bullet$ \texttt{.commande} :}
\begin{itemize}
\item[] Le but de ce fichier est de fournir automatiquement les réponses à un menu interactif. Sa présence équivaut à lancer un calcul Herezh++ de la manière suivante :\\
\hspace*{2cm}\begin{minipage}{\textwidth}
@ -576,9 +577,9 @@ Chaque ligne contient une r
\end{itemize}
%%
\item[$\bullet$] \verb|.verif| :
\subsubsection*{$\bullet$ \texttt{.verif} :}
\begin{itemize}
\item[] Ce fichier est un exécutable dont la fonction est de fournir le résultat de la vérification. Pour cela, il effectue les traitements nécessaires pour déterminer si le test est \verb|OK| ou \verb|ECHEC|. Il indique ce résultat en affichant la ligne suivante :
\item[] Ce fichier est un exécutable dont la fonction est de fournir le résultat de la vérification. Il doit effectuer les traitements nécessaires pour déterminer si le test est \verb|OK| ou \verb|ECHEC|. Le contenu du script est totalement libre mais il doit obligatoirement indiquer le résultat de la vérification en affichant la ligne suivante :
\hspace*{2cm}\begin{minipage}{\textwidth}
\begin{verbatim}
@ -590,17 +591,24 @@ resultat verification : OK (ou ECHEC)
En plus de cette ligne, cet exécutable peut tout à fait afficher d'autres informations à titre facultatif.\\
Il est important de noter que cet exécutable reçoit 2 arguments lorsqu'il est appelé. Le programmeur pourra donc utiliser s'il le souhaite les arguments suivants :
\noindent\rule{0.8\textwidth}{0.5pt}\\
\hspace*{2cm}\begin{minipage}{0.6\textwidth}
\begin{itemize}
\item[\hspace*{0.5cm} argument 1 :] nom de l'exécutable Herezh++ (en chemin absolu)
\item[\hspace*{0.5cm} argument 2 :] nom du fichier de redirection de l'affichage du calcul Herezh++\\
\hspace*{2.4cm} (fichier \verb|.log|)
\item[- argument 1 :] nom de l'exécutable Herezh++ (en chemin absolu)
\item[- argument 2 :] nom du fichier de redirection de l'affichage du calcul Herezh++ (fichier \verb|.log|)
\end{itemize}
\end{minipage}
\noindent\rule{0.8\textwidth}{0.5pt}\\
Cet exécutable peut \^etre programmé dans n'importe quel langage, mais pour éviter les problèmes de compilateur, il est préférable d'éviter les langages nécessitant une compilation (par exemple : C, C++, Fortran, etc...). Il est préférables d'utiliser les langages interprétés (par exemple : sh, zsh, Perl, Python, etc...).\\
\underline{Remarque} : le script \verb|.verif| étant lancé après le calcul, il peut tout à fait servir de moyen détourné pour modifier le fichier \verb|.info| avant le calcul suivant (par exemple, pour tester un mot-clé mais avec divers valeurs de paramètres). Voir exemple section \ref{section_exemple_test_5}.
\end{itemize}
%%
\item[$\bullet$] \verb|.argument| :
\subsubsection*{$\bullet$ \texttt{.argument} :}
\begin{itemize}
\item[] Ce fichier permet de définir librement les arguments donnés à l'exécutable Herezh++. Il peut contenir autant de lignes que nécessaire. Il est important de noter que l'affichage produit par Herezh++ est toujours redirigé dans un fichier \verb|.log| avec la commande \verb|tee|. Il est donc inutile voire bloquant de rajouter une redirection supplémentaire parmi les arguments. Au final, pour un fichier contenant N lignes, la commande Herezh++ lancée sera :\\
\hspace*{2cm}\begin{minipage}{\textwidth}
@ -613,19 +621,18 @@ HZppfast ligne_1 ligne_2 ... ligne_N | tee nom_calcul.log
\end{itemize}
%%
\item[$\bullet$] \verb|.maple.ref| :
\subsubsection*{$\bullet$ \texttt{.maple.ref} :}
\begin{itemize}
\item[] Ce fichier est utile pour la comparaison de données au format maple. Le nombre de colonnes de ce fichier doit \^etre en accord avec le fichier \verb|.maple| produit par la lecture du \verb|.CVisu| associé. Il peut contenir un nombre quelconque de lignes de données mais seule la dernière sera utilisée pour la comparaison de \verb|.maple| explicitée à la section \ref{subsubsection_verification}.
\end{itemize}
\end{itemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Exemples de tests}\label{section_exemples_tests}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Calcul classique : comparaison de données maple}
\subsubsection{Calcul classique : comparaison de données maple}\label{section_exemple_test_1}
Il s'agit du cas le plus courant consistant à réaliser des calculs générant des données au format maple à comparer avec les données contenues dans un fichier \verb|.maple.ref|. Les fichiers \verb|.CVisu|[i] définissent des sorties au format maple. Le calcul n°[i] utilise le fichier \verb|.CVisu|[i] pour générer un fichier \verb|.maple| qui sera comparé au fichier \verb|.maple.ref|[i] qui doit contenir exactement le m\^eme nombre de colonnes que le fichier \verb|.maple|.\\
@ -640,19 +647,19 @@ Le fichier \verb|.info| doit g
Le test \verb|Batterie/FONCTION_UNIQUE/TYPE_DE_CALCUL/Test_R_non_dynamique| est un exemple de calcul classique utilisant les précisions par défaut pour la comparaison des données.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Calcul utilisant un fichier de commandes interactives}
\subsubsection{Calcul utilisant un fichier de commandes interactives}\label{section_exemple_test_2}
Le test \verb|Batterie/FONCTION_UNIQUE/UTILITAIRES/Test_R_fusion-maillage| est un exemple de calcul utilisant un fichier de commandes interactives (réponses au menu interactif de l'utilitaire "\verb|avec plus fusion_maillages|"). Ce fichier spécial est le fichier d'extension \verb|.commande1|.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Calcul utilisant un script libre de vérification}
\subsubsection{Calcul utilisant un script libre de vérification}\label{section_exemple_test_3}
Le test \verb|Batterie/FONCTION_UNIQUE/UTILITAIRES/Test_R_suppression-noeuds-non| \verb|-references| est un exemple de calcul utilisant un script de vérification (comparaison entre deux fichiers \verb|.her|). Ce fichier spécial est le fichier d'extension \verb|.verif1|.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Calcul consistant à créer un fichier .info (Herezh -n)}
\subsubsection{Calcul consistant à créer un fichier .info (Herezh -n)}\label{section_exemple_test_4}
Le script \verb|Perl/test.pl| lance un calcul Herezh++ avec l'option \verb|-n| si le fichier \verb|.info| ne contient pas le mot-clé \verb|dimension|. Pour cela, on crée simplement un fichier \verb|.info| vide. Un fichier \verb|.commande| sera forcément nécessaire pour répondre au menu interactif de création.
@ -678,7 +685,8 @@ L'arborescence pour ce genre de test devrait avoir la forme suivante :\\
\end{minipage}
\subsubsection{Exemple avancé sur l'utilisation d'un \texttt{.verif} pour un test multiparamètres}\label{section_exemple_test_5}
**** en cours d'écriture ***
%%
\clearpage

Binary file not shown.

Binary file not shown.