SIC^2 : Logiciel de Simulation Intégrée des Canaux et de leur Contrôle

Introduction

David Dorchies — 2012-09-26T08:11:24Z

Les différentes fonctionnalités de SIC sont utilisables à partir du programme d'édition et de visualisation des résultats « EdiSIC ». Cela suffit pour une utilisation courante du logiciel. Les utilisateurs désirant réaliser des opérations plus complexes telles que de l'optimisation auront besoin d'automatiser les opérations courante (exécution des différents programmes TALWEG, FLUVIA, SIRENE, traitement des résultats...) sans passer par l'interface utilisateur.

Cette section décrit les différentes fonctionnalités du logiciel disponibles à partir d'une ligne de commande aussi appelé « mode Batch ». Cette ouverture permettra à des scripts (.BAT, Scilab, Matlab, R, Python...) écrits par l'utilisateur d'automatiser ces opérations.

Exécution de TALWEG, FLUVIA et SIRENE en ligne de commande

David Dorchies — 2011-11-16T15:58:00Z

Les exécutables de SIC peuvent être lancés en ligne de commande avec différentes options qui permettent d'automatiser le lancement de simulation.

La syntaxe de lancement de TALWEG, FLUVIA et SIRENE est la suivante :

PROGRAM.EXE [Nom du fichier Xml] [Mode d'interface] [Options de Fluvia et Sirene]

Toutes les arguments de la ligne de commande sont facultatifs, si le nom du fichier XML n'est pas spécifié, celui-ci sera demandé à l'utilisateur via la boite de dialogue standard de Windows(r).

Signification des arguments :

[Nom du fichier Xml]

Nom du fichier XML à ouvrir. Si le chemin n'est pas spécifié, c'est le chemin courant qui est utilisé par défaut.

[Mode d'interface]

C'est le type d'affichage et d'interaction avec l'utilisateur durant l'exécution du programme. Les différents modes sont les suivants :

0 : Aucune interface à l'écran (lit toutes les options dans la ligne de commande)
1 : Pas d'interface (exécution des instructions du fichier de macro PROGRAM.MAC)
2 : Interfaces normales
3 : Interfaces normales + écriture des inputs sur PROGRAM.MAC (enregistrement macro)
4 : Interfaces normales sauf suivi du calcul (obsolète dans la version 5)
5 : Interfaces normales sauf ouverture des fichiers (récupère nom fichier sur PROJECT.INI)
6 : Pas d'interface du tout (i.e. idem 1 sans petite fenêtre)

En l'absence de deuxième argument correspondant dans la ligne de commande, c'est le mode 2 qui est utilisé.

[Options de Fluvia et Sirene]

Les différentes options disponibles s'écrivent sous la forme OPTION=VALEUR séparées par des espaces. Les différentes options possibles sont :

INTERF=n : mode d'interface n (voir ci-dessus). Par défaut INTERF=2.
SCE=n : lancer la simulation hydraulique sur le scénario hydraulique n°n. Ce paramètre est obligatoire.
VAR=n : lancer la simulation sur la variante n°n. Par défaut, la simulation est lancée sur les données du scénario (VAR=0).
REG=n : lancer la simulation avec le module de régulation n°n. Par défaut, c'est le module de régulation sélectionné dans EdiSic qui est utilisé.
TFIN=x : définir le temps de fin de simulation à x secondes.
DT=x : définir le pas de temps de simulation à x secondes.
MODRES=n : définir le format d'écriture des résultats :
- MODRES=0 (par défaut) : conserve le format d'écriture défini dans les paramètres du scénario
- MODRES=1 : force l'écriture des résultats au format binaire
- MODRES=2 : force l'écriture des résultats dans le fichier de projet XML

Exemple d'utilisation

Pour lancer SIRENE avec les options suivantes :

Fichier C:\DOC\DEMO.XML
Scénario n°2
Variante n°1
Module de régulation n°1
Sans aucune interface à l'écran

La ligne de commande sera la suivante :

SIRENE.EXE C:\DOC\DEMO.XML INTERF=0 SCE=2 VAR=1 REG=1

ou encore

SIRENE.EXE C:\DOC\DEMO.XML 0 SCE=2 VAR=1 REG=1

Importer une condition initiale pour une simulation en écoulement transitoire

David Dorchies — 2011-11-14T15:05:12Z

Cette commande permet simplement d'importer le résultat d'une simulation en permanent ou en transitoire d'un scénario ou variante vers les conditions initiales d'un scénario ou d'une variante pour pouvoir lancer une simulation en écoulement transitoire (SIRENE).

Syntaxe de la ligne de commande :

EDISIC.EXE "Répertoire_de_travail" CI "Fichier.XML" [ResSce] [ResVar] [ResTps] [CiSce] [CiVar]

Description des paramètres de la ligne de commande

"Répertoire_de_travail" : répertoire où se trouve le fichier XML du modèle
CI : commande à EdiSic de lancer l'importation des conditions initiales
"Fichier.XML" : Fichier où ce trouve le modèle à traiter.
[ResSce] : numéro de scénario où se trouve le résultat de simulation à importer
[ResVar] : numéro de variante où se trouve le résultat de simulation à importer
[ResTps] : date (en secondes) du résultat de simulation à importer
[CiSce] : Scénario vers lequel importer la condition initiale
[CiVar] : Variante vers laquelle importer la condition initiale

Exemple d'utilisation sur le fichier C :\titi\toto.xml

Pour importer le résultat au temps 0 du scénario 1 vers la variante 1 du scénario 1 : EDISIC.EXE "C:\titi" CI "toto.xml" 1 0 0 1 1

Pour importer le résultat à 6 heures de la variante 1 du scénario 1 vers la variante 2 du même scénario : EDISIC.EXE "C:\titi" CI "toto.xml" 1 1 21600 1 2

Importer des sections au format texte

David Dorchies — 2011-05-19T12:04:57Z

Cette fonctionnalité permet de lancer EdiSIC, de créer un nouveau projet vierge ou de modifier un projet existant, d'importer des fichiers contenant la géométrie des sections au format texte et de l'enregistrer au format TAL (pour SIC Version 4.xx) ou XML (pour SIC version 5.xx). Pour plus d'informations concernant les formats texte d'importation des sections, consulter l'article dédié.

La modification d'un projet existant permet de conserver toutes les données des scénarios hydrauliques, des modules qualité et des modules de régulation. Les biefs sont alors importés dans l'ordre de leur numérotation.

Syntaxe

EDISIC.EXE "Repertoire_de_travail" Mode_importation "Fichier à créer" "Fichier1.txt" ["Fichier2.txt" ...]

Description des paramètres

"Repertoire_de_travail" : Répertoire de travail (dans lequel seront généré le fichier XML ou TAL de sortie et un fichier .log). Ce répertoire de travail peut être différent du sous-répertoire courant, cf ci-dessous ;
Mode_Importation : ce paramètre peut prendre 4 valeurs différentes en fonction du mode d'importation choisi (Voir ci-dessous les modes d'importation) ;
"Fichier à créer" : Nom du fichier XML ou TAL à créer à la fin de l'importation sans l'extension. Un fichier du même nom avec l'extension .log sera créé et contiendra les messages d'erreurs de l'opération ;
"Fichier1.txt"[, "Fichier2.txt"...] : Nom d'un ou plusieurs fichier(s) .txt à importer (chemin complet ou nom simple). Chaque fichier .txt représente un bief. L'ordre des fichiers définit une branche allant de l'amont vers l'aval. Si le nom de ces fichiers n'est pas donné avec un chemin complet, ils seront recherchés par défaut dans le sous-répertoire courant, qui est le dernier utilisé par Edisic (et stocké dans le fichier sic.ini sous exe. S'ils n'y sont pas trouvés, on change de sous-répertoire courant pour se positionner dans le sous-répertoire de travail défini ci-dessus. Cela permet d'avoir une bibliothèque de fichiers txt dans un sous-répertoire courant, et de créer divers fichiers xml ou tal dans des sous-répertoire et avec des noms choisis selon les besoins.

Les modes d'importation

Il existe 4 modes au choix qui permettent de définir le type de fichier créé (Xml ou Tal) et le format du fichier texte (normal ou transposé) :

Mode d'importation	Format du fichier texte	Format du fichier généré
ImportXml	Normal	XML (SIC version 5.xx)
ImportTal	Normal	TAL (SIC version 4.xx)
ImportXmlTrans	Transposé	XML (SIC version 5.xx)
ImportTalTrans	Transposé	TAL (SIC version 4.xx)

Si le fichier de projet existe déjà, l'interface demande si l'utilisateur souhaite écraser le projet, modifier le projet existant ou annuler l'opération. Il est possible de passer outre cette question en ajoutant soit _NEW, soit _UPDATE au mode d'importation (Exemple : utiliser IMPORTXML_NEW pour écraser un fichier de projet XML existant).

Limitation de la ligne de commande : utilisation de EDISIC.MAC

La taille de la ligne de commande étant limitée, il peut être utile de définir la ligne de commande dans le fichier EDISIC.MAC et de lancer EdiSIC en mode « macro ».

Exemple de ligne de commande

EDISIC.EXE "C:\Fichiers\Sic V5\dat\test" ImportXml "Demo" "bief1.txt" "bief2.txt"

Les actions suivantes seront effectuées :

Création du fichier C :\Fichiers\Sic V5\dat\test\Demo.xml ;
Création du bief 1 à l'amont ;
Import des sections du bief 1 et de leur profil en travers à partir du fichier C :\Fichiers\Sic V5\dat\test\bief1.txt ; (ou le fichier bief1.txt situé dans le sous-répertoire courant s'il s'y trouve)
Création du bief 2 à l'aval du bief 1 ;
Import des sections du bief 2 et de leur profil en travers à partir du fichier C :\Fichiers\Sic V5\dat\test\bief2.txt ; (ou le fichier bief2.txt situé dans le sous-répertoire courant s'il s'y trouve)
Enregistrement du fichier C :\Fichiers\Sic V5\dat\test\Demo.xml. Si ce fichier existe déjà, une question est posée pour autoriser l'écrasement

SicExport : utilitaire d'exportation des résultats au format texte

David Dorchies — 2011-03-17T15:23:45Z

SicExport est un exécutable à utiliser en ligne de commande fourni dans le répertoire EXE de l'installation de SIC. Il peut être lancé directement en ligne de commande DOS ou Windows, mais aussi à partir de script écrit dans d'autres langages (MatLab, Scilab, R, etc), par exemple pour enchainer des calculs et leur pré et post-traitements.

Il permet de créer rapidement un fichier texte à séparateur tabulation avec les résultats d'une ligne d'eau pour un temps donné ou les résultats d'une localisation précise du réseau pour tous les temps.

Il peut gérer des résultats de calculs en régime permanent ou transitoire.

Cet utilitaire permet d'exporter les résultats qu'ils soient écrits au format XML directement dans le fichier du projet, ou également au format binaire dans un fichier externe RES. Ce format est choisi avant le lancement de calcul en permanent (programme Fluvia) ou transitoire (programme Sirene), dans les paramètres généraux et cette information est stockée dans le fichier XML. SicExport ira lire ce mode et cherchera les informations dans le fichier adhoc (XML ou RES). Si le fichier RES correspondant au scénario et variante concernés n'existe pas, un message d'erreur sera indiqué.

Syntaxe d'utilisation

La syntaxe d'utilisation de Sic Export est la suivante :

SicExport.exe FichierXml /sce=n /out=FichierTexte [Options]

Il ne doit y avoir aucun espace entre la barre oblique « / » et l'option, et entre l'option, le signe égal et la valeur de l'option sous peine de voir les options ignorées.

Paramètres obligatoires

FichierXml : Nom du fichier de projet à utiliser . Les noms avec des espaces doivent être entre guillemets.
/sce=n : n° du scénario où se trouve le résultat à extraire.
/out=FichierTexte : Nom du fichier texte où seront stockés les résultats extraits. Si le chemin n'est pas spécifié, c'est celui de FichierXml qui est utilisé. Les noms avec des espaces doivent être entre guillemets.

Paramètres optionnels

/var=n : n° de la variante où se trouve le résultat à extraire. /var=0 correspond au résultat du scénario sans variante.
/t=n : Ligne d'eau au temps n. Si ce paramètre est présent le fichier généré contient les résultats de toutes les sections du réseau au temps n au format n°bief .
/bf=n : n° de bief
/sn=n : n° de section de lit mineur
/x=n : Abscisse. Ne peut être utilisée que si l'option /bf=n est présente et l'option /sn=n absente.
/nd=n : n° de noeud
/pr=n : n° de prise (valide uniquement si l'option /nd=n est présente)
/st=n : n° de structure. S'utilise uniquement pour extraire les données d'un ouvrage à une prise (valide uniquement si les options /nd=n et /pr=n sont présentes)
/ouv=n : n° d'ouvrage
/quiet={0;1;2} : Options d'entêtes sur le fichier (voir ci-dessous).

Si aucune de ces options n'est présente, c'est la ligne d'eau au temps 0 qui est exportée (option /t=0).

Options sur les entêtes du fichier : le paramètre /quiet

Option absente ou /quiet=0 : Entêtes complètes avec des commentaires sur 3 lignes et le nom des variables sur 1 ligne après un retour charriot
/quiet=1 : Entête du tableau (noms des variables) uniquement
/quiet=2 : Aucun entête (ni commentaires, ni noms des variables)

Exemple

Exemple de fichier de sortie avec la commande SicExport "C:\SIC\DAT\asce1\asce1.xml" /sce=1 /out=test.txt /t=0

% Projet : C:\DocDD\SIC\Validation\asce1\asce1.xml

% Scenario 1

% Simulation FLUVIA Version 5.12 du 17/03/2011 15:20:10



Bief Section Abscisse Q Z L V ST

1 1 0 8.000000E-01 100.703850 3.111552 5.528833E-01 1.446960

1 2 95 8.000000E-01 100.700073 3.670238 3.849038E-01 2.078442

2 1 95 7.000000E-01 100.700073 3.670238 3.367907E-01 2.078442

2 2 100 7.000000E-01 100.699997 3.699981 3.309729E-01 2.114977

2 3 100 7.000000E-01 99.163811 2.091429 1.244785 5.623461E-01

2 4 1295 7.000000E-01 97.300064 3.670175 3.368033E-01 2.078365

...

Importation de fichiers .TAL et .FLU en ligne de commande

David Dorchies, Jean Malle — 2009-11-12T12:25:12Z

Cette fonctionnalité permet de lancer EdiSIC, d'ouvrir un fichier .TAL, de l'enregistrer en Xml, de lancer le maillage par le programme Talweg, puis si tout s'est bien passé, d'importer un ou plusieurs fichiers .FLU. Ces fichiers sont ceux au format des versions de SIC 4.**.

Syntaxe

EDISIC.EXE "Répertoire_de_travail" IMPORT "Fichier.TAL" "Fichier1.FLU" ["Fichier2.FLU" ...]

Description des paramètres

"EDISIC.EXE" : Le nom de l'exécutable peut être donné avec son chemin complet si on n'est pas positionné dans son sous répertoire d'installation, et/ou s'il n'est pas défini dans le path
"Répertoire_de_travail" : Répertoire de travail (dans lequel seront générés le fichier XML de sortie et le fichier .log)
IMPORT : Mode de lancement d'EdiSIC - ouverture et enregistrement d'un ou plusieurs fichiers. Ce mot clef peut être écrit en majuscule ou minuscule, indifféremment.
"Fichier.TAL" : Nom d'un fichier .TAL (chemin complet ou relatif au répertoire de travail)
"Fichier1.FLU", "Fichier2.FLU"... : Nom d'un fichier .FLU (chemin complet ou relatif au répertoire de travail)

L'option fonctionne pour autant de fichiers .FLU que voulus. Il est même possible de mettre plusieurs lot de .TAL suivis de plusieurs .FLU.

Limitation de la ligne de commande : utilisation de EDISIC.MAC

La taille de la ligne de commande étant limitée, il peut être utile de définir les options de la ligne de commande dans le fichier EDISIC.MAC et de lancer EdiSIC en mode « macro ».

Exemples de ligne de commande

EDISIC.EXE "C:\Fichiers\Sic V5\dat\ex1" IMPORT Demo.tal Demo.flu

C:\Sic538f5\exe\Edisic.exe "C:\Fichiers\Sic V5\dat\ex1" Import Demo.tal Demo.flu

Les actions suivantes seront effectuées :

Ouverture de Demo.tal
Enregistrement en format xml
Maillage du fichier xml par Talweg
Import du fichier Demo.flu

Le fichier Demo.flu sera utilisé pour créer un scénario. Afin de s'adapter au mieux à des exécutions en mode batch, plusieurs choses seront définies et activées pour ce scénario :

Une variante sera créée, dans le cas où l'on voudra l'utiliser par exemple pour des simulations en régime transitoire (en mode batch on peut importer une condition initiale dans un scenario ou une variante et y lancer ensuite un calcul en permanent ou transitoire)
La gestion du fichier .par sera positionnée dans le mode où ce fichier .par ne sera pas réécrit par Edisic. Il sera ainsi possible de le créer par un programme tiers et d'en tenir compte ainsi lors des calculs (sinon par défaut c'est Edisir qui le réécrit à chaque sauvegarde du fichier .xml)
Le mode de calcul en régime permanent pour plusieurs instants et non pas uniquement pour le premier instant est également activé, pour autoriser ces calculs multiples en mode batch. On peut effectivement penser que cette fonctionnalité sera utile en mode batch. Il sera de toute façon possible dans les paramètres de calcul du programme Fluvia de préciser les temps de fin (TFIN=) et le pas de temps (DT=) si on ne veut pas excécuter tous les instants possibles.

Dans le cas de l'utilisation d'un fichier edisic.mac il faudra alors y mettre :

"C:\Fichiers\Sic V5\dat\ex1" IMPORT Demo.tal Demo.flu

ce fichier étant positionné dans le sous-répertoire du projet, où les fichiers à importer seront également présents. Ce sous-répertoire sera recherché grâce au nom indiqué comme "Répertoire_de_travail" (le premier paramètre ci-dessus).

et juste exécuter en ligne de commande :

EDISIC.EXE

C:\Sic538f5\exe\Edisic.exe

Le mode macro d'EdiSIC : une alternative à la ligne de commande

David Dorchies, Jean Malle — 2009-11-12T11:03:27Z

Les fonctionnalités d'EdiSIC telles que l'importation des sections au format texte peuvent nécessiter l'emploi d'un ligne de commande plus longue que les 256 caractères acceptés par le système d'exploitation Windows(r).

Il existe donc pour EdiSIC un mode permettant d'écrire des lignes de commande plus longue dans un fichier EDISIC.MAC. Le fichier EDISIC.MAC est recherché dans cet ordre :

dans le répertoire défini en premier argument de la ligne de commande si un argument est présent au lancement d'EdiSic ;
dans le répertoire en cours, lors de l'exécution d'EdiSic ;
Dans le répertoire du dernier projet ouvert avec EdiSic.

Exemple pour charger le fichier EDISIC.MAC dans un répertoire défini dans la ligne de commande :

C:\SIC\exe\edisic.exe C:\MyDocs\MyFolderWithEdisicMac">

C:\MyDocs\MyInputs>C:\SIC\exe\edisic.exe C:\MyDocs\MyFolderWithEdisicMac

Syntaxe du fichier EDISIC.MAC

Il suffit d'écrire les arguments utilisés dans la ligne de commande utilisée habituellement pour demander à EdiSIC d'accomplir une tâche spécifique. Voir les exemples dans la section « Piloter SIC à partir d'autres logiciels (Mode Batch) ».

Par exemple, pour un fichier edisic.mac :

D:\SIC\Po ImportXml_new Po exportdata1.txt exportdata2.txt exportdata3.txt exportdata4.txt exportdata5.txt exportdata6.txt exportdata7.txt exportdata8.txt exportdata9.txt exportdata10.txt

Il suffit ensuite d'exécuter Edisic.exe en ligne de commande, ou directement de manière habituelle (double click sur le raccourci Windows), et les instructions écrites dans le fichier Edisic.mac seront exécutées. Ici dans cet exemple l'importation de 10 fichiers de données de section dans un fichier Po.xml qui sera sauvé dans le sous-répertoire de données D :\SIC\Po. Même si le fichier existe déjà un nouveau fichier sera créé (car option d'import ImportXml_new). Pour arrêter l'utilisation de ce mode automatique en mode macro il suffit de supprimer (ou renommer) le fichier edisic.mac.