$i18n.getString(

Documentation technique de SEASON

Liens du projet :

Organisation du code

Le code source est organisé ainsi :

  • pom.xml : fichier Maven
  • sql/ : structures et données de la base de données des simulations et résultats. Voir la description des fichiers SQL.
  • src/site/ : documentation, voir ci-dessous

Le code est découpé en plusieurs modules :

  • cli : client en ligne de commande pour envoyer les simulations et/ou lancer une unité de calcul,
  • core : le coeur, utilisable par le client en ligne de commande ou par l'application web SICLIMA Calcul.
  • core-test : configurations et données de tests pour le coeur et pour SICLIMA.

Chaque module est organisé ainsi :

  • src/main/ : code source
  • src/test/ : code pour les tests

Documentation

La documentation est écrite dans le dossier /src/site/markdown/. L'arborescence du site est définie dans /src/site/site.xml. Les formats plein texte sont préférés pour pouvoir gérer les versions. Ce document est écrit dans le format Markdown.

Les diagrammes UML sont créés dans le format PlantUML (extension .puml dans /src/site/resources/images/). Voici les préfixes pour les diagrammes :

  • act- : diagrammes d'activité
  • cas- : diagrammes de cas d'utilisation
  • cls- : diagrammes de classe
  • cmp- : diagrammes de composants
  • seq- : diagrammes de séquence

La documentation technique est générée par Maven avec la commande mvn site à target/site/index.html, cli/target/site/index.html et core/target/site/index.html. Un fichier PDF regroupant uniquement la documentation, sans les rapports techniques, est généré par Maven avec la commande mvn pdf:pdf à target/pdf/season.pdf.

Jetty peut être utilisé pour le rendu en temps réel, c'est-à-dire qu'il suffit de rafraîchir le navigateur pour afficher les changements : utiliser mvn site:run et visiter le lien, généralement http://localhost:8080/.

Au besoin, regénérer les diagrammes UML avec la commande mvn com.github.jeluard:plantuml-maven-plugin:generate.