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-jav... +.. _Un site très pédagogique pour apprendre à programmer en JAVA: http://fr.openclassrooms.com/informatique/cours/apprenez-a-programmer-en-jav... .. _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 +