Author: jcouteau Date: 2011-02-09 10:51:42 +0000 (Wed, 09 Feb 2011) New Revision: 728 Log: End of doc translation to english Modified: trunk/src/site/en/rst/index.rst trunk/src/site/en/rst/user/guide_project.rst trunk/src/site/en/rst/user/guide_results.rst trunk/src/site/en/rst/user/guide_selection.rst Modified: trunk/src/site/en/rst/index.rst =================================================================== --- trunk/src/site/en/rst/index.rst 2011-02-09 09:17:58 UTC (rev 727) +++ trunk/src/site/en/rst/index.rst 2011-02-09 10:51:42 UTC (rev 728) @@ -25,5 +25,21 @@ Coser ===== -Contrôle et Sélection R­Sufi. +Coser (Control and Selection R­Sufi) is a data control (CSV export from +a database) and data selection before treatment by an external application +(RSufi) software. +The results from RSufi are then stored in the Coser software in order to be +selected and published on the website : +http://www.ifremer.fr/SIH-indices-campagnes. + +Features +======== + + * managing the 4 data files (catches, stratas, lengthes, hauls) + * control errors on teh data format + * control links with the taxonomic referential (reftax) + * modifications historisation + * charts generation + * species lsit selection for RSufi (L1, L2, L3 and L4) + * storing RSufi's results Modified: trunk/src/site/en/rst/user/guide_project.rst =================================================================== --- trunk/src/site/en/rst/user/guide_project.rst 2011-02-09 09:17:58 UTC (rev 727) +++ trunk/src/site/en/rst/user/guide_project.rst 2011-02-09 10:51:42 UTC (rev 728) @@ -22,54 +22,53 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Projet -====== +Project +======= -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). +The first thing to do to treat the 4 data tables is to create a project by +filling its parameters (and the 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: +To do so, display the project creation interface using the menu +*File/New project*. The following interface displays : .. image:: ../images/02-createproject.png -Cette interface doit contenir: +This interface must contains: - * 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 + * the project name (only alphanumerical characters are allowed). + * the name of the author (mandatory) + * The csv files correspond to the 4 tables (mandatory) + * the maps in shapes format (*.shp) used in the selection step to display the + application zone on the world map. + * a comment -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. +It is also possible to use, only for this project, an other taxonomic +referential file than the one present in the default configuration of the +software. It will be used only for this project. 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 : +After having clicked on the ``Create the project``, the 4 tables and the +taxonomic referential are loaded into memory. +The software checks then than the files are in the correct format (CSV, +separator, headers names) then create the project and displays the project +summary interface : .. image:: ../images/04-projectsummary.png -Réouverture de projet ---------------------- +Project reopening +----------------- -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`: +To reopen a project previously created, you just have to select it in the +*File/Open a project* then click on `Open`: .. image:: ../images/03-openproject.png -Il est ensuite possible de passer aux étapes de controle_ ou de selection_. +It is then possible to go to the control_ or selection_ step. -.. _controle: guide_control.html -.. _selection: guide_selection.html +.. _control: guide_control.html +.. _selection: guide_selection.html \ No newline at end of file Modified: trunk/src/site/en/rst/user/guide_results.rst =================================================================== --- trunk/src/site/en/rst/user/guide_results.rst 2011-02-09 09:17:58 UTC (rev 727) +++ trunk/src/site/en/rst/user/guide_results.rst 2011-02-09 10:51:42 UTC (rev 728) @@ -22,46 +22,44 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Résultats RSufi +RSufi Results =============== -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. +Once your selection data have been used in RSufi, it gives you the result that +is possible to add in the result list of a 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``. +To do so, reopen the concerned selection using the +*Data/Selection/<selectionname>* menu and Select the thirs tab ``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. +This time, this is the second part on the interface that interest us. It +summarize the list of results stored in Coser. -Pour ajouter un nouveau résultat, cliquez sur le bouton ``Ajouter un résultat``. +To add a new result, click on the button ``Add a result``. .. image:: ../images/26-selectionaddresult.png -Un résultat est composé de : +A result is compounded of : - * 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) + * a name unique amongst the selection results (mandatory and compounded only + of alphanumerical characters) + * the RSufi version with which the result have been obtained (mandatory) + * the result addition date (mandatory) + * the ``estcomind`` data file (mandatory) + * the ``estpopind`` data file (mandatory) -À cela s'ajoute des options facultatives : +You got also optional informations : - * 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) + * the application zone (used when publishing result in the internet website + to place the results in a defined zone) + * the maps directory (used by the website to display the distribution maps) + * publishable (used by admins to differenciate publishable results from + others) + * other file (other file that needs to be stored by 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 : +Once the result is parmaterized with no error, click on ``Add the result`` to +validate the action. This result will be then available to the Coser admins so +that they can publish it on the internet website : http://www.ifremer.fr/SIH-indices-campagnes/ Modified: trunk/src/site/en/rst/user/guide_selection.rst =================================================================== --- trunk/src/site/en/rst/user/guide_selection.rst 2011-02-09 09:17:58 UTC (rev 727) +++ trunk/src/site/en/rst/user/guide_selection.rst 2011-02-09 10:51:42 UTC (rev 728) @@ -22,131 +22,121 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - -Séléction +Selection ========= -L'étape de sélection consiste a sélectionner les listes d'espèces suivante -en paramètres d'entrée de rsufi : +The selection step consist in selecting the following lists as RSufi +parameters : - * 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 + * L1 : List of the selected species + * L2 : List of species from L1 respecting an occurence/density filter + * L3 : List of species form L2 with lengthes for all the years + * L4 : List of species from L3 with maturity +Selection creation +------------------ -Création de la sélection ------------------------- +The first step consist in defining the selection parameters for Coser. -La première étape consiste a définir les paramètres de la sélection pour Coser. +To do so, use the menu ``Selection/New selection`` -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. +**Note**: This menu is available only if the control step have been validated. .. image:: ../images/20-selectiondetails.png -Le nom est obligatoire et ne doit contenir que des caratères alphanumériques. +This name is mandatory and can contain only alphanumerical characters. -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. +You have then to select the years of the selection data. The 4 tables data will +be restricted to those years. .. image:: ../images/21-selectionyears.png -Il faut ensuite sélectionner les strates pour lesquelles on souhaite -sélectionner des espèces. +You then need to select the stratas for which you want to select species. .. 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. +In this step, it is also possible to display sampling effort data by clicking on +the table-shape icon. -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. +Then comes the species selection step to include in the L1 list. This step +summarize the list of all the species available after the choice of years and +stratas. .. 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``. +The list ``Filtered species`` correspond to the list of all the species. this +list is filterable by the ``Filter by type`` list types. -Pour ajouter une espèce dans la liste L1, il faut la sélectionner et cliquer -sur le bouton ``flêche droite``. +To adjust a species in the L1 list, you have to select it and click on the +``right arrow`` button. -Les deux listes de cette étape comporte de menu contextuel permettant de : +The two lists of this step got contextual menus allowing to : - * fusionner des espèces - * générerer les graphiques de comparason captures/tailles - * etc... + * merge species + * generate catch/length comparison charts + * etc… .. image:: ../images/26-selectionmenu1.png -Rapport -------- +Report +------ -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é. +It is possible to generate a report that got all the selection information by +clicking on the ``Selection report`` button. This report is in html format and +should open in your browser to be visualised and printed. +Species list +------------ -Listes des espèces ------------------- +Once the L1 list have been defined, you need to save the selection so that +the ``Species list`` tab become active. -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 : +In this screen : - * 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. + * The L1 list correspond to the list defined in the previous step + * The L2 list correspond to the list of filtered species using the minimum + occurence percentage and the minimum number of individuals per square + kilometers + * The L3 list summarize the species selected in L2 list that got lengthes for + every year + * The L4 list summarize, amongst the L3 species, the ones that got maturities. -À noter: +To be noted : - * 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 + * Only the **selected** species (highlighted) are taken into account + * If you modify the default selection, you will have to justify your choice by + filling in a comment bellow the concerned list -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``. +Once the 4 species list defined, you can finalize the selection by validating +it clicking on the `` Validate selection`` button. +Export the data for RSufi +------------------------- -Export des données en entrée de RSUfi -------------------------------------- +Once the 4 lists are defined and the selection validated, the third tab "RSufi" +become active. -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. +In this screen, you can export the necessary files for RSufi's execution. Take +care, Coser does not pilot RSufi, it only generates the files needed for its +execution. -Le dossier généré contient: +The generated file contains : - * 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 + * the 4 data tables (with only the years selected) + * a file detailing the 4 species lists (L1, L2, L3 and L4) + * a project information file +Result +------ -Resultat --------- +Once RSufi have been executed with your selection, you can go to the +`results storing` step. -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 +.. _results storing: guide_results.html