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

r338 - in trunk/src/site/rst/v4/user: . tutorials
by echatellier＠users.forge.codelutin.com 30 Jan '18

30 Jan '18

Author: echatellier Date: 2018-01-30 14:55:12 +0100 (Tue, 30 Jan 2018) New Revision: 338 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/338 Log: Ajout de doc sur les matrices Added: trunk/src/site/rst/v4/user/tutorials/matrix.rst Modified: trunk/src/site/rst/v4/user/tutorials.rst Copied: trunk/src/site/rst/v4/user/tutorials/matrix.rst (from rev 335, trunk/src/site/rst/v4/user/tutorials/useAPI.rst) =================================================================== --- trunk/src/site/rst/v4/user/tutorials/matrix.rst (rev 0) +++ trunk/src/site/rst/v4/user/tutorials/matrix.rst 2018-01-30 13:55:12 UTC (rev 338) @@ -0,0 +1,100 @@ +.. - +.. * #%L +.. * IsisFish +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2018 Ifremer, Code Lutin +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU General Public License as +.. * published by the Free Software Foundation, either version 3 of the +.. * License, or (at your option) any later version. +.. * +.. * This program is distributed in the hope that it will be useful, +.. * but WITHOUT ANY WARRANTY; without even the implied warranty of +.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. * GNU General Public License for more details. +.. * +.. * You should have received a copy of the GNU General Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/gpl-3.0.html>. +.. * #L% +.. - + +Utilisation des matrices dans ISIS-Fish +======================================= + +Dans ISIS-Fish, les matrices sont implémentées par un projet externe : `Nuiton-matrix <http://nuiton-matrix.nuiton.org>`_. + + +Import de matrix N dimension avec les sémantiques +------------------------------------------------- + +Fichier CVS +~~~~~~~~~~~ + +Pour importer des matrices N dimension en reférancant les coordonées par leur sémantique, il faut produire un fichier CSV dans le format suivant: + +.. class:: txt + +:: + + [dimensions] valeurParDefaut + semantique1 + semantique2 + ... + coordonnées1;coordonnées1;valeur + coordonnées1;coordonnées1;valeur + +Par exemple: + +.. class:: csv + +:: + + [2,3] 0 + Population:merluccius,nephrops + Zone:zone_merlu_recrutement,zone_merlu_presence,zone_merlu_reproduction + 0;0;42 + 1;2;24 + 1;0;0.5 + +Ce fichier importé défini trois valeur particulière pour (merluccius,zone_merlu_recrutement), (nephrops,zone_merlu_reproduction) et (nephrops,zone_merlu_recrutement). +Toutes les autres cellules de la matrice auront pour valeur la valeur par défaut : ``0``. + +Sémantique +~~~~~~~~~~ + +Les sémantiques utilisées dans ce format doivent correspondre aux objets réel de la matrice importé. + +Les types peuvent être des objets java: + * ``java.lang.String`` + * ``java.lang.Integer`` + * ``java.lang.Double`` + * ... + +ou des objets ISIS-Fish: + * ``Cell`` + * ``Zone`` + * ``Port`` + * ``Species`` + * ``Population`` + * ``PopulationGroup`` + * ``Gear`` + * ``VesselType`` + * ``TripType`` + * ``SetOfVessels`` + * ``Strategie`` + * ``Observation`` + * ``Metier`` + * ... + +Ensuite, chaque objet doit être représenté par son **nom**. Par exemple, pour les populations de nom ``merluccius`` et ``nephrops``, on écrira: +``Population:merluccius,nephrops`` + +Il y a toutefois un cas particulier concernant les groupes de population (``PopulationGroup``). Dans l'application, un groupes de population n'a pas +de nom mais un numéro de groupe. Dans pour référencer un groupe, on utilisera la syntaxe : ``<nomdepopulation>+<numerodegroupe>``. Par exemple:: + + PopulationGroup:nephrops+0,nephrops+1,nephrops+2,nephrops+3,nephrops+4,nephrops+5,nephrops+6,nephrops+7,nephrops+8 Modified: trunk/src/site/rst/v4/user/tutorials.rst =================================================================== --- trunk/src/site/rst/v4/user/tutorials.rst 2018-01-29 15:55:41 UTC (rev 337) +++ trunk/src/site/rst/v4/user/tutorials.rst 2018-01-30 13:55:12 UTC (rev 338) @@ -5,7 +5,7 @@ .. * $Id$ .. * $HeadURL$ .. * %% -.. * Copyright (C) 1999 - 2013 Ifremer, Code Lutin +.. * Copyright (C) 1999 - 2018 Ifremer, Code Lutin .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -27,26 +27,33 @@ =================== * `Première utilisation d'ISIS-Fish`_ -* `Exemple de parametrisation d une pecherie`_ +* `Exemple de paramétrisation d une pecherie`_ * `Les plans d'analyse`_ +* `Les script d'optimisation`_ * `Tutoriaux JAVA`_ -* `Un site très pedagogique pour apprendre à programmer en JAVA`_ +* `Un site très pédagogique pour apprendre à programmer en JAVA`_ * `Comment utiliser les APIs`_ * `Quelques commandes utiles pour les simulations sur CAPARMOR`_ * `Creer un nouveau resultat et export`_ +* `Utilisation des matrices dans ISIS-Fish`_ .. _Première utilisation d'ISIS-Fish: tutorials/firstLaunch.html .. _Tutoriaux JAVA: http://docs.oracle.com/javase/tutorial/ -.. _Un site très pedagogique pour apprendre à programmer en JAVA: http://fr.openclassrooms.com/informatique/cours/apprenez-a-programmer-en-ja… +.. _Un site très pédagogique pour apprendre à programmer en JAVA: http://fr.openclassrooms.com/informatique/cours/apprenez-a-programmer-en-ja… .. _Quelques commandes utiles pour les simulations sur CAPARMOR: tutorials/utilCaparmor.html .. _Les plans d'analyse: tutorials/simulationPlan.html -.. _Exemple de parametrisation d une pecherie: tutorials/parameterising.html +.. _Les script d'optimisation: tutorials/optimization.html +.. _Exemple de paramétrisation d une pecherie: tutorials/parameterising.html + .. _Comment utiliser les APIs: tutorials/useAPI.html .. _Creer un nouveau resultat et export: tutorials/newResult.html + +.. _Utilisation des matrices dans ISIS-Fish: tutorials/matrix.html +

1 0

r337 - trunk/src/site/rst/v4/user/tutorials
by echatellier＠users.forge.codelutin.com 29 Jan '18

29 Jan '18

Author: echatellier Date: 2018-01-29 16:55:41 +0100 (Mon, 29 Jan 2018) New Revision: 337 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/337 Log: Corrections 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-29 13:35:47 UTC (rev 336) +++ trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-01-29 15:55:41 UTC (rev 337) @@ -27,7 +27,7 @@ Optimisation ============ -Les scripts d'optimsation servent à lancer plusieurs série de simulation et évaluant à chaque itération si le script doit continuer. +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. @@ -40,7 +40,7 @@ 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'optimsation + 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) @@ -55,23 +55,21 @@ 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. -Chaque génération comprend plusieurs simulation qui sont executées en parallèle. Mais les "génération de simulation" sont exeution séquantiellement. +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**. OptimisationContext ------------------- -L'objet ``OptimizationContext`` est un object qui est donné à chaque méthode du script d'otpimisation. Il permet de: +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 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 égale à ``0`` dans la méthode ``firstSimulation()`` - * ``context.newSimulation()`` : crée une nouvelle simulation dans la simulation courante et la retourne sous forme de SimulationStorage (pour être - modifiée par l'utilsateur avant son lancement) - * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les ``SimulationStorage`` retournée peuvent - être lu 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 @@ -93,21 +91,21 @@ --------- Un script d'optimisation à des méthodes classiques aux autres scripts: - - init() pour initialiser la fonction d'objectif - - getNecessaryResult() pour définir les résultats à calculer pour le fonction d'objectif - - getDescription()pour fournir une description à l'utilsateur + - ``init()`` pour initialiser la fonction d'objectif + - ``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)``. Cette méthode prend en paramètres: * le contexte de simulation - * les résultats des exports définis au lancement du script d'optimisation + * 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 résultat de la fonction d'objectif est stocké dans le SimulationStorage et pour être récupéré, à la fin de chaque génération, avec la méthode +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()`` @@ -169,4 +167,4 @@ } } -Dans cette exemple, cette fonction d'optimasation aura lancé 8 simulations (4 séries de 2 simulations). +Dans cette exemple, cette fonction d'optimisation aura lancé 8 simulations (4 séries de 2 simulations).

1 0

r336 - in trunk/src/site: . rst/v4/user/tutorials
by echatellier＠users.forge.codelutin.com 29 Jan '18

29 Jan '18

Author: echatellier Date: 2018-01-29 14:35:47 +0100 (Mon, 29 Jan 2018) New Revision: 336 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/336 Log: Ajout de la documentation des scripts d'optimisation Added: trunk/src/site/rst/v4/user/tutorials/optimization.rst Modified: trunk/src/site/site_fr.xml Copied: trunk/src/site/rst/v4/user/tutorials/optimization.rst (from rev 335, trunk/src/site/rst/v4/user/usermanual/analysisPlan.rst) =================================================================== --- trunk/src/site/rst/v4/user/tutorials/optimization.rst (rev 0) +++ trunk/src/site/rst/v4/user/tutorials/optimization.rst 2018-01-29 13:35:47 UTC (rev 336) @@ -0,0 +1,172 @@ +.. - +.. * #%L +.. * IsisFish +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2018 Ifremer, Code Lutin +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU General Public License as +.. * published by the Free Software Foundation, either version 3 of the +.. * License, or (at your option) any later version. +.. * +.. * This program is distributed in the hope that it will be useful, +.. * but WITHOUT ANY WARRANTY; without even the implied warranty of +.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. * GNU General Public License for more details. +.. * +.. * You should have received a copy of the GNU General Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/gpl-3.0.html>. +.. * #L% +.. - + +============ +Optimisation +============ + +Les scripts d'optimsation servent à lancer plusieurs série 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. + + +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. + +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'optimsation + * ``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é + + +Génération de simulation +------------------------ + +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. + +Chaque génération comprend plusieurs simulation qui sont executées en parallèle. Mais les "génération de simulation" sont exeution séquantiellement. + + +OptimisationContext +------------------- + +L'objet ``OptimizationContext`` est un object qui est donné à chaque méthode du script d'otpimisation. Il permet de: + * connaitre l'état d'avancement du script + * de produire de nouvelles simulation 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 égale à ``0`` dans la méthode ``firstSimulation()`` + * ``context.newSimulation()`` : crée une nouvelle simulation dans la simulation courante et la retourne sous forme de SimulationStorage (pour être + modifiée par l'utilsateur avant son lancement) + * ``context.getLastSimulations()`` : retourne l'ensemble des simulations exécutée dans la dernière génération. Les ``SimulationStorage`` retournée peuvent + être lu 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. + +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. + + +Structure +--------- + +Un script d'optimisation à des méthodes classiques aux autres scripts: + - init() pour initialiser la fonction d'objectif + - getNecessaryResult() pour définir les résultats à calculer pour le fonction d'objectif + - getDescription()pour fournir une description à l'utilsateur + +Il contient surtout une seule méthode spécifique : ``double eval(OptimizationContext context, List<MatrixND> exports, List<MatrixND> observations)``. + +Cette méthode prend en paramètres: + * le contexte de simulation + * les résultats des exports définis au lancement du script d'optimisation + * 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 résultat de la fonction d'objectif est stocké dans le SimulationStorage et pour ê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. + +.. class:: java + +:: + + public class Objective3Iteration implements Objective { + + public double eval(OptimizationContext context, List<MatrixND> exports, List<MatrixND> observations) { + double result = 0; + if (context.getCurrentGeneration() >= 3) { + result = -1; + } + return result; + } + } + +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``. + +.. class:: java + +:: + + public class ExampleOptimization implements Optimization { + + protected boolean stopped = false; + + public void firstSimulation(OptimizationContext context) throws Exception { + for (int i = 0; i <= 2; i++) { + SimulationStorage storage = context.newSimulation(); + // modify simulation storage + } + } + + public void nextSimulation(OptimizationContext context) throws Exception { + if (!stopped) { + for (int i = 0; i <= 2; i++) { + SimulationStorage storage = context.newSimulation(); + // modify simulation storage + } + } + } + + public void endSimulation(OptimizationContext context) throws Exception { + List<SimulationStorage> lastGeneration = context.getLastSimulations(); + for (SimulationStorage simulation : lastGeneration) { + double objective = simulation.getObjective(); + if (objective <= -1) { + stopped = true; + } + } + } + } + +Dans cette exemple, cette fonction d'optimasation aura lancé 8 simulations (4 séries de 2 simulations). Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2018-01-26 10:54:38 UTC (rev 335) +++ trunk/src/site/site_fr.xml 2018-01-29 13:35:47 UTC (rev 336) @@ -110,6 +110,7 @@ <item name="Première utilisation" href="v4/user/tutorials/firstLaunch.html"/> <item name="Paramétrisation" href="v4/user/tutorials/parameterising.html"/> <item name="Plans d'analyse" href="v4/user/tutorials/simulationPlan.html"/> + <item name="Script d'optimisation" href="v4/user/tutorials/optimization.html"/> <item name="Utilisation des APIs" href="v4/user/tutorials/useAPI.html"/> <item name="Commandes CAPARMOR" href="v4/user/tutorials/utilCaparmor.html"/> </menu>

1 0

r335 - trunk/src/site/rst/v4/user/usermanual
by jcouteau＠users.forge.codelutin.com 26 Jan '18

26 Jan '18

Author: jcouteau Date: 2018-01-26 11:54:38 +0100 (Fri, 26 Jan 2018) New Revision: 335 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/335 Log: Update doc Modified: trunk/src/site/rst/v4/user/usermanual/inputs.rst Modified: trunk/src/site/rst/v4/user/usermanual/inputs.rst =================================================================== --- trunk/src/site/rst/v4/user/usermanual/inputs.rst 2018-01-09 11:14:27 UTC (rev 334) +++ trunk/src/site/rst/v4/user/usermanual/inputs.rst 2018-01-26 10:54:38 UTC (rev 335) @@ -291,7 +291,7 @@ .. image:: input_06_inputZonesVariables.png -L'onglet *Variables* sert à définir des informations supplémentaires, comme par exemple, l'habitât de la zone. +L'onglet *Variables* sert à définir des informations supplémentaires, comme par exemple, l'habitat de la zone. 4. **Saisie des ports** ======================= @@ -616,8 +616,8 @@ annuler les modifications effectuées sur les groupes de la population. -Onglet **Saisie des équations de population** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Onglet **Saisie des traits de vie** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. image:: input_12_inputPopulations_tabEquation.png @@ -643,8 +643,9 @@ #. **Liste des populations** : Cette liste déroulante contient l'ensemble des équations de taux de reproduction connues pour cette espèce. -#. **Équation de taux de reproduction** : - Pour éditer sans passer par l'éditeur d'équations, l'équation de taux de reproduction. +#. **Équation de taux de reproduction (fécondité)** : + Pour éditer sans passer par l'éditeur d'équations, l'équation de taux de reproduction (fécondité). Ce paramètre n'est + pas toujours utilisé. L'utilisateur peut l'appeler dans ses scripts et équations. #. **Sauver comme modèle** pour équation de taux de mortalité naturelle pour sauver une équation de type taux de mortalité naturelle dans les scripts d'ISIS-Fish (formules/NaturalDeathRate)

1 0

r334 - trunk/src/site/rst/v4/user/usermanual
by bpoussin＠users.forge.codelutin.com 09 Jan '18

09 Jan '18

Author: bpoussin Date: 2018-01-09 12:14:27 +0100 (Tue, 09 Jan 2018) New Revision: 334 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/334 Log: modification de la documentation pour l'immigration (coefficient -> effectif) Modified: trunk/src/site/rst/v4/user/usermanual/inputs.rst Modified: trunk/src/site/rst/v4/user/usermanual/inputs.rst =================================================================== --- trunk/src/site/rst/v4/user/usermanual/inputs.rst 2017-10-02 14:59:43 UTC (rev 333) +++ trunk/src/site/rst/v4/user/usermanual/inputs.rst 2018-01-09 11:14:27 UTC (rev 334) @@ -967,8 +967,8 @@ #. **Sélection de la zone d'arrivée** : Liste déroulante des zones d'arrivée parmi les différents aires préalablement définies. Il faut sélectionner un zone d'arrivée pour le groupe sélectionné. -#. **Coefficient d'immigration** : - il s'agit de la proportion du groupe sélectionné affectée par l'immigration. +#. **Effectif d'immigration** : + il s'agit du nombre d'individu entrant dans le groupe et la zone sélectionnés. #. **Ajouter l'immigration** : Une fois sélectionnés les paramètres précédemment cités, on appuie ici pour créer l'immigration; les paramètres de l'immigration apparaissent comme une

1 0