Differences

This shows you the differences between two versions of the page.

--- doc:user:tutorials:premiertest [2014/05/07 16:30] – [Metafor en ligne de commande] boman
+++ doc:user:tutorials:premiertest [2016/07/11 15:04] (current) – [Making a film with the results] boemer
@@ Line 1: / Line 1: @@
-====== Interface graphique (GUI) ======
+~~NOTOC~~
+====== How to run an existing test? ======
-===== Introduction =====
-Pour lancer Metafor, plusieurs possibilités sont offertes:
+===== Preliminary remarks =====
-    * Soit double-cliquer sur l'icône du programme (Vivement conseillé). A ce moment, l'interface graphique apparaît et la plupart des commandes peuvent s'effectuer à la souris.
+<note important>Unlike most programs, Metafor must be restarted (which means closing and re-opening the application) before running any simulation.</note>
-    * Soit ouvrir une fenêtre DOS (Menu démarrer - Exécuter - commande : ''cmd'') ou shell Unix. Aller dans le répertoire de Metafor (''cd c:\Progra~1\Metafor'' par exemple) et lancer Metafor (''Metafor''). Il est alors possible de lancer metafor en mode "texte" sans interface graphique par la commande "metafor.exe -nogui". Un autre intérêt est que la fenêtre reste ouverte lors d'un plantage critique de Metafor ("Ce programme a effectué une opération non conforme..."). Pour quitter Metafor mode "texte", sous Windows, utilisez ''CTRL-BREAK'' (c'est brutal, mais bon) ou ''CTRL-Z'' suivi de ''Enter'' sous Windows ou encore ''CTRL-D'' sous Unix.
-Lorsqu'une erreur se produit dans la lecture d'un module, il est TOUJOURS nécessaire de relancer Metafor. La mise au point d'un test Metafor se fait donc le plus souvent à coup de double clics sur l'icône et rappel de la dernière commande (flèche vers le haut).
-Lorsque le jeu de données ne se trouve pas dans le même répertoire que Metafor (ni un de ses sous-répertoires) et qu'on travaille en mode "console", il est conseillé de définir la variable d'environnement ''PATH'' (Sous windows: Bouton droit sur "poste de travail" - propriétés - onglet "avancé" - "variables d'environnement") et spécifier le chemin vers le répertoire de Metafor (''c:\Progra~1\Metafor'' par exemple). Ceci permet de lancer Metafor sans spécifier le chemin complet.
+===== Running a test with the GUI  =====
+==== Description of the main window ====
+Double-click the "Run Metafor" icon on your desktop. The GUI is displayed:
-===== Lancer un test avec la GUI =====
-==== Description de l'interface ====
-Pour vérifier que tout fonctionne correctement, il est utile de lancer un premier test avec l'interface graphique.
-Double-cliquez sur l'icone "Run Metafor" de votre bureau. L'interface s'ouvre:
 {{ doc:user:desc-gui.png |}}
