Author: chatellier Date: 2011-02-08 14:00:41 +0000 (Tue, 08 Feb 2011) New Revision: 704 Log: Update coser en doc Added: trunk/src/site/rst/en/user/ trunk/src/site/rst/en/user/configuration.rst trunk/src/site/rst/en/user/controls.rst trunk/src/site/rst/en/user/dataformat.rst trunk/src/site/rst/en/user/faq.rst trunk/src/site/rst/en/user/guide_control.rst trunk/src/site/rst/en/user/guide_listcontrols.rst trunk/src/site/rst/en/user/guide_project.rst trunk/src/site/rst/en/user/guide_results.rst trunk/src/site/rst/en/user/guide_selection.rst Modified: trunk/changelog.txt trunk/src/site/rst/download.rst trunk/src/site/rst/en/download.rst trunk/src/site/rst/user/guide_listcontrols.rst trunk/src/site/rst/user/guide_results.rst trunk/src/site/rst/user/guide_selection.rst trunk/src/site/site_en.xml trunk/src/site/site_fr.xml Modified: trunk/changelog.txt =================================================================== --- trunk/changelog.txt 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/changelog.txt 2011-02-08 14:00:41 UTC (rev 704) @@ -4,6 +4,7 @@ 1.0-rc1 ------- + * Add control view default split pane size * Display only filename when a create project error is detected * Increase heap memory to 1024M * Display species in italic style in generated pdf meta file Modified: trunk/src/site/rst/download.rst =================================================================== --- trunk/src/site/rst/download.rst 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/rst/download.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -30,7 +30,7 @@ Une installation de Java version 6 est requise pour pouvoir executer Coser. Vous pouvez le télécharger depuis cette adresse -http://www.oracle.com/technetwork/java/javase/downloads/index.html . +http://www.oracle.com/technetwork/java/javase/downloads/index.html. Préférez la version la plus récente disponible et au moins la version 1.6.0_20. Modified: trunk/src/site/rst/en/download.rst =================================================================== --- trunk/src/site/rst/en/download.rst 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/rst/en/download.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -23,10 +23,26 @@ .. * #L% .. - Launch -========= +====== +Prerequisites +------------- + +To run Coser, you need a Java 6 installation. You can download it at this address: +http://www.oracle.com/technetwork/java/javase/downloads/index.html + +Prefer last available version, and at least the 1.6.0_20 version. + +Online launch +------------- + You can launch application directly from this website with Java WebStart from `this page`_. +Download +-------- + +You can also download Coser to run it locally. `Download coser`_. + .. _this page: ../coser-ui/en/jnlp-report.html - +.. _Download coser: http://labs.libre-entreprise.org/frs/?group_id=164 Added: trunk/src/site/rst/en/user/configuration.rst =================================================================== --- trunk/src/site/rst/en/user/configuration.rst (rev 0) +++ trunk/src/site/rst/en/user/configuration.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,76 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Configuration +============= + +Before using Coser, it need to be configured, especially about files not provided +with coser. + +A wizard is available with the menu *Options/Configuration* + +Paths +----- + +.. image:: ../images/90-configurationpath.png + +In this wizard, you can define following options: + +coser.projects.directory + Coser projects location directory. + +coser.reference.species + Taxonomy reference file location. + +coser.reference.typeSpecies + Species types code file location. + +coser.web.frontend + SIH indice campagne website address (used by administrator to publish results). + +coser.web.zones.file + Application zone file location (used to affect zone to rsufi results). + +Control step configuration +-------------------------- + +.. image:: ../images/91-configurationvalues.png + +In this view, you can define configuration values used during control step : + +coser.control.nobsmin + Minimum individual observation count. + +coser.control.diffcatchlength + Percentage of acceptable difference between the total numbers of individual + captured in the capture file and the same amount in lenght file. + +coser.control.typeFish + Fish species type code name. Used by some controls to exclude some species. + +coser.selection.occurrenceFilter + Default percentage used in mimimum occurrence field filter in selection step. + +coser.selection.densityFilter + Default percentage used in mimimum density field filter in selection step. Added: trunk/src/site/rst/en/user/controls.rst =================================================================== --- trunk/src/site/rst/en/user/controls.rst (rev 0) +++ trunk/src/site/rst/en/user/controls.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,93 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Contrôles +========= + +Coser dispose d'un interface permettant de personnaliser les contrôles. + +Cependant, leurs personnalisation est très technique et est réservé aux +utilisateurs expérimentée. + +Cette interface est composé d'un arbre avec la liste des 4 fichiers (captures, +tailles, traits, strates) et pour chacun d'eux, les niveaux des erreurs +detectable. + +A chaque niveau, un fichier XML décrivant les controles peut être associés +pour les décrires. + +Documentation +------------- + +Les fichiers XML sont basé sur une syntaxe utilisé par le framework Java XWork. + +La documentation de cette syntaxe peut être trouvé à cette adresse : +http://struts.apache.org/2.x/docs/validation.html + + +Champs +------ + +Pour chaque fichier, les champs sont accessible par leur nom anglais +(``survey``, ``stratum``...) dans leur type relatif (par exemple, ``number`` +est un double java). + +Pour chaque champs, il y a également un autre champs correspondant à sa +donnée sous forme de chaine de caracteres. Par exemple, le champs ``survey`` est +également accessible via le nom ``surveyAsString``. +Le champs ``number`` (de type double) est egalement accessible sous le nom +``numberAsString` (de type chaine). + +Exemple +------- + +Exemple du fichier de validation strate (niveau erreur) :: + + <validators> + <field name="survey"> + <field-validator type="requiredstring"> + <param name="trim">true</param> + <message>Missing survey name</message> + </field-validator> + </field> + <field name="stratum"> + <field-validator type="requiredstring"> + <param name="trim">true</param> + <message>Missing stratum name</message> + </field-validator> + </field> + <field name="surfaceAsString"> + <field-validator type="checkDouble"> + <param name="notAvailable">NA</param> + <message>surface attribute is not a valid double</message> + </field-validator> + </field> + </validators> + + +Dans cet exemple: + + * le champs ``survey`` est obligatoire (requiredstring) + * le champs ``surfaceAsString`` doit être un réel valide (la valeur NA étant + autorisée) Added: trunk/src/site/rst/en/user/dataformat.rst =================================================================== --- trunk/src/site/rst/en/user/dataformat.rst (rev 0) +++ trunk/src/site/rst/en/user/dataformat.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,115 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Tables file format +================== + +Coser needs 4 tables by project : + + * catchs + * stratas + * lengths + * hauls + +Each table must be formatted using CSV file format with ';' (semicolon) +separator and begin with predefined CSV headers (english or french) +**respecting header order**. + +Tables details +-------------- + +catchs +~~~~~~ + +French headers:: + + Campagne;Annee;Trait;Espece;Nombre;Poids + +English headers:: + + Survey;Year;Haul;Species;Number;Weight + +Sample (catchs.csv):: + + Survey;Year;Haul;Species;Number;Weight + EVHOE_TOT;1997;B1008;ALLO;160.00;0.47 + EVHOE_TOT;1997;B1008;ARNOLAT;1.00;0.01 + EVHOE_TOT;1997;B1008;ARNOTHO;1.00;0.03 + + +stratas +~~~~~~~ + +French headers:: + + Campagne;Strate;Surface + +English headers:: + + Survey;Stratum;Surface + +Sample (stratas.csv):: + + Survey;Stratum;Surface + EVHOE_TOT;Gn1;8201.69199214 + EVHOE_TOT;Gn2;11771.068813 + EVHOE_TOT;Gn3;17327.206597099997 + + +length +~~~~~~ + +French headers:: + + Campagne;Annee;Trait;Espece;Sexe;Maturite;Longueur;Nombre;Poids;Age + +English headers:: + + Survey;Year;Haul;Species;Sex;Maturity;Length;Number;Weight;Age + +Sample (length.csv):: + + Survey;Year;Haul;Species;Sex;Maturity;Length;Number;Weight;Age + EVHOE_TOT;1997;B1008;ARNOLAT;i;NA;11.00;1.00;;NA + EVHOE_TOT;1997;B1008;ARNOTHO;i;NA;13.00;1.00;;NA + EVHOE_TOT;1997;B1008;BOOPBOO;i;NA;14.00;1.00;0.02;NA + + +hauls +~~~~~ + +French headers:: + + Campagne;Annee;Trait;Mois;Strate;SurfaceBalayee;Lat;Long;ProfMoy + +English headers:: + + Survey;Year;Haul;Month;Stratum;SweptSurface;Lat;Long;Depth + +Sample (hauls.csv):: + + Survey;Year;Haul;Month;Stratum;SweptSurface;Lat;Long;Depth + EVHOE_TOT;1997;B1008;10;Gs2;0.06;43.75;-1.50;45.50 + EVHOE_TOT;1997;B1010;10;Gs1;0.06;43.81;-1.45;31.00 + EVHOE_TOT;1997;B1012;10;Gs3;0.06;43.89;-1.73;115.00 Added: trunk/src/site/rst/en/user/faq.rst =================================================================== --- trunk/src/site/rst/en/user/faq.rst (rev 0) +++ trunk/src/site/rst/en/user/faq.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,34 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Foire aux questions +=================== + +.. contents:: + +Au lancement de l'application JavaWebStart le message "Impossible de lancer l'application" apparaît +--------------------------------------------------------------------------------------------------- + +Si le détail de l'erreur cite une erreur de certificats, essayez de mettre à +jour java avant de recommencer. Added: trunk/src/site/rst/en/user/guide_control.rst =================================================================== --- trunk/src/site/rst/en/user/guide_control.rst (rev 0) +++ trunk/src/site/rst/en/user/guide_control.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,147 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Control step +============ + +The control step goal is to detect errors on the 4 data tables +and possibly correct them if possible. + +.. image:: ../images/10-controlmain.png + +Data check +---------- + +During this step, the first action to do is launching global check, by clicking +on ``Check data`` button. + +Coser will check: + + * line by line errors on 4 tables + * + * vérification par croissement avec le referentiel taxonomique + +À la fin des 10 étapes de vérification, un arbre de toutes les erreurs +s'affiche avec toutes les erreurs détectées. + +Pour plus de détails concernant les erreurs : `liste des contrôles`_. + +.. _liste des contrôles: guide_listcontrols.html + +Corrections des données +----------------------- + +Lors de la sélection d'une erreur, Coser affiche la ligne concernée par l'erreur +vous permettant d'apporter une correction. +Les lignes en rouge correspondent à des champs en erreurs. La partie droite +détaille les messages d'erreurs. + +Dans l'exemple précédant, l'année est manquante, l'utilisateur peut l'ajouter +à la main et valider la modification. + + +Corrections de masse +-------------------- + +Dans le cas où une erreur concerne plusieurs lignes: + + * soit l'erreur est dûe à une erreur d'export des 4 tables et il est + préféreable de refaire l'export en amont, la correction se reverant impossible + depuis coser + * soit l'erreur est corrigeable + +Le tableau affichant toute les données comporte un menu contextuel permettant: + + * de supprimer plusieurs lignes sélectionné + * de chercher un motif et de le remplacer par un autre + +.. image:: ../images/11-controlmenu1.png + +Par exemple, dans le cas ou tous les nombres comporterais une virgule (,) au +lieu d'un point (.), il est possible de remplacer un la virgule par un point +pour toutes les lignes sur une colonne en une seule opération. + + +Graphique +--------- + +Coser est également capable de générer des graphiques pour faciliter +la prise de décision (notement concernant les warning détectés par la +vérification globale). + +Le bouton ``Comparaison Captures/Tailles`` affiche une interface où un +graphique est générée pour chaque espèce. Les données correspondent à la somme +des ``Nombre``s dans les fichiers captures et tailles par année. +Une différence peut traduire une erreur dans les données d'origines. + +.. image:: ../images/13-controlgraphdiff.png + +Le bouton ``Strutures en taille`` affiche une interface un peu plus compliquée +mais permettant de générer des graphiques sur des sous ensembles de données +sélectionnés. + +Il est par exemple possible d'afficher la struture en taille mais seulement +pour une strate, ou seulement pour une espece, de faire la somme... + +.. image:: ../images/14-controlgraphlength.png + + +Rapport +------- + +Dans l'étape de contrôle, il est possible de générer deux rapports. + +Rapport de modification +~~~~~~~~~~~~~~~~~~~~~~~ + +Le rapport des modifications, accessible via le bouton `Rapport des +modifications`, est généré sous forme de rapport HTML et doit normalement +s'ouvrir dans un nivigateur internet. Vous pouvez à partir de ce navigateur +visualisé ou imprimer ce rapport. + +Rapport de contrôle +~~~~~~~~~~~~~~~~~~~ + +Ce rapport est accessible par clic droit sur l'arbre des erreurs après +vérification des erreurs sur les données. + +.. image:: ../images/12-controlmenu2.png + +Ca rapport contient les mêmes erreurs que celle affiché dans l'arbre et +les graphiques de comparaison Captures/Tailles. + + +Sauvegarde et validation +------------------------ + +Vous pouvez à tout moment sauvegarder l'état des données au fur et à mesure +de vos corrections. + +Àprès la vérification des données, et si celle ci c'est terminée **sans erreurs** +le bouton `Valider le contôle` devient actif et vous permet de valider. + +La validation de l'étape de contrôle est nécéssaire pour pouvoir passer +à l'`étape de sélection`_. + +.. _étape de sélection: guide_selection.html Added: trunk/src/site/rst/en/user/guide_listcontrols.rst =================================================================== --- trunk/src/site/rst/en/user/guide_listcontrols.rst (rev 0) +++ trunk/src/site/rst/en/user/guide_listcontrols.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,206 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Liste des contrôles +=================== + +Cette page détaille la liste des contrôles effectué par Coser lors +de l'étape de vérification des erreurs. + +Captures +-------- + ++------------+----------------------------------------------------------------+----------+ +| Champs | Vérification | Niveau | ++============+================================================================+==========+ +| Campagne | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| | Champs composé de 4 chiffres obligatoires et 2 chiffres | | +| Année | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Traits | Composé de lettres et chiffres | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Especes | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Nombre | Réel, vide ou NA | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Poids | Réel, vide ou NA | Erreur | ++------------+----------------------------------------------------------------+----------+ + ++-----------------------------------------------------------------------------+----------+ +| Autres vérifications | Niveau | ++=============================================================================+==========+ +| Si le Poids est un réel différent de 0, alors le Nombre doit être | | +| également différent de 0 | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | +| "Espece" | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Vérification du nombre minimal d'observations dans table CAPTURES$Nombre | | +| par espèce par strate par année | Warning | ++-----------------------------------------------------------------------------+----------+ + +Strates +------- + ++------------+----------------------------------------------------------------+----------+ +| Champs | Vérification | Niveau | ++============+================================================================+==========+ +| Campagne | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Strate | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Surface | Réel, vide ou NA | Erreur | ++------------+----------------------------------------------------------------+----------+ + ++-----------------------------------------------------------------------------+----------+ +| Autres vérifications | Niveau | ++=============================================================================+==========+ +| Verification des lignes dupliquées sur la clé "Campagne", "Strate" | Erreur | ++-----------------------------------------------------------------------------+----------+ + +Tailles +------- + ++------------+----------------------------------------------------------------+----------+ +| Champs | Vérification | Niveau | ++============+================================================================+==========+ +| Campagne | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Année | Champs composé de 4 chiffres obligatoires et 2 chiffres | | +| | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Traits | Composé de lettres et chiffres | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Espece | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Sexe | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Maturite | Champs obligatoire | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Longueur | Réel valide, vide | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Nombre | Réel valide, vide ou NA | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Poids | Réel valide, vide ou NA | Erreur | ++------------+----------------------------------------------------------------+----------+ +| Age | Réel valide, vide ou NA | Fatal | ++------------+----------------------------------------------------------------+----------+ + ++-----------------------------------------------------------------------------+----------+ +| Autres vérifications | Niveau | ++=============================================================================+==========+ +| Si le Poids est un réel différent de 0, alors le Nombre doit être | Erreur | +| également différent de 0 | | ++-----------------------------------------------------------------------------+----------+ +| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | Erreur | +| "Espece", "Sexe", "Maturite", "Longueur" | | ++-----------------------------------------------------------------------------+----------+ +| Vérification du nombre minimal d'observation dans table TAILLES$Nombre par | Erreur | +| espèce par strate par année | | ++-----------------------------------------------------------------------------+----------+ + +Traits +------ + ++-----------------+----------------------------------------------------------------+----------+ +| Champs | Vérification | Niveau | ++=================+================================================================+==========+ +| Campagne | Champs obligatoire | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| | Champs composé de 4 chiffres obligatoires et 2 chiffres | | +| Année | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| Traits | Composé de lettres et chiffres | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| Mois | 2 chiffres | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| Strates | Champs obligatoire | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| SurfaceBalayee | Champs obligatoire et réel valide ou NA | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| Lat | Réel valide, vide ou NA | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| Long | Réel valide, vide ou NA | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| ProfMoy | Réel valide, vide ou NA | Erreur | ++-----------------+----------------------------------------------------------------+----------+ +| SurfaceBalayee | Composé de au moins 3 décimales | Fatal | ++-----------------+----------------------------------------------------------------+----------+ +| Lat | Composé de au moins 4 décimales | Warning | ++-----------------+----------------------------------------------------------------+----------+ +| Long | Composé de au moins 4 décimales | Warning | ++-----------------+----------------------------------------------------------------+----------+ + ++-----------------------------------------------------------------------------+----------+ +| Autres vérifications | Niveau | ++=============================================================================+==========+ +| Si le Poids est un réel différent de 0, alors le Nombre doit être | | +| également différent de 0 | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | +| "Mois" | Erreur | ++-----------------------------------------------------------------------------+----------+ + +Coisement de fichier +-------------------- + ++-----------------------------------------------------------------------------+----------+ +| Vérifications | Niveau | ++=============================================================================+==========+ +| Vérification que le nom de campagne est le même dans les 4 tables | Fatal | ++-----------------------------------------------------------------------------+----------+ +| La liste des années doit être identique entre les fichiers Captures, | | +| tailles et Traits | Fatal | ++-----------------------------------------------------------------------------+----------+ +| Verification des lignes dupliquées sur la clé "Campagne", "Annee", "Trait", | | +| "Espece", "Sexe", "Maturite", "Longueur" | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Vérification du nombre minimal d'observation dans table TAILLES$Nombre par | | +| espèce par strate par année | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Pour les poissons, le champs Longueur doit utiliser un pas entier ou un | | +| demi pas (par exemple: 4.0 ou 4.5, mais pas 4.25) | Warning | ++-----------------------------------------------------------------------------+----------+ +| Vérification que pour chaque espèce présent dans un trait d'une année | | +| dans le fichier tailles (noté Annee/Trait/Espece) il y a une donnée | | +| dans le fichier captures (le contraire n'est pas vraie) | Fatal | ++-----------------------------------------------------------------------------+----------+ +| Vérification que pour chaque trait présent une année (noté Annee/Trait) | | +| dans les fichiers tailles et capt il y a une donnée dans le fichier | | +| traits | Fatal | ++-----------------------------------------------------------------------------+----------+ + +Croissement avec le reférentiel taxonomique +------------------------------------------- + ++-----------------------------------------------------------------------------+----------+ +| Vérifications | Niveau | ++=============================================================================+==========+ +| Le champs Especes du fichier Captures doit correspondre à une espèce | | +| présente dans le référentiel taxonomique | Erreur | ++-----------------------------------------------------------------------------+----------+ +| Le champs Especes du fichier Taille doit correspondre à une espèce | | +| présente dans le référentiel taxonomique | Erreur | ++-----------------------------------------------------------------------------+----------+ Added: trunk/src/site/rst/en/user/guide_project.rst =================================================================== --- trunk/src/site/rst/en/user/guide_project.rst (rev 0) +++ trunk/src/site/rst/en/user/guide_project.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,75 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Projet +====== + +La permière action a effectuer pour traiter les 4 tables de données est de +créer un projet en y renseignant ses paramètres (y compris les 4 tables). + +Configuration +------------- + +Pour se faire, il suffit d'afficher l'interface de création de projet depuis +le menu *Fichier/Nouveau projet*. L'interface suivante s'affiche: + +.. image:: ../images/02-createproject.png + +Cette interface doit contenir: + + * le nom du projet (les caracteres autre que les lettres et chiffres + sont interdit) + * le nom de l'auteur (obligatoire) + * les fichiers csv correspondant aux 4 tables (obligatoire) + * les cartes aux format shapes (*.shp) utilisé dans l'étape de sélection + pour affiché la zone d'application sur la carte du monde + * un commentaire + +Il est egalement possible d'utiliser pour ce projet seulement un autre +fichier de référence taxonomique que celui présent dans la configuration +par défaut du logiciel. Il sera utilisé uniquement par ce projet. + +Validation +---------- + +Après avoir cliqué sur le bouton ``Créer le projet``, les 4 tables et le +référentiel taxonomique sont chargés en mémoire. +Le logiciel vérifie ensuite que les fichiers sont dans le format attendu +(CSV, séparateur, nom des entetes) puis crée le projet et affiche l'interface +de résumé de projet : + +.. image:: ../images/04-projectsummary.png + +Réouverture de projet +--------------------- + +Pour réouvrir un projet précédamment créé, il suffit de le sélectionner +dans l'interface *Fichier/Ouvrir un projet* puis de cliquer sur `Ouvrir`: + +.. image:: ../images/03-openproject.png + +Il est ensuite possible de passer aux étapes de controle_ ou de selection_. + +.. _controle: guide_control.html +.. _selection: guide_selection.html Added: trunk/src/site/rst/en/user/guide_results.rst =================================================================== --- trunk/src/site/rst/en/user/guide_results.rst (rev 0) +++ trunk/src/site/rst/en/user/guide_results.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,67 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Résultats RSufi +=============== + +Un fois que les données de votre sélection ont été utilisées pour faire +tourner RSufi, celui ci vous fournit des résultats qu'il est possible +d'ajouter dans la liste des résultats d'une selection. + +Pour ce faire, réouvrez la sélection concernée via le menu *Données/Sélection/<nomdelaselection>* +et sélectionnez le troisième onglet ``RSufi``. + +.. image:: ../images/25-selectionresults.png + +Cette fois ci, c'est la seconde partie de l'interface qui nous interesse. Elle +récapitule la liste des résultats actuellement enregistré dans Coser. + +Pour ajouter un nouveau résultat, cliquez sur le bouton ``Ajouter un résultat``. + +.. image:: ../images/26-selectionaddresult.png + +Un résultat est composé de : + + * un nom unique parmi les résultats de la sélection (obligatoire et composé + uniquement de caracteres alphanumériques) + * la version de rsufi avec laquelle le résultat a été obtenu (obligatoire) + * la date d'ajout du résultat (obligatoire) + * le fichier de données ``estcomind`̀ (obligatoire) + * le fichier de données ``estpopind`` (obligatoire) + +À cela s'ajoute des options facultatives : + + * la zone d'application (utilisé lors de la publication de résultat sur + le site internet pour placé un résultat dans un zone définie) + * le répertoire de cartes (utilisé par le site internet pour afficher + les cartes de distribution) + * publiable (utilisé par les administrateurs pour différencier les résultats + publiable des autres résultats) + * autre fichier (fichier supplémentaire devant être concervé par Coser) + +Une fois le résultat paramètré sans erreur, cliquer sur ``Ajouter le résultat`` +pour valider l'action. Ce resultat pourra ensuite être sélectionné par les +administrateur de Coser en vue d'être publié sur le site internet : +http://www.ifremer.fr/SIH-indices-campagnes/ + Added: trunk/src/site/rst/en/user/guide_selection.rst =================================================================== --- trunk/src/site/rst/en/user/guide_selection.rst (rev 0) +++ trunk/src/site/rst/en/user/guide_selection.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -0,0 +1,152 @@ +.. - +.. * #%L +.. * Coser +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 - 2011 Ifremer, Codelutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Lesser 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 Lesser Public License for more details. +.. * +.. * You should have received a copy of the GNU General Lesser Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/lgpl-3.0.html>. +.. * #L% +.. - +Séléction +========= + +L'étape de sélection consiste a sélectionner les listes d'espèces suivante +en paramètres d'entrée de rsufi : + + * L1 : Liste des espèces sélectionnées + * L2 : Liste des espèces de L1 respectant un filtre d'occurrence/densité + * L3 : Liste des espèces de L2 avec des tailles pour toutes les années + * L4 : Liste des espèces de L3 avec des maturités + + +Création de la sélection +------------------------ + +La première étape consiste a définir les paramètres de la sélection pour Coser. + +Pour cela, utiliser le menu ``Selections/Nouvelle sélection`` + +.. image:: ../images/21-selectionmenu0.png + +**Note**: Ce menu n'est disponible que si l'étape de contrôle est été validée. + +.. image:: ../images/20-selectiondetails.png + +Le nom est obligatoire et ne doit contenir que des caratères alphanumériques. + +Il faut ensuite selectionner les années sur lesquelles porterons les données +de la sélection. Les données des 4 tables seront restreinte aux années +sélectionnées. + +.. image:: ../images/21-selectionyears.png + +Il faut ensuite sélectionner les strates pour lesquelles on souhaite +sélectionner des espèces. + +.. image:: ../images/22-selectionstrata.png + +Dans cette étape il est également possible d'afficher les données +de l'effort d'échantillonage est cliquant sur l'icone en forme de table. + +Arrive enfin l'étape de sélection des espèces à inclure dans la liste L1. Cette +étape récapitule la liste de toutes les espèces disponible suite aux choix +des années et des strates. + +.. image:: ../images/23-selectionspecies.png + +La liste ``Espèces filtrées`` correspond à la liste de toutes les espèces. Cette +liste est filtrable par les types de la liste ``Filtrer par type``. + +Pour ajouter une espèce dans la liste L1, il faut la sélectionner et cliquer +sur le bouton ``flêche droite``. + +Les deux listes de cette étape comporte de menu contextuel permettant de : + + * fusionner des espèces + * générerer les graphiques de comparason captures/tailles + * etc... + +.. image:: ../images/26-selectionmenu1.png + + +Rapport +------- + +Il est possible de générer un rapport comportant toutes les informations de +la sélection est cliquant sur le bouton ``Rapport de sélection``. Ce rapport +est au format html et doit s'ouvrir dans votre navigateur pour être +visualisé et imprimé. + + +Listes des espèces +------------------ + +Une fois la liste L1 définie, il faut sauvegarder la sélection pour +que l'onglet ``Listes des espèces`` devienne actif. + +.. image:: ../images/24-selectionlists.png + +Dans cet écran : + + * La liste L1 correspond à la liste défini lors de l'étape précédente + * La liste L2 correspond à la liste des especes filtrées par le filtre + du pourcentage minimum d'occurrence et du nombre d'individu minimum + au km2 + * La liste L3 récapitule parmi les espèces sélectionnées de la liste L2, + celles qui ont des tailles pour toutes les années + * enfin la liste L4 récapitule, parmi les espèces sélectionnées de la + liste L3, celles qui ont des maturités. + +À noter: + + * seule les espèces **sélectionnée** (en surbrillance) sont prise en compte + * si vous modifier la sélection par defaut proposé par le logiciel, vous + devez justifier votre choix en renseignant un commentaire en dessous + de la liste concernée + +Une fois les 4 listes d'espèces définie, vous pouvez finaliser la selection +en la validant. Pour cela cliquer sur le bouton ``Valider la sélection``. + + +Export des données en entrée de RSUfi +------------------------------------- + +Une fois les 4 listes définie et la sélection validée, le troisième onglet +"RSUfi" devient actif. + +.. image: ../images/25-selectionresults.png + +Dans cet écran, vous pouvez exporter les fichiers nécessaires à l'execution +de RSufi. Attention cependant, Coser ne pilote pas RSUfi, il ne fait que +générer les fichiers nécéssaire à son execution. + +Le dossier généré contient: + + * les 4 tables de données (avec seulement les années selectionnées lors + de l'étape de sélection) + * un fichier détaillant les 4 listes d'especes (L1, L2, L3, l4) + * un fichier d'information relatif au projet + + +Resultat +-------- + +Une fois que RSufi a été executé avec les paramètres de votre sélection, +vous pouvez passer à l'étape d'`enregistrement des résultats`_. + +.. _enregistrement des résultats: guide_results.html Modified: trunk/src/site/rst/user/guide_listcontrols.rst =================================================================== --- trunk/src/site/rst/user/guide_listcontrols.rst 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/rst/user/guide_listcontrols.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -129,8 +129,8 @@ +=================+================================================================+==========+ | Campagne | Champs obligatoire | Erreur | +-----------------+----------------------------------------------------------------+----------+ -| Année | Champs composé de 4 chiffres obligatoires et 2 chiffres | Erreur | -| | facultatifs séparés par un point (trimestre) ex: 2002.25 | | +| | Champs composé de 4 chiffres obligatoires et 2 chiffres | | +| Année | facultatifs séparés par un point (trimestre) ex: 2002.25 | Erreur | +-----------------+----------------------------------------------------------------+----------+ | Traits | Composé de lettres et chiffres | Erreur | +-----------------+----------------------------------------------------------------+----------+ @@ -187,7 +187,7 @@ | dans le fichier tailles (noté Annee/Trait/Espece) il y a une donnée | | | dans le fichier captures (le contraire n'est pas vraie) | Fatal | +-----------------------------------------------------------------------------+----------+ -| Vérification que pour chaque trait présent une année (noté Annee/Trait) | | +| Vérification que pour chaque trait présent une année (noté Annee/Trait) | | | dans les fichiers tailles et capt il y a une donnée dans le fichier | | | traits | Fatal | +-----------------------------------------------------------------------------+----------+ Modified: trunk/src/site/rst/user/guide_results.rst =================================================================== --- trunk/src/site/rst/user/guide_results.rst 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/rst/user/guide_results.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -25,4 +25,43 @@ Résultats RSufi =============== +Un fois que les données de votre sélection ont été utilisées pour faire +tourner RSufi, celui ci vous fournit des résultats qu'il est possible +d'ajouter dans la liste des résultats d'une selection. +Pour ce faire, réouvrez la sélection concernée via le menu *Données/Sélection/<nomdelaselection>* +et sélectionnez le troisième onglet ``RSufi``. + +.. image:: ../images/25-selectionresults.png + +Cette fois ci, c'est la seconde partie de l'interface qui nous interesse. Elle +récapitule la liste des résultats actuellement enregistré dans Coser. + +Pour ajouter un nouveau résultat, cliquez sur le bouton ``Ajouter un résultat``. + +.. image:: ../images/26-selectionaddresult.png + +Un résultat est composé de : + + * un nom unique parmi les résultats de la sélection (obligatoire et composé + uniquement de caracteres alphanumériques) + * la version de rsufi avec laquelle le résultat a été obtenu (obligatoire) + * la date d'ajout du résultat (obligatoire) + * le fichier de données ``estcomind`̀ (obligatoire) + * le fichier de données ``estpopind`` (obligatoire) + +À cela s'ajoute des options facultatives : + + * la zone d'application (utilisé lors de la publication de résultat sur + le site internet pour placé un résultat dans un zone définie) + * le répertoire de cartes (utilisé par le site internet pour afficher + les cartes de distribution) + * publiable (utilisé par les administrateurs pour différencier les résultats + publiable des autres résultats) + * autre fichier (fichier supplémentaire devant être concervé par Coser) + +Une fois le résultat paramètré sans erreur, cliquer sur ``Ajouter le résultat`` +pour valider l'action. Ce resultat pourra ensuite être sélectionné par les +administrateur de Coser en vue d'être publié sur le site internet : +http://www.ifremer.fr/SIH-indices-campagnes/ + Modified: trunk/src/site/rst/user/guide_selection.rst =================================================================== --- trunk/src/site/rst/user/guide_selection.rst 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/rst/user/guide_selection.rst 2011-02-08 14:00:41 UTC (rev 704) @@ -45,7 +45,7 @@ **Note**: Ce menu n'est disponible que si l'étape de contrôle est été validée. -.. image:: ../images/20-selectiondetails +.. image:: ../images/20-selectiondetails.png Le nom est obligatoire et ne doit contenir que des caratères alphanumériques. @@ -55,25 +55,25 @@ .. image:: ../images/21-selectionyears.png -Il faut ensuite sélectionner les strates pour lesquelles ont souhaite -sélectionner des especes. +Il faut ensuite sélectionner les strates pour lesquelles on souhaite +sélectionner des espèces. .. image:: ../images/22-selectionstrata.png Dans cette étape il est également possible d'afficher les données de l'effort d'échantillonage est cliquant sur l'icone en forme de table. -Arrive enfin l'étape de selection des espèces à inclure dans la liste L1. Cette +Arrive enfin l'étape de sélection des espèces à inclure dans la liste L1. Cette étape récapitule la liste de toutes les espèces disponible suite aux choix des années et des strates. .. image:: ../images/23-selectionspecies.png La liste ``Espèces filtrées`` correspond à la liste de toutes les espèces. Cette -liste est filtrable par les types de la liste `Filtrer par type`. +liste est filtrable par les types de la liste ``Filtrer par type``. Pour ajouter une espèce dans la liste L1, il faut la sélectionner et cliquer -sur le bouton `flêche droite`. +sur le bouton ``flêche droite``. Les deux listes de cette étape comporte de menu contextuel permettant de : @@ -90,7 +90,7 @@ Il est possible de générer un rapport comportant toutes les informations de la sélection est cliquant sur le bouton ``Rapport de sélection``. Ce rapport est au format html et doit s'ouvrir dans votre navigateur pour être -visualiser et imprimer. +visualisé et imprimé. Listes des espèces @@ -117,7 +117,7 @@ * seule les espèces **sélectionnée** (en surbrillance) sont prise en compte * si vous modifier la sélection par defaut proposé par le logiciel, vous devez justifier votre choix en renseignant un commentaire en dessous - de la liste concerné + de la liste concernée Une fois les 4 listes d'espèces définie, vous pouvez finaliser la selection en la validant. Pour cela cliquer sur le bouton ``Valider la sélection``. @@ -129,7 +129,7 @@ Une fois les 4 listes définie et la sélection validée, le troisième onglet "RSUfi" devient actif. -.. image: ../images/26-selectionresults.png +.. image: ../images/25-selectionresults.png Dans cet écran, vous pouvez exporter les fichiers nécessaires à l'execution de RSufi. Attention cependant, Coser ne pilote pas RSUfi, il ne fait que Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/site_en.xml 2011-02-08 14:00:41 UTC (rev 704) @@ -25,7 +25,7 @@ --> <project name="${project.name}"> - + <bannerLeft> <src>/icons/logo100.png</src> <href>index.html</href> Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2011-02-08 13:04:48 UTC (rev 703) +++ trunk/src/site/site_fr.xml 2011-02-08 14:00:41 UTC (rev 704) @@ -61,15 +61,15 @@ <item name="Format des tables" href="user/dataformat.html" /> <item name="Projet" href="user/guide_project.html" /> <item name="Contrôle" href="user/guide_control.html" /> - <item name="Liste des contrôles" href="user/guide_listcontrols.html" /> <item name="Sélection" href="user/guide_selection.html" /> <item name="Résultat RSufi" href="user/guide_results.html" /> <item name="FAQ" href="user/faq.html" /> </item> - <!-- <item name="Avancé" href="user/controls.html"> - <item name="Contrôles" href="user/controls.html" /> + <item name="Avancé" href="user/controls.html"> + <item name="Liste des contrôles" href="user/guide_listcontrols.html" /> + <item name="Modification des contrôles" href="user/controls.html" /> </item> - <item name="Développeur" href="developer.html"> + <!-- <item name="Développeur" href="developer.html"> <item name="Coser Project layout" href="devel/directory.html" /> </item> --> </menu>