Tabular CSV processor
    • 21 Sep 2022
    • 4 Minutes to read
    • Dark
      Light

    Tabular CSV processor

    • Dark
      Light

    Article Summary

    The Tabular CSV Processor allows the user to produce results in Comma Separated Variable (.csv) format. This format allows the user to import the data directly into spreadsheets such as Microsoft Excel. At present this option only allows the processing of hydraulic results and Coordinate Extraction. The Tabular CSV Processor window is accessed through Results Tab, by selecting the Tabular CSV button.

    RiverSimulationsimagestabularcsv.PNG

    The Tabular CSV Options Window has four tabs. The Output Parameters tab is shown above. For certain run types not all of the functions are available.

    • Title Bar - This displays the window name.
    • Drop Down Menus - Allows the user to open alternative results files or access the on-line help.
    • Results Module – Allows the user to select the type of results to be extracted: 1D Flow, 1D Quality, 1D Sediment, Module Control, or Supplementary results.
    • 1D Simulation Results File - Shows the results file for which the results are being processed.
    • 1D Data File - Shows the data file for which the results are being processed.
    • Output - Allows the user to select the variables required
    • Times - Allows the user to define the time period of interest and the interval at which results are required
    • Buttons - allows the user to run the processor or exit the Tabular CSV option. If no nodes are selected the run button is "greyed out"

    The Node Selection tab is used for selecting the node labels at which the results are required. The constituents of the Node Selection tab are:

    • Available Nodes - displays all nodes labels at which results are available
    • Selected Nodes - displays node labels selected by the user
    • Buttons - allows the user to select and deselect node labels, buttons are also available to commence the processing of the results or exiting the option.

    The Output Options tab is for setting some options regarding the format to be used in the output files.

    The Coordinate Options tab is displayed when the model output is switched to Coordinate Extraction, this tab contains the following options:

    • Eastings/Northings Extraction - Allows you to select the priority to be used for the extraction of the coordinates (Coordinates might be extracted from the datafile, map view, etc).
    • Cross Section Coordinates - You can select the points to be included in the output CSV: River bed, Right and Left banks, and Right and Left extremities.

    Furthermore, you can decide whether you wish to include the elevations for each point and the blank records.

    Output (Hydraulic Results)

    The Tabular CSV output utility is accessed via the Tabular CSV button in the Results tab. It features a subset of the options available in the Tabular Output option, with the difference that tabulated output is supplied in Comma Separated Variable (CSV) format for easy access and further manipulation in spreadsheet packages, such as Microsoft Excel. Additionally, there is an option to write results for all nodes at a specified time in 'initial conditions' format for use as initial conditions for subsequent runs, and to extract coordinates from the model units. The output options are:

    1. Simulation Results - output at selected time intervals at all or selected nodes.
    2. Maxima and minima of all or a single variable at all or selected nodes.
    3. Extract new boundary conditions.
    4. Initial Conditions output.

    By default, the output for options 1 and 2 is written to a results file with extension '.csv'. Boundary conditions (option 3) are written to a file with extension '.bdy' and Initial Conditions (option 4) are written to a file with extension '.zzs'. After generating the results, the program will attempt to display the results by opening the file with the default viewers registered for the relevant extension. For instance, csv files will often be associated with Microsoft Excel.

    For any option, the user may select any number of nodes from the model for output, with Select All and Remove All buttons being available. Node selections may be saved using the Save button on the Node Selection tab, and subsequently reloaded via the Retrieve button.

    Simulation Results

    The default option is to produce results for Stage in "One Column Per Node" format. This means that all selected nodes will be displayed across the output page, with one row for each output time. Any of the six 1D output variables (Stage, Flow, Velocity, Froude Number, Unit Mode and Unit State) may be output, or all six may be chosen. In the case of the latter, output for each variable is written beneath the whole section for that of the previous variable.

    If "One Column Per Node" output is deselected, data for each node will appear beneath all of that from the previous one, again with one output timestep per row. One or all six output variables may be chosen for output; if the latter is selected, one column of output will be displayed for each variable.

    Maxima and minima

    The output for this option is much the same as in Tabular Output, except that it is produced in CSV format, and single variables and any number of nodes may also be selected.

    Extract Boundary

    The output for this option is identical to that produced by the equivalent Tabular Output option.

    Initial Conditions

    This option enables the user to write results from an existing simulation at a particular time to a pseudo-steady state file (extension '.zzs'). This file can then be used as initial conditions for a subsequent simulation using the same or similar model which begins at that time. One must remember to ensure that the zzs file has the same name as that of the data file (except for the extensions) and that the "Use steady state file for Initial Conditions" option is selected when running the simulation to effect this. Alternatively, one can import the zzs file into the initial conditions section of the datafile using the Flood Modeller User Interface, and ensure that the aforementioned run option is not selected.

    It should be noted that although the extension of the output file defaults to zzs, this does not mean that the results generated are steady-state results. This is merely a convenient way of using the results as a separate initial conditions file.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.