SicExport: text-format results export utility

SicExport is an executable to be used from the command line, provided in the EXE directory of the SIC installation. It can be launched directly from the DOS or Windows command line, but also from scripts written in other languages (MatLab, Scilab, R, etc), for example to chain calculations with their pre- and post-processing.

It allows quickly creating a tab-separated text file with the results of a water surface profile at a given time, or the results of a precise location in the network for all times.

It can handle results of steady or transient flow calculations.

This utility allows exporting the results whether they are written in XML format directly in the project file, or also in binary format in an external RES file. This format is chosen before the launch of the steady (Fluvia program) or transient (Sirene program) calculation, in the general parameters, and this information is stored in the XML file. SicExport will read this mode and look for the information in the appropriate file (XML or RES). If the RES file corresponding to the scenario and variant concerned does not exist, an error message will be displayed.

Usage syntax

The usage syntax of SicExport is the following:

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

There must be no space between the slash «/» and the option, and between the option, the equal sign and the value of the option, otherwise the options will be ignored.

Mandatory parameters

FichierXml : Name of the project file to use. Names with spaces must be quoted.
/sce=n : n° of the scenario where the result to extract is located.
/out=FichierTexte : Name of the text file where the extracted results will be stored. If the path is not specified, that of FichierXml is used. Names with spaces must be quoted.

Optional parameters

/var=n : n° of the variant where the result to extract is located. /var=0 corresponds to the scenario result without variant.
/t=n : Water surface profile at time n. If this parameter is present the generated file contains the results of all sections of the network at time n in reach number format.
/bf=n : reach number
/sn=n : n° of minor bed section
/x=n : Chainage. Can only be used if the option /bf=n is present and the option /sn=n absent.
/nd=n : n° of node
/pr=n : n° of offtake (valid only if the option /nd=n is present)
/st=n : n° of structure. Used only to extract the data of a device at an offtake (valid only if the options /nd=n and /pr=n are present)
/ouv=n : n° of device
/quiet=0;1;2 : Options for the file headers (see below).

If none of these options is present, the water surface profile at time 0 is exported (option /t=0).

*Options on the file headers: the /quiet parameter

Option absent or /quiet=0 : Complete headers with comments on 3 lines and the variable names on 1 line after a carriage return
/quiet=1 : Table header (variable names) only
/quiet=2 : No header (no comments, no variable names)

Example

Example of output file with the command 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
...