-  - La barre de titre. Elle contient le numéro de version de votre exécutable Metafor.
+  - The title bar. It contains the version number of your Metafor executable.
-  - La barre de menu. Utile pour gérer les options de l'interface (menu File/GUI Options) et les fenêtres 3D de visualisation actives (menu Windows).
+  - The menu bar. It is useful for managing interface options (File menu / GUI Options) and 3D active display windows (Windows menu).
-  - La barre d'outil. Rassemble les commandes les plus utilisées telles que le bouton "meta()" (bouton PLAY bleu) qui lance une intégration Metafor.
+  - The toolbar. It gathers the most commonly used commands, such as the ''meta()'' button (blue PLAY button) which initiates a Metafor calculation.
-  - La ligne de commande python: permet d'entrer des commandes Metafor à la main ou d'utiliser Metafor comme simple interpréteur python.
+  - The python command line: it allows the user to enter Metafor commands by hand or to use Metafor as a simple python interpreter.
-  - La fenêtre d'historique de commandes: permet un accès rapide aux dernières commandes. Un menu contextuel permet de gérer l'historique.
+  - The history command window: quick access to copy/paste older commands. A contextual menu allows the user to manage the history.
-  - la fenêtre de sortie python. Un menu contextuel permet de l'imprimer ou régler différentes options de mise en page.
+  - The output python window, which displays the text output of the program.
-  - Le "python path": liste l'ensemble des modules python accessibles et qui peuvent être importés.
+  - The "Python PATH", which lists all available python modules that can be imported.
-  - La "base": répertoire de base de Metafor. Il peut être changé pour ajouter un nouveau répertoire au "python path". Ceci est très utile pour exécuter un test se trouvant dans un chemin non standard (sur un autre disque par exemple).
+  - The "base" folder, which is the current folder at startup. It can be changed to a new folder which will be added to the "Python PATH". This is very useful to run a test located on a non-standard path (e.g. on another hard disk partition).
-  - Les liens: regroupe les derniers modules chargés pour un accès plus rapide.
+  - The links. This widget gathers the last loaded modules for faster access.
-  - Le "workspace": visualise le repertoire courant (espace de travail). Cet onglet permet, par exemple, d'aller rechercher des résultats dans un endroit non standard.
+  - The "workspace". This is the place where the results of a calculation are written to disk.
+==== Loading a Module ====
+{{ doc:user:loadmodule.png|}}
+A test case of Metafor corresponds to usually one python module.
+Therefore, the first step usually consists in loading this module into memory. This operation tells the program that you wish to work with this file, whether for running an integration or viewing results.
-==== Charger un module ====
+To load a module with the GUI, just find it in the "Python PATH" tree. then right-click on it and choose "Load".
-{{ doc:user:loadmodule.png|}}
-Dans Metafor, chaque cas-test correspond à un module python.
-La première étape dans Metafor est généralement le "chargement" d'un module avec la commande "''load()''". Cette commande va dire au programme qu'on veut travailler avec ce fichier pour, plus tard, lancer une intégration ou visualiser des résultats.
-Dans l'interface graphique, il suffit d'aller chercher le module dans l'arborescence du "Python Path", de faire clic-droit et de choisir "Load" dans le menu contextuel qui apparait.
-Autre possibilité: utiliser la commande
+Alternatively, use the command
   load('apps.ale.angleReZoner')
-dans la ligne de commande python (si le module est ''apps/ale/angleReZoner.py'')
+in the python command line. This command loads the module ''angleReZoner.py'', located in ''c:\Program Files\Metafor\apps\ale''.
-Cette commande "importe" le module et garde un pointeur sur lui pour les futures commandes.
+Metafor "imports" the module and keeps a pointer to it for subsequent commands. The interface on the right switches from "Python PATH" view to "Workspace" view. In this view, a working directory (in which the results of the simulation will be stored) can be chosen. By default, its name is ''workspace/module_name''. If it already exists, this directory is selected by the interface. If not, it will be created before the beginning of the time integration.
-L'interface passe aussi en mode "Workspace" (au lieu du "Python Path"). Dans cette vue, il est possible de choisir un répertoire de travail où sont/seront stockés les résultats de l'intégration. Par défaut, le répertoire est ''workspace/nom_du_module''. Si ce répertoire existe déjà, l'interface choisit ce répertoire, sinon, il sera créé lors du démarrage de l'intégration.
-En ligne de commande, on peut utiliser la commande ''setDir()''.
+If the module to be loaded is not in the "Python PATH", a ''rebase'' must be performed. To do so, the directory which contains the test case is chosen using the button on the "Base" line of the "Python Path" tab. Doing so, this directory is added to the "Python path". It is equivalent to starting Metafor from this directory.
-  setDir(r'e:\resultats\angleReZoner')
+==== Starting the time integration ====
-Si le module que l'on veut charger ne se trouve pas dans le "Python Path", il est nécessaire d'effectuer un ''rebase''. Pour ce faire, on choisit le répertoire contenant le cas-test grâce au bouton sur la ligne "Base:" de l'onglet "Python Path". Ce répertoire est automatiquement ajouté au python path. Cette manipulation est identique à lancer Metafor à partir de ce répertoire. En ligne de commande, on peut aussi écrire:
+Click on the blue "PLAY" button in the toolbar. You can also type the command:
-  rebase(r'e:\cas-tests\test01')
-==== Lancer une intégration ====
-Lancer une intégration est très simple: il suffit de cliquer sur le bouton "PLAY" bleu dans la barre d'outil. On peut aussi utiliser la commande:
   meta()
