Manuel d`utilisation Logiciel H2D2
Contents
1. labor en partant des besoins du public cible ce dernier tant le nouvel utilisateur d H2D2 qui poss de des connaissances en hydraulique et en programmation mais qui peut tout aussi bien se trouver au Qu bec qu ailleurs dans le monde Il est donc n cessaire de d velopper un outil accessible facilement disponible peu importe o l on se trouve Aussi comme la majorit des ouvrages scientifiques et de mani re rejoindre un public le plus large possible le manuel est r dig en anglais M dium Plusieurs autres crit res entrent en ligne de compte dans le choix du m dium Le manuel doit tre facile utiliser et simple consulter De plus comme les mises jour du logiciel sont fr quentes le contenu du manuel doit tre dynamique et facile mettre jour il ne peut donc tre en format papier Le contenu doit tre ais ment modifiable et il doit aussi y avoir la possibilit d ajouter les contributions faites par des utilisateurs du logiciel C est ainsi que l id e d avoir un manuel sous la forme d un site Web dynamique similaire un Wiki s est impos e d elle m me Divisions du site la base l id e est de retrouver trois grandes sections dans le manuel une section didactique sous forme d un tutoriel une section langage plus sous la forme d un document de r f rence et enfin une foire aux questions L id e de faire une section tutoriel est de prendre un utilisateur d butant e2. selon les derniers ajouts et derni res versions du logiciel Le fait d avoir un manuel en ligne permettra aux utilisateurs d y avoir acc s de partout et de faire ais ment le lien entre concepteurs et utilisateurs de H2D2 pour les deux puissent travailler de pair Aussi le manuel d utilisation de H2D2 pourra tre mis a jour avec les contributions des utilisateurs de H2D2 membres du site via le forum Manuel d utilisation de H2D2 13
3. Manuel d utilisation Logiciel H2D2 Rapport de recherche R1051 mars 2009 Manuel d utilisation Logiciel H2D2 Pr sent a Environnement Canada H2D2 Mars 2009 Copyright 2009 INRS Equipe de r alisation Institut National de la Recherche Scientifique Centre Eau Terre Environnement Yves Secretan Ph D professeur Pascale Dub Agente de liaison INRS ETE 2009 ISBN 978 2 89146 594 6 Pour fins de citations Secretan Y Dub P 2009 Manuel d utilisation Logiciel H2D2 Rapport de recherche INRS ETE R1051 Table des mati res Table d s mati res inst Re SE od ili FPS UE SIGS Bones A nee ei V Introduciendo edo ad os e dos ess a tit 1 Destripuondes CHOIK iii lie elite 3 anje O R E Sev ee em eee 3 Medium ina 3 Divisions gusien en ee OS 3 Outil de conception A eimai E een einen 4 Role N RS TA AA AONE ES AEAEE E EEA E ot Ed 4 Arborescence du site de H2D2 anina a a a a a a a a iea 7 Content dust OE TA A EEE I E ea T A 9 Ve EE ARP NR 9 2 IESCHPUON ER ee ns aah ie een 9 Ze Introduction HD ad 9 2 2 Historique et utilisation du logiciel oa 9 2 3 Desenpti n de FZ D2 nee nee ornare ae eG ia ania 9 3 Documentations sr es ET 9 SAME LRO u Te PP NA 9 Se A A SORTE nee et ete ete 9 SN le a an ee en el de Vin nsaiensadg 10 321 3 Partie 225 O td Sen een Lot its Ti 10 EME A E yE 3 2 es en N ee de Bene ne 10 3 18 Partie 2 Ba rss a ld BIER SS en Gives 10 3 1 6 Ghapitres SCH e
4. ajout il est plus libre d acc s mais r gul par l administrateur Il permet aux membres du site de poster leurs questions qui peuvent ensuite se Manuel d utilisation de H2D2 3 Description des choix retrouver dans la section FAQ Le manuel doit galement inclure une section documentation l id e a d abord t avanc e de la subdiviser en deux sections la documentation technique et la documentation scientifique Dans la version finale la documentation scientifique est ins r e a l int rieur de la section l ments pour chaque type de simulation la fin La section l ments fournit aussi pour chaque type de simulation une description les param tres et la solution initiale fournir Outil de conception Le logiciel CMS Open Source Plone a t choisi pour la cr ation du manuel ce syst me de gestion de contenu permet ais ment de cr er des pages Web d ajouter du contenu sur des pages Web existantes et de g rer ces pages Les modifications des pages ne peuvent tre faites que via le CMS par les utilisateurs enregistr s Le CMS permet de cr er un forum de discussion sur lequel les membres du site peuvent s exprimer avec leurs questions et commentaires Quiconque en fait la demande peut devenir membre avec l approbation de l administrateur du site L obligation de cr er un compte utilisateur pour participer au forum permet de r duire davantage le vandalisme et les pourriels De plus le fo
5. ce du site de H2D2 Arborescence du site de H2D2 Le sch ma de la page suivante la Figure 1 1 pr sente l arborescence du site de H2D2 dans sa version finale L arborescence est divis e en six sections principales elles m mes subdivis es selon la structure suivante 1 Home 2 Description 2 1 Introduction H2D2 Introduction to H2D2 2 2 Historique et utilisation du logiciel History and uses of the software 2 3 Description de H2D2 Description of H2D2 3 Documentation 3 1 Tutoriel Tutorial 3 1 1 Syntaxe Syntax 3 1 2 Partie 1 Part 1 3 1 3 Partie 2 Part 2 3 1 4 Partie 3 Part 3 3 1 5 Partie 4 Part 4 3 1 6 Chapitres sp cifiques Specific Chapters 3 1 7 Chapitres avanc s Advanced Chapters 3 2 El ments Elements 3 3 Commandes Commands 3 4 FAQ 3 5 Glossaire Glossary 3 6 R f rences References 4 T l chargement Download 4 1 Installation 5 Documentation technique Technical Documentation 5 1 File formats 5 2 For programmers 5 2 1 Programmers manual 6 Forum Manuel d utilisation de H2D2 Arborescence du site de H2D2 Figure 1 1 Sch ma de l arborescence du site de H2D2 H2D2 to H2D2 History and Part 1 Documentation uses of the software Description of H2D2 Part 2 Part 3 Part 4 Specific Programmers manual Chapters Advanced Chapters 8 Manuel d utilisation de H2D2 Contenu du site Contenu du site Cette
6. en eas ed ba dence ese aaa 10 3 1 7 Chapitres avanc s nee idi EE Re ee ae den oe Ga 10 TI M ee es TS OOOO a su E E 10 COM ts 11 3 2 LAO a o er o e e et ds en a e o AS 11 OO a e e ds e one 11 SOL RELETENCES te a Beeren e css 11 A Ls 0532 ee Rd ne sde een e 11 AS O RO 11 5 Documentation te coque nai ee ee 11 Sel Formats de Tea tatoo 11 GO Forum NN 12 CA AAA elspen eine heissen TIERE conan Un ds eee Ds 13 Listes des figures Figure 1 1 Sch ma de l arborescence du site de H2D2 Introduction Introduction Le but de ce projet est la cr ation d un manuel d utilisation pour le logiciel H2D2 successeur des logiciels Hydrosim et Dispersim qui n avait aucun document de r f rence Le manuel utilisation doit la fois permettre a l utilisateur d butant de savoir par o commencer et a l utilisateur expert de pouvoir s y r f rer Le choix a t fait de publier le manuel sur un site Web Le pr sent rapport pr sente et explique les choix qui ont t faits choix de langue du m dium des divisions du site ainsi que l outil de conception Il pr sente aussi les r les du site de H2D2 Enfin il pr sente la structure du site Cependant le contenu se trouve sur le site lui m me a adresse suivante http www gre ehn ete inrs ca H2D2 Manuel d utilisation de H2D2 1 Description des choix Description des choix Langue Le manuel d utilisation du logiciel H2D2 est
7. pr sentation du contenu du site est une description plus d taill e du contenu de la structure du site de H2D2 Comme mentionn pr c demment le contenu du site se retrouve a adresse suivante http www gre ehn ete inrs ca H2D2 1 Home 2 Description 2 1 Introduction a H2D2 Cette section pr sente brievement le logiciel et ses caract ristiques Elle fait un historique de la cr ation du logiciel et pr sente les possibilit s du logiciel ainsi que des projets sur lesquels il a t utilis Cette section fournit galement une description du logiciel ainsi qu une description des tapes principales d un fichier de simulation type 2 2 Historique et utilisation du logiciel e Historique e Utilisation 2 3 Description de H2D2 e Description e Fichier de commande 3 Documentation 3 1 Tutoriel Cette section est la section d apprentissage du logiciel Elle est d abord introduite par une section expliquant la syntaxe du langage utilis par H2D2 Puis chaque partie du tutoriel explique a Putilisateur comment r soudre une probl matique de A Z Les tutoriels sont divis s par type de probl me et par niveau de complexit Chaque tutorial est ensuite subdivis selon les grandes tapes du processus de r solution de probleme avec H2D2 3 1 1 Syntaxe Cette section d finit les bases du langage de programmation utilis par H2D2 ainsi que sa structure C est dans cette section que sont d finis les mots cl
8. puisqu ils pourront y poster leurs questions et les autres utilisateurs pourront y r pondre directement Ils pourront ainsi avoir une r ponse rapide aux problemes courants Il pourra tre subdivis par sujet ou par fonction Il serait aussi prot g par un log in pour viter le vandalisme 12 Manuel d utilisation de H2D2 Conclusion Conclusion La structure du site de H2D2 est pr sentement en place La mise en place du contenu est pr sentement toujours en cours Les sections suivantes sont publi es e Dans la section Description de H2D2 l introduction e Dans la section Tutoriel e le document Syntaxe e la premi re partie une simulation de Convection Diffusion 2D de contaminant conservatif e la seconde partie une simulation non stationnaire de Convection Diffusion 2D de coliformes f caux e Dans la section Documentation e le document Glossaire e Jes r f rences Dans la section Tutoriel la troisi me partie une simulation de St Venant 2D et la quatri me partie un couplage de simulation de St Venant et de Convection Diffusion Non Stationnaire ainsi que les sections l ments Chapitres avanc s et sp cifiques le seront au cours des prochaines semaines Le manuel restera un processus continu et sera toujours a jour qui pourra tre facilement aliment gr ce l outil de conception choisi le CMS Open Source Plone Le CMS permettra une gestion efficace et des mises jour rapides du manuel
9. rum permet de cerner les questions les plus fr quentes des utilisateurs et de les ajouter au fur et mesure la FAQ R les du site Les r les du site de H2D2 sont les suivantes e Utilisateur Possibilit de rechercher dans tout le site avec la fonction Rechercher Possibilit de devenir membre du site Possibilit de participer au forum apr s connexion au compte utilisateur Possibilit d acc der au contenu des diff rentes sections par la fonction Rechercher par la navigation contextuelle m me la page et avec les onglets de navigation primaire Possibilit de communiquer avec l administrateur du site e Reviseur Possibilit de cr er de nouvelles sections au site via le CMS Possibilit de cr er supprimer des pages Web Possibilit d diter du contenu sur les pages Web 4 Manuel d utilisation de H2D2 Description des choix e Administrateur Possibilit de cr er de nouvelles sections au site via le CMS Possibilit de cr er supprimer des pages Web Possibilit d diter du contenu sur les pages Web Possibilit de refuser d accepter une demande de membership Possibilit de g rer les messages du forum Possibilit d ajouter ou de supprimer d autres utilisateurs enregistr s pour le CMS Possibilit de refuser ou d accepter la cr ation d une page par un r viseur Manuel d utilisation de H2D2 5 Arborescen
10. s les op rateurs les symboles ainsi que les principaux concepts objets et param tres utilis s par H2D2 Manuel d utilisation de H2D2 9 Contenu du site 3 1 2 Partie 1 Cette section d crit une simulation de Convection Diffusion 2D simple Contaminant conservatif 3 1 3 Partie 2 Cette section d crit une simulation de Convection Diffusion 2D Non Stationnaire Coliformes fecaux 3 1 4 Partie 3 Cette section d crit une simulation en travail 3 1 5 Partie 4 Cette section d crit un couplage de simulation de St Venant et de Convection Diffusion Non Stationnaire en travail 3 1 6 Chapitres sp cifiques Cette section referme des informations sur des items sp cifiques notamment sur l utilisation de la commande Log 3 1 7 Chapitres avanc s Cette section comprend des descriptions de probl matiques plus avanc es dont e le partitionnement et la renum rotation e le backtracking e Jes crit res d arr t 3 2 l ments Cette section comprend pour chaque type de probl me e une description du probl me qui est r solu e les param tres qui doivent tre d finis d pendamment du type de simulation e la solution initiale qui doit tre fournie e la documentation scientifique connexe disponible en format statique pdf 10 Manuel d utilisation de H2D2 Contenu du site 3 3 Commandes Cette section est dynamique et g n r e automatiquement et regroupe les commande
11. s de H2D2 avec une br ve description et les param tres reli s 3 4 FAQ Cette section est une foire aux questions FAQ Elle est subdivis e par grands themes des plus simples aux plus complexes Les questions qui seront pos s sur le forum particuli rement les questions r currentes serviront a alimenter la FAQ 3 5 Glossaire Cette section est un r pertoire des termes sp cialis s relatifs 4 H2D2 maillages l ments connectivit s etc et leur d finition 3 6 References Cette section comprend les references des documents utilis s pour la cr ation de ce site 4 T l chargement 4 1 Installation Cette section sp cifie l utilisateur e le mat riel requis pour faire fonctionner H2D2 Hardware requirements e comment installer le logiciel e la structure des fichiers e comment lancer le logiciel e comment afficher le menu d aide e comment afficher Hello world comment arr ter le logiciel 5 Documentation technique 5 1 Formats de fichiers Cette sous section de la Documentation technique regroupe les mod les de formats de fichiers pour les fichiers d entr e a fournir e fichier de valeur nodale ou l mentaire Manuel d utilisation de H2D2 Contenu du site e fichier de partitionnement et de renum rotation e fichier de limites conditions limites e fichier de conditions conditions limites 6 Forum Cette section permet aux utilisateurs de s entraider
12. t de le guider pas pas dans au travers de toutes les tapes d une simulation simple de H2D2 et ce pour les principaux types de simulation du plus complexe au plus simple L utilisateur encore peu initi au logiciel doit tre capable de faire une simulation compl te l aide du tutoriel La section langage est principalement un document de r f rence avec les commandes de H2D2 et une description de leur utilisation Cette section part des pages g n r es automatiquement par le code de H2D2 en les toffant et en les compl tant avec l inclusion une br ve description des classes commandes des arguments et des m thodes Enfin la FAQ rassemble les questions des utilisateurs galement avec des r ponses aux probl mes plus complexes Le manuel doit galement inclure une description du logiciel de ses possibilit s ainsi qu une section sur les bases du langage utilis de la syntaxe de H2D2 Aussi l id e a t avanc e de faire la FAQ sous forme d un Wiki Cependant il y avait d j en place une structure similaire un CMS Content Management System tres efficace et qui permettait d j d ajouter des r viseurs et des r dacteurs la mani re d un Wiki En donnant des droits certaines personnes on permettra ces derni res de contribuer au site et d ajouter du contenu qui doit tre pr alablement approuv Aussi pour permettre a aux utilisateurs de H2D2 qui le souhaitent de s exprimer un forum a t
Download Pdf Manuals
Related Search