How to find data and results from a simulation (data scan)
    • 27 Jul 2022
    • 2 Minutes to read
    • Dark
      Light

    How to find data and results from a simulation (data scan)

    • Dark
      Light

    Article Summary

    The catalogue tool includes a data scan function. This can be used to fill in missing data and to identify which data cannot be identified.

    Each simulation will have associated metadata to be added to the catalogue. The data sections are defined in the associated catalogue template. They are displayed in the Simulations tab of the right-hand panel. This is a tree view that can be expanded to show metadata from all loaded simulations, though only the data from the selected simulation in the main catalogue view will be visible by default.

    Note:

    the metadata displayed in this tree view is controlled by the Display Items settings in the Catalogue tab of the main toolbar. You can tick which data types will be visible in the tree view (i.e. required data, optional data or all data).

    Initially the majority of values for these metadata will not be populated. Some data can only be filled in from the automated tools, others always require manual entry. Some fields have either option – they will have a padlock icon against them. Click the padlock to release fields for manual entry.

    Alternatively, the data scan function can be used to fill in metadata automatically. These data may be model input files, results data or simulation diagnostics (all located from references in simulation files).

    The data scan function has two different operating modes:

    • Click the data scan icon in main toolbar to scan entire catalogue

      CatalogueToolassetsimagesimage084.jpg

    • Scan a subset of the catalogue by selecting data scan from the right-click menus of a catalogue section (scans all files in section) or referenced file (scans just the selected file)

      CatalogueToolassetsimagesimage085.png

    Note:

    The v4.5 version of the catalogue tool includes the following limitations with respect to checking file references:

    • References defined with full paths cannot be fully checked (the full path might not be valid when loaded on a different system).

    • “Second-level” references (i.e. files referenced in files) within TUFLOW control files (tcf files) currently cannot be checked by the data scan.

    Each data scan will produce a log file. This will detail any issues found during a scan, e.g. unrecognised or missing file references in a model file. The message box signifying the scan has completed includes an option to view the associated log. This file is a text format and will open in a standard text editor, so you may opt to view the log file later. If you have saved your catalogue file (.fmcx file), then the data scan log filename will always use your catalogue name and it will be written to the same folder as the catalogue file. If you haven’t yet saved your catalogue when you scan (not recommended) the log file will be given a temp name and be written to the Flood Modeller temp folder (usually “C:\users[username]\AppData\Local\Temp”).


    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.