-Cette commande va appeler la fonction ''getMetafor()'' du module précédemment chargé et va lancer l'intégration. Si l'utilisateur n'a pas choisi de répertoire de travail, le nom par défaut est utilisé (''workspace/nom_du_test''). Si ce répertoire est non vide, il sera tout d'abord vidé (une fenêtre apparait le signalant).
+This command calls the function ''getMetafor()'' defined in the module previously loaded, and starts the time integration. If no working directory was explicitly selected, the default name (''workspace/test_name'') is used. If this directory already contains older results, those files will be first deleted (after user's approval).
-L'intégration ouvre une fenêtre graphique 3D qui est rafraichie au cours du calcul. La plupart des options d'affichage sont modifiables en utilisant le bouton "Config" de la fenêtre en question.
+Then, the time integration procedure opens a 3D graphics window, which will be continuously refreshed during computation displaying the current results. The display options can be modified using the "Config" button of this window.
-Il est possible de fermer les fenêtre d'affichage et de les réouvrir en utilisant le menu "Windows".
+It is possible to close the display windows, and reopen them using the "Windows" menu.
-Lorsque le calcul se termine, __il est nécessaire de redémarrer Metafor__ pour lancer un deuxième cas-test!
+When the time integration finishes, you MUST restart Metafor to run another test !
+===== Loading results =====
-===== Charger des résultats =====
 {{ doc:user:loadfac.png|}}
-Pour recharger les résultats, l'utilisateur doit tout d'abord charger son module, comme il l'a fait avant de démarrer l'intégration.
+To load previously-computed results, the corresponding module must be loaded first, as was done before starting the time integration.
-A ce moment, si le répertoire de travail utilisé est celui par défaut, Metafor anticipe l'étape suivante et change de répertoire vers celui-ci. Sinon, il faut changer de répertoire "à la main" ("à la souris") en utilisant la fenêtre workspace.
+Then, if the workspace used is the default one, Metafor automatically sets its working directory to it. Otherwise, it must be changed manually, using the workspace window.
-Une fois le répertoire de résultats sélectionné, il suffit de repérer les fichier FACs (extension ''.bfac.gz''), d'en choisir un et de le charger à l'aide du menu contextuel ("Load Fac"). Une fenêtre de visualisation s'ouvre automatiquement et montre les résultats.
+Once the right folder is selected, simply locate the "FAC" files (extension ''.bfac.gz''), choose one and load it with the context menu ("Load Fac"). The results are displayed in a graphical window.
-Pour charger d'autres résultats, il faut répéter cette opération avec d'autres FACs. L'affichage se met à jour automatiquement.
+To load other results, repeat the operation with other FAC files. The display window is updated automatically.
 \\
 \\
@@ Line 104: / Line 81: @@
-===== Continuer un calcul arrêté =====
+===== Continuing a stopped calculation =====
 {{ doc:user:restartmodule.png|}}
-Pour différentes raisons (coupure de courant, fermeture brutale de Metafor, etc), il se peut qu'un calcul ait été arrêté en cours de route. Il est tout à fait possible de le redémarrer à partir d'un FAC intermédiaire (généralement, le dernier archivage avant l'arrêt). Ceci prouve l'utilité d'effectuer plusieurs archivages "de sécurité" sur les longs calculs de plusieurs jours.
+For various reasons (power cut, abrupt closure of Metafor...), a simulation may have ended earlier than expected. However, it can be restarted from an intermediate FAC, usually the last one that was written before the breakdown (therefore, several saving points should be planned before running long computations).
-La procédure est simple:
+This is rather straightforward :
-  * chargement du module
+  * load the right module
-  * recherche éventuelle du répertoire de travail.
+  * if you do not use the default workspace, set the right working directory.
-  * au lieu de faire "Load Fac", faire "Restart" en sélectionnant un FAC. L'intégration redémarre à partir de l'archivage sélectionné.
+  * choose the last FAC and restart it with the context menu
+The integration starts again from the selected FAC file.
@@ Line 127: / Line 106: @@
-===== Faire une animation (film) des résultats =====
+===== Making a "film" with the results =====
 \\
@@ Line 140: / Line 119: @@
 \\
-Pour présenter les résultats de manière attractive, il est souvent utile de créer un fichier ''.avi'' montrant le déroulement de l'intégration au cours du temps.
+To show results in a pleasant way, an ".avi" file, showing the integration over time, can be created.
-  * La première chose à faire est d'augmenter le nombre d'archivages sur disque (commande ''setNextTime'' du ''TimeStepManager'', voir [[doc:user:integration:general:time_step]])
+  * First, increase the number of times that results will be saved to disk. (command ''setNextTime'' of ''TimeStepManager'', see [[doc:user:integration:general:time_step]])
-  * Lancez le calcul.
+  * Run the test.
-  * Chargez ensuite le dernier FAC de votre calcul et bloquez l'échelle des valeurs scalaires affichées en fonction de ce pas de temps. Reglez également la taille des vecteurs si vous affichez les forces. Ensuite sauvegardez la configuration graphique (Bouton "Save").
+  * Load the last FAC file. Set up the scale of displayed scalar values according to their final value. Do the same for vectors, if needed. Then save the graphical options ("Save" button).
-  * Relancez Metafor et chargez votre module. Cliquez sur le bouton ''makeAnimation()'' dans la barre d'outil. Le premier pas de temps s'affiche et vous pouvez ajuster l'affichage (zoom, camera, etc)
+  * Restart Metafor, load your module. Click on ''makeAnimation()'' in the toolbar. The first time step is displayed, and other display options (such as zoom, camera...) can be adjusted.
-  * Appuyez sur [ENTER] dans la ligne de commande python. Metafor charge alors tous les FACs successivement et effectue des captures d'écran. Celles-ci sont enregistrées dans le workspace du cas-test au format ''bmp''.
+  * Press [ENTER] in the python command line. Metafor will then load all FAC files and successively perform screenshots. These are saved in the workspace, format ''bmp''.
-  * Utilisez le soft {{:doc:user:tutorials:iavimakeren.zip|AVIMaker}} ou un autre plus sophistiqué pour créer la vidéo à partir des captures. L'idéal est d'utiliser un codec "lossless" (Microsoft Video en qualité maximale par exemple).
+  * Finally, use a software like {{:doc:user:tutorials:iavimakeren.zip|AVIMaker}} to create the video from screenshots. Ideally, you should use a "lossless codec", for example Microsoft Video in highest quality.
-===== Metafor en ligne de commande =====
+===== Metafor in command line =====
+{{:doc:user:ico-advanced.png?40 |}}
-Il est parfois utile d'utiliser Metafor en ligne de commande:
+Should you need to run Metafor in command line, open a command line (''cmd.exe'', or a Unix shell). Then :
+  * ''metafor -help'' : display help
+  * ''metafor -nogui'' : start Metafor without the GUI
+  * ''metafor -nogui -run apps.qs.cont2'' : run  ''load''/''meta'' on ''apps/qs/cont2.py''
+  * ''metafor -nogui myscript.py'' :  execute commands written in ''myscript.py''.
-Ouvrez une ligne de commande (''cmd.exe'' ou un shell Unix). Ensuite:
+In interactive mode, after ''metafor -nogui'', we find ourselves in a python interpreter where some specific Metafor modules were loaded. To exit Metafor in "text" mode, on Windows, use ''CTRL-BREAK'' (a little rough, but that works), or ''CTRL-Z'' then ''Enter'' on Windows, or finally ''CTRL-D'' on Unix.
-  * ''metafor -help'' affiche l'aide
-  * ''metafor -nogui'': lance sans l'interface graphique
-  * ''metafor -nogui -run apps.qs.cont2'': lance ''load''/''meta'' sur ''apps/qs/cont2.py''
-  * ''metafor -nogui monscript.py'' :  exécute les commandes contenues dans ''monscript.py''
-En interactif, après ''metafor -nogui'', on se retrouve dans un interpréteur python où quelques modules propres à Metafor ont été chargés.
+To run a test :
-Pour lancer un test:
   load('apps.qs.cont2')
   meta()
-Pour exécuter un script (postprocessing par exemple):
+To execute a script (such as postprocessing) :
-  execfile('monscript.py')
+  execfile('myscript.py')
-Pour sortir de la ligne de commande, utilisez CTRL-Z sous Windows, CTRL-D sous Linux/Unix.
+To exit the command line, use CTRL-Z on Windows, CTRL-D on Linux/Unix.
 \\
-\\
-Vou savez maintenant utiliser l'interface graphique pour lacer un test et relire des résultats de calcul. Il est temps de construire votre propre jeu de données:
+Now, you know how to use the GUI, run a test and display results. We will then learn how to build your own data set :
 ⇒ [[doc:user:tutorials:tuto0]]
 \\
-==== En vidéo ====
-<html>
-<iframe width="853" height="480" src="//www.youtube.com/embed/7TSd3caZK2U" frameborder="0" allowfullscreen></iframe>
-</html>