How to export projects
    • 01 Aug 2022
    • 2 Minutes to read
    • Dark

    How to export projects

    • Dark

    Article Summary

    A project can be exported from the project information, accessed via the 'Start' tab.


    The export functionality in Flood Modeller gives you the option of excluding the following project data from your export file:

    • The content of your project’s Layers panel. Note that if you choose to exclude these data from your zip, then any GIS datasets listed in the Layers panel that are required by a (2D) simulation in your project will still be included in the export file.
    • Files listed in the spatial data section of Project panel, i.e. GIS datasets referenced in the project but not added to the map view.
    • Files listed in the associated data section of Project panel, e.g. reports, calculation spreadsheets, etc.
    • Simulation results

    You will be prompted to specify a filename and location for the export zip file. Then after clicking Save to proceed you are prompted to customise your export file with the following additional data options (from your current project):


    After making your export selections click the Export button to proceed. The tool will read the selected files from your source project and in the case of simulation files the content is also read to identify all files required to re-run each simulation, e.g. ied, iic, etc. for 1D models and .asc, .shp, .csv for 2D models and .mif, .shp, etc. All of these data are then copied into the export zip file.

    The tool creates a new Flood Modeller project file (.fmpx file) that references all files you have selected for inclusion in the export zip file. In addition, a log file is generated that details the file path in the source project and the revised path used for the same file in the export file structure. Both the project and log files take the same filename as the user specified export filename and are included within the zip file.

    It should be noted that the export tool uses a fixed folder structure which will likely be different from your source project. The data from your project are copied into the appropriate folder within this structure, an example of which is shown below:


    The folder names used should be self-explanatory, however some points to note are:

    • All GIS datasets are placed in the spatial data folder, irrespective of whether they are referenced in simulation files, loaded into the Layers panel of the source project or referenced in the spatial data folder of the Project panel in the source project.
    • All simulation types are added to the simulation folder, i.e. 1D, 2D, 1D-2D linked and TUFLOW. Each separate model is placed in its own sub-folder within the simulations folder.

    When the export process has finished, a message is displayed to inform you the export has completed successfully.

    To use an exported project, you need to unzip the file created by the export tool and then open the Flood Modeller project file (fmpx file) with the same name as the export zip and located in the top-level folder within the zip 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.