March 2018 - Isis-fish-docs-commits - mailman.cloud.codelutin.com

r341 - trunk/src/site/rst/v4/user
by jcouteau＠users.forge.codelutin.com 19 Mar '18

19 Mar '18

Author: jcouteau Date: 2018-03-19 14:32:37 +0100 (Mon, 19 Mar 2018) New Revision: 341 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/341 Log: Update install doc Modified: trunk/src/site/rst/v4/user/installation.rst Modified: trunk/src/site/rst/v4/user/installation.rst =================================================================== --- trunk/src/site/rst/v4/user/installation.rst 2018-03-13 11:01:15 UTC (rev 340) +++ trunk/src/site/rst/v4/user/installation.rst 2018-03-19 13:32:37 UTC (rev 341) @@ -30,7 +30,7 @@ --------------- Afin de pouvoir faire tourner ISIS-Fish sur votre machine, il est -nécessaire d'avoir au moins la version *1.8* de Java d'installée. Il est +nécessaire d'avoir la version *1.8* de Java d'installée. Il est possible de connaître la version actuellement installée sur votre ordinateur en tapant dans une commande DOS : «java -version». Si vous aboutissez à un message d'erreur, cela signifie que Java n'est pas @@ -39,6 +39,8 @@ version de Java SE Development Kit (JDK). Ceci peut se faire directement à cette adresse : http://www.oracle.com/technetwork/java/javase/downloads/index.html +*Attention, ISIS-Fish ne fonctionne pas en Java 9.* + Comment se procurer ISIS-Fish ----------------------------- @@ -66,7 +68,7 @@ Fichier de lancement par défaut .bat et .sh ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Par défaut ISIS-Fish peut allouer au maximum 1Go de Ram pour son +Par défaut ISIS-Fish peut allouer au maximum 2Go de Ram pour son utilisation. Si votre région contient de très nombreux métiers, stratégies et populations vous pouvez devoir augmenter cette valeur pour cela éditez le fichier *isisfish.bat* ou *isisfish.sh* suivant votre @@ -73,16 +75,18 @@ plateforme (Windows, Unix/Linux). Par défaut les fichiers de lancement redirigent les sorties vers un -fichier ``debug.txt``. Si jamais un problème se produit durant +fichier ``debug.txt``. Ce fichier est créé à côté du fichier du lancement +après avoir lancé ISIS-Fish. Si jamais un problème se produit durant l'utilisation d'ISIS-Fish ce fichier peut vous permettre de comprendre plus simplement le problème. Si vous faites appel aux mailing-lists pour demander de l'aide, il vous sera demandé de joindre ce fichier à votre demande. -Lancer ISIS-Fish sous windows +Lancer ISIS-Fish sous Windows ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Double-cliquer sur le fichier .bat créé. Une fenêtre DOS va alors -s'ouvrir. Puis l'interface d'ISIS. +s'ouvrir. Puis l'interface d'ISIS. Au premier lancement, le délai peut être +long (ISIS-Fish récupère des données depuis Internet). .. image:: usermanual/mainWindow.png @@ -102,81 +106,20 @@ ./isisfish.sh -Option de la ligne de commande ------------------------------- +Le fonctionnement est ensuite similaire à Windows -Il est possible de passer des paramètres à la ligne de commande par exemple:: - - ./isisfish.sh --help - -l'option ``--help`` permet d'afficher la liste des options disponibles - -Voici les autres options. - -================================================ ======================================================================================================================================================================================================= -Commande Description -================================================ ======================================================================================================================================================================================================= --help, -h Affiche l'aide --listRegion Affiche la liste des régions disponibles --importRegion region Importe une région dans la base locale. Il est possible d'importer des régions depuis ISIS-Fish version 2 ou 3. Suivant l'extension du fichier, ISIS-Fish fera la bonne opération --importAndRenameRegion region newName Importe une région dans la base local et modifie son nom durant l'import. --exportRegion regionName output.zip Exporte une région existante dans la base locale sous la forme d'un fichier zip importable ultérieurement. --listSimulation Affiche la liste des simulations disponibles --importSimulation simulation Importe une simulation dans la base locale --exportSimulation simulationName simulation.zip Exporte une simulation existante dans la base locale sous la forme d'un fichier zip importable ultérieurement. --update <true|false> Force la mise à jour des scripts comme lors du premier lancement d'ISIS-Fish --create-ssh-key Permet de créer une paire de clé ssh. Ces clés sont utilisées pour pouvoir modifier les scripts pour les personnes ayant un login sur le CVS hébergeant les sources des scripts. (Voir le chapitre CVS) --ssh-key-file pathToPrivateKey Permet d'indiquer à ISIS-Fish d'utiliser une paire de clés ssh existantes pour l'accès au CVS. (Voir le chapitre CVS) --config name value Permet de modifier des valeurs de configuration. Cela revient au même que de modifier le fichier $HOME/.isis-config-3, ou utiliser l'interface depuis le menu fenêtre->configuration. -================================================ ======================================================================================================================================================================================================= - -Liste des options disponibles: - -======================= ================================================================================================================================================== ====================================================================================================== =================================================== -option description type exemple -======================= ================================================================================================================================================== ====================================================================================================== =================================================== -compileDirectory répertoire utilisé pour la compilation des scripts chemin vers un répertoire /tmp/isis-build -language La langue à utiliser ISO Language Code http://www.loc.gov/standards/iso639-2/englangn.html fr -country La variable pays pour la langue ISO Country Code http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/lis… FR -database répertoire utilisé pour stocker les informations chemin vers un répertoire /home/poussin/isis-database-3 -defaultSimulator nom du fichier à utiliser comme simulateur nom d'un fichier .java contenu dans le répertoire $database/simulators DefaultSimulator.java -javadocUrl URL pointant vers la javadoc du simulateur URL http://isis-fish.labs.libre-entreprise.org/apidocs/ -defaultExportDirectory Répertoire ou les exports de simulation sont placé par défaut chemin vers un répertoire /home/poussin/isis-export -defaultExportNames la liste des noms des exports par défaut à utiliser liste séparée par des virgules Abundances.java,Biomasses.java -defaultResultNames la liste des résultats que l'on souhaite conserver durant la simulation pour les visualiser ultérieurement via l'interface de rendu des résultats. liste séparé par des virgules matrixDiscardsWeightPerStrMet,matrixPrice -defaultMap la carte à utiliser par défaut pour nouvelle région le chemin d'un fichier de carte .shp sans l'extension maps/vmap_area_thin -defaultTagValue la liste des tags values à utiliser par défaut pour les simulations liste séparé par des virgules de couple "nom":"valeur" "ecoResult":"true","maVal":"truc" -cvsHostName le nom du serveur contenant l'arbre CVS des données le nom d'un serveur ou une ip labs.libre-entreprise.org -cvsRepository le répertoire racine du CVS sur le serveur chemin vers un répertoire /cvsroot/isis-fish -cvsDataBase le nom du module CVS contenant les données sur le serveur String isis-fish-data -cvsHost fichier contenant les cles des serveurs CVS chemin d'un fichier xml /home/poussin/.isis-ssh-host.xml -cvsUserName le nom de l'utilisateur pouvant accéder au CVS login anonymous ou bpoussin -cvsSsh2Connexion indique si l'on utilise ou non un accès sécurisé au CVS. Cela n'est pas utile pour le compte anonymous et nécessite une clé SSH boolean true -cvsKeyFile le fichier contenant la clé privée SSH chemin vers un fichier /home/poussin/.ssh/id_dsa -smtpServer le nom du serveur SMTP à utiliser pour envoyer des mails. nom d'un serveur ou ip smtp.codelutin.com -localSimulator valeur par défaut utilisée pour savoir si les simulations que l'on exécute doivent être faites localement ou sur un serveur de simulation boolean true -simulatorServer URL permettant de contacter le serveur de simulations URL http://simulateur.ifremer.fr:9090 -simulatorServerLogin le login à utiliser pour le serveur de simulations login bpoussin -simulatorServerPassword le mot de passe à utiliser pour le serveur de simulations mot de passe guest -======================= ================================================================================================================================================== ====================================================================================================== =================================================== - Premier lancement et fichier de configuration --------------------------------------------- -Lors du premier lancement ISIS-Fish vous posera un certain nombre de -question. +Lors du premier lancement ISIS-Fish, la configuration par défaut est appliquée. Vous pouvez modifier la configuration +ultérieurement via les interfaces graphiques ou en éditant ``$HOME/.config/isis-config-4`` (le fichier n'existe que si +des modifications ont été apportées à la configuration, si besoin vous pouvez le créer) . -Si vous souhaitez les modifier ultérieurement il faut éditer le -fichier ``$HOME/.config/isis-config-4``. - ``$HOME`` est une variable d'environnement sous Unix/Linux qui pointe vers le répertoire utilisateur de la personne logguée. Sous Windows l'utilisateur à aussi un espace de travail personnel, mais son emplacement varie suivant la version de Windows utilisée. -Données et scripts initiaux ---------------------------- - Lors du premier lancement, il est conseillé d'être connecté à Internet, car ISIS-Fish récupère une région de démonstration et les scripts de simulation, export... @@ -212,7 +155,7 @@ Par défault, la zone de travail est ``C:\Documents and Settings\chezsoi`` (zone où sont créés les répertoires ``isis-database``, ``isis-build``,...). Pour changer de zone de travail, il suffit de changer le répertoire par défaut dans le -``isis-config`` par le répertoire choisi. +``isis-config-4`` par le répertoire choisi. Fichier exemple :: @@ -224,14 +167,14 @@ default.export.directory=D\:\\SimulationsISIS\\isis-export -Installer Isis-FISH pour effectuer les simulations sur le super-calculateur CAPARMOR +Installer Isis-FISH pour effectuer les simulations sur le super-calculateur DATARMOR ------------------------------------------------------------------------------------ -Afin d'utiliser Caparmor pour effectuer les simulations, il convient de suivre -une procédure particulière (et d'avoir l'autorisation d'utiliser Caparmor). La +Afin d'utiliser Datarmor pour effectuer les simulations, il convient de suivre +une procédure particulière (et d'avoir l'autorisation d'utiliser Datarmor). La procédure décrite dans le fichier joint devrait vous permettre de configurer et -utiliser ISIS et Caparmor correctement. +utiliser ISIS et Datarmor correctement. -`Installation d'ISIS-Caparmor`_ +`Installation d'ISIS-Datarmor`_ -.. _Installation d'ISIS-Caparmor: installation-isis-caparmor.pdf +.. _Installation d'ISIS-Datarmor: installation-isis-caparmor.pdf

1 0

r340 - trunk/src/site/rst/v4/user/tutorials
by jcouteau＠users.forge.codelutin.com 13 Mar '18

13 Mar '18

Author: jcouteau Date: 2018-03-13 12:01:15 +0100 (Tue, 13 Mar 2018) New Revision: 340 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/340 Log: Fix rst syntax Modified: trunk/src/site/rst/v4/user/tutorials/optimization.rst Modified: trunk/src/site/rst/v4/user/tutorials/optimization.rst =================================================================== --- trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-03-12 15:41:19 UTC (rev 339) +++ trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-03-13 11:01:15 UTC (rev 340) @@ -42,18 +42,13 @@ simulations précédentes. Voici l'ensemble des méthodes présentes dans le script: - * ``getNecessaryResult()`` : retourne l'ensemble des résultats devant être calculés par l'ensemble des simulations et - nécessaires à l'exécution du script d'optimisation - * ``getDescription()`` : retourne une description du script à destination de l’utilisateur (affichée dans l'interface - de lancement) - * ``init(OptimizationContext)`` : sert à initialiser le script d’optimisation (appelée une fois, avant le lancement du - script) - * ``firstSimulation(OptimizationContext)`` : sert à générer la première génération de simulation (appelée une fois au - lancement du script) + * ``getNecessaryResult()`` : retourne l'ensemble des résultats devant être calculés par l'ensemble des simulations et nécessaires à l'exécution du script d'optimisation + * ``getDescription()`` : retourne une description du script à destination de l’utilisateur (affichée dans l'interface de lancement) + * ``init(OptimizationContext)`` : sert à initialiser le script d’optimisation (appelée une fois, avant le lancement du script) + * ``firstSimulation(OptimizationContext)`` : sert à générer la première génération de simulation (appelée une fois au lancement du script) * ``nextSimulation(OptimizationContext)`` : est appelée à chaque nouvelle génération de simulation * ``endSimulation(OptimizationContext)`` : est appelée à chaque fin d’exécution d'une génération de simulations - * ``finish(OptimizationContext context)`` : appelée une fois, à la fin du script, lorsque que l'ensemble des - générations de simulations sont terminées + * ``finish(OptimizationContext context)`` : appelée une fois, à la fin du script, lorsque que l'ensemble des générations de simulations sont terminées Génération de simulations @@ -74,14 +69,9 @@ * de produire de nouvelles simulations dans la génération courante Liste des méthodes disponibles: - * ``context.getCurrentGeneration()`` : permet de connaitre le numéro de la génération en cours. Par exemple, au 3ème - appel de ``nextSimulation()`` le compteur sera égal à ``3`` (en prenant en compte que le compteur est égal à ``0`` - dans la méthode ``firstSimulation()``) - * ``context.newSimulation()`` : crée une nouvelle simulation dans la génération courante et la retourne sous forme de - ``SimulationStorage`` (pour être modifiée par l'utilisateur avant son lancement) - * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les - ``SimulationStorage`` retournés peuvent - être lus pour en extraire des résultats + * ``context.getCurrentGeneration()`` : permet de connaitre le numéro de la génération en cours. Par exemple, au 3ème appel de ``nextSimulation()`` le compteur sera égal à ``3`` (en prenant en compte que le compteur est égal à ``0`` dans la méthode ``firstSimulation()``) + * ``context.newSimulation()`` : crée une nouvelle simulation dans la génération courante et la retourne sous forme de ``SimulationStorage`` (pour être modifiée par l'utilisateur avant son lancement) + * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les ``SimulationStorage`` retournés peuvent être lus pour en extraire des résultats Condition d'arrêt

1 0

r339 - trunk/src/site/rst/v4/user/tutorials
by jcouteau＠users.forge.codelutin.com 12 Mar '18

12 Mar '18

Author: jcouteau Date: 2018-03-12 16:41:19 +0100 (Mon, 12 Mar 2018) New Revision: 339 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/339 Log: Update optimisation doc Modified: trunk/src/site/rst/v4/user/tutorials/optimization.rst Modified: trunk/src/site/rst/v4/user/tutorials/optimization.rst =================================================================== --- trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-01-30 13:55:12 UTC (rev 338) +++ trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-03-12 15:41:19 UTC (rev 339) @@ -27,35 +27,43 @@ Optimisation ============ -Les scripts d'optimisation servent à lancer plusieurs séries de simulation et évaluant à chaque itération si le script doit continuer. -Cette condition est vérifiée par une fonction d'objectif qui analyse les exports habituels des simulations par rapport aux observations renseignées -dans la base de données. +Les scripts d'optimisation servent à lancer itérativement des séries de simulation en évaluant à chaque itération si le +script doit continuer. Cette évaluation se base sur le calcul d'une fonction d'objectif qui compare les résultats des +simulations exportés aux observations renseignées dans la base de données. Script d'optimisation ===================== -Un script d'optimisation est relativement similaire à un plan d'analyse, mais il comprend quelques méthodes en plus. Son but est de générer un -ensemble de simulation à être executée et déterminer une condition à l'arrêt du script. +Un script d'optimisation est relativement similaire à un plan d'analyse, mais il comprend quelques méthodes en plus. Son +but est 1) de générer séquentiellement un ensemble de simulations qui seront executées et 2) déterminer une condition à +l'arrêt du script. La particularité est la possible combinaison de simulations séquentielles et parallèles et le fait +que les paramètres d’une nouvelle série de simulations sont déterminés au cours du plan sur la base des résultats des +simulations précédentes. Voici l'ensemble des méthodes présentes dans le script: - * ``getNecessaryResult()`` : retourne l'ensemble des résultats devant être calculés par l'ensemble des simulations et nécessaire à l'execution du - script d'optimisation - * ``getDescription()`` : retourne une description du script à destination de l’utilisateur (affichée dans l'interface de lancement) - * ``init(OptimizationContext)`` : sert à initialiser le script d’optimisation (appelée une fois, avant le lancement du script) - * ``firstSimulation(OptimizationContext)`` : sert à générer la première génération de simulation (appelée une fois au lancement du script) - * ``nextSimulation(OptimizationContext)`` : est appelée plusieurs fois, a chaque génération de simulation - * ``endSimulation(OptimizationContext)`` : est appelée plusieurs fois, à chaque fin d’exécution d'une génération de simulation - * ``finish(OptimizationContext context)`` : appelée une fois, à la fin du script, lorsque que l'ensemble des générations de simulation ont terminé + * ``getNecessaryResult()`` : retourne l'ensemble des résultats devant être calculés par l'ensemble des simulations et + nécessaires à l'exécution du script d'optimisation + * ``getDescription()`` : retourne une description du script à destination de l’utilisateur (affichée dans l'interface + de lancement) + * ``init(OptimizationContext)`` : sert à initialiser le script d’optimisation (appelée une fois, avant le lancement du + script) + * ``firstSimulation(OptimizationContext)`` : sert à générer la première génération de simulation (appelée une fois au + lancement du script) + * ``nextSimulation(OptimizationContext)`` : est appelée à chaque nouvelle génération de simulation + * ``endSimulation(OptimizationContext)`` : est appelée à chaque fin d’exécution d'une génération de simulations + * ``finish(OptimizationContext context)`` : appelée une fois, à la fin du script, lorsque que l'ensemble des + générations de simulations sont terminées -Génération de simulation ------------------------- +Génération de simulations +------------------------- -Dans les scripts d'optimisation, on parle de "génération de simulation" pour désigner un ensemble de simulation que le script d'optimisation -génere à chaque itération. +Dans les scripts d'optimisation, on parle de "génération de simulations" pour désigner un ensemble de simulations +indépendantes que le script d'optimisation crée à chaque itération à partir des résultats de la génération précédente. -Chaque génération comprend plusieurs simulation qui sont exécutées en **parallèle**. Mais les "génération de simulation" sont exécutées **séquentiellement**. +Chaque génération comprend plusieurs simulations qui sont exécutées en **parallèle**. Mais les "générations de +simulations" sont exécutées **séquentiellement**. OptimisationContext @@ -63,28 +71,34 @@ L'objet ``OptimizationContext`` est un objet qui est donné à chaque méthode du script d'optimisation. Il permet de: * connaitre l'état d'avancement du script - * de produire de nouvelles simulation dans la génération courante + * de produire de nouvelles simulations dans la génération courante Liste des méthodes disponibles: - * ``context.getCurrentGeneration()`` : permet de connaitre le numéro de la génération en cours. Par exemple, au 3ème appel de ``nextSimulation()`` le compteur sera égal à ``3`` (en prenant en compte que le compteur est égal à ``0`` dans la méthode ``firstSimulation()`` - * ``context.newSimulation()`` : crée une nouvelle simulation dans la génération courante et la retourne sous forme de ``SimulationStorage`` (pour être modifiée par l'utilisateur avant son lancement) - * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les ``SimulationStorage`` retournés peuvent - être lus pour en extraire des résultats + * ``context.getCurrentGeneration()`` : permet de connaitre le numéro de la génération en cours. Par exemple, au 3ème + appel de ``nextSimulation()`` le compteur sera égal à ``3`` (en prenant en compte que le compteur est égal à ``0`` + dans la méthode ``firstSimulation()``) + * ``context.newSimulation()`` : crée une nouvelle simulation dans la génération courante et la retourne sous forme de + ``SimulationStorage`` (pour être modifiée par l'utilisateur avant son lancement) + * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les + ``SimulationStorage`` retournés peuvent + être lus pour en extraire des résultats Condition d'arrêt ----------------- -Un script d'optimisation s'arrête lorsqu'il n'y a plus de simulation à executer. +Un script d'optimisation s'arrête lorsqu'il n'y a plus de simulation à exécuter. -Donc, pour arrêter un script, il faut, dans la méthode ``nextSimulation(OptimizationContext)`` ne faire aucun appel à ``context.newSimulation()``. +Donc, pour arrêter un script, il faut, dans la méthode ``nextSimulation(OptimizationContext)`` ne faire aucun appel à +``context.newSimulation()``. Fonction d'objectif =================== -Une fonction d'objectif sert à retourner un indicateur sur l'execution d'une simulation. Cette fonction d'objectif est à paramêtre à définir lors -du lancement d'un script d'optimsation et peut donc être différente à chaque fois. +Une fonction d'objectif sert à retourner une valeur à la fin de l'exécution d'une simulation. Cette fonction d'objectif +n'est pas générique et dépend de l'optimisation réalisée. Par exemple pour une calibration, elle consiste en général à +comparer des sorties de simulation à des observations. Elle doit être programmée par l’utilisateur. Structure @@ -95,7 +109,8 @@ - ``getNecessaryResult()`` pour définir les résultats à calculer pour le fonction d'objectif - ``getDescription()`` pour fournir une description à l'utilisateur -Il contient surtout une seule méthode spécifique : ``double eval(OptimizationContext context, List<MatrixND> exports, List<MatrixND> observations)``. +Il contient surtout une seule méthode spécifique : ``double eval(OptimizationContext context, List<MatrixND> exports, +List<MatrixND> observations)`` qui sert au calcul de la fonction d’objectif. Cette méthode prend en paramètres: * le contexte de simulation @@ -102,18 +117,18 @@ * les résultats des exports calculés par la simulation * les observations définis lors du lancement du script d'optimisation -Le but de la fonction d'objectif est de comparer les exports aux observations et à définir un indicateur ``double`` qui pourra être utile au script -d'optimisation. +Le but de la fonction d'objectif est de comparer les exports aux observations et à définir un indicateur ``double`` qui +pourra être utile au script d'optimisation. -Le résultat de la fonction d'objectif est stocké dans le ``SimulationStorage`` et pourra être récupéré, à la fin de chaque génération, avec la méthode -``SimulationStorage#getObjective()`` +Le résultat de la fonction d'objectif est stocké dans le ``SimulationStorage`` et pourra être récupéré, à la fin de +chaque génération, avec la méthode ``SimulationStorage.getObjective()`` Exemple ======= -Fonction d'objectif ``Objectif3Iteration.java``. Cette fonction d'objectif est très simple. Elle retourne -1 losque que 3 générations de simulation -ont été executées. +Fonction d'objectif ``Objectif3Iteration.java``. Cette fonction d'objectif est très simple. Elle retourne -1 lorsque que +3 générations de simulations ont été exécutées. .. class:: java @@ -130,7 +145,8 @@ } } -Script d'optimisation ``ExampleObjectif.java``. Cet example génère des séries de 2 simulations, tant que la fonction d'objectif n'a pas retourné ``-1``. +Script d'optimisation ``ExampleObjectif.java``. Cet script d'optimisation génère des séries de 2 simulations, tant que +la fonction d'objectif n'a pas retourné ``-1``. .. class:: java @@ -167,4 +183,4 @@ } } -Dans cette exemple, cette fonction d'optimisation aura lancé 8 simulations (4 séries de 2 simulations). +Dans cet exemple, cette fonction d'optimisation aura lancé 8 simulations (4 séries de 2 simulations).

1 0