Difference between revisions of "Package Model in QGIS"
Jump to navigation
Jump to search
Ellis Symons (talk | contribs) |
|||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | A dialog interface for TUFLOW's package model functionality. For more information, please see the package model documentation in the | + | A dialog interface for TUFLOW's package model functionality. For more information, please see the package model documentation in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> or the <u>[[Run_TUFLOW_From_a_Batch-file#Package_a_TUFLOW_model | TUFLOW Wiki]]</u>.<br> |
| + | |||
| + | This tool automatically sets up the command line syntax and the ini file (if required) and runs TUFLOW's package model tool (using the TUFLOW.exe). One additional piece of functionality is added to the the tool that will automatically ZIP the copied folder. This is done outside of TUFLOW using Python.<br> | ||
| + | |||
| + | This tool can be found in the QGIS Processing Toolbox: <br> | ||
| + | [[File:Processing toolbox.jpg]]<br><br> | ||
| + | [[File:Package model toolbox.png]] | ||
| + | |||
| + | |||
| − | |||
==Parameters== | ==Parameters== | ||
[[File: package_model_dialog.PNG]]<br> | [[File: package_model_dialog.PNG]]<br> | ||
<ul> | <ul> | ||
| − | <li><b>TUFLOW exe:</b> Path to TUFLOW executable used to package the model. The latest release is | + | <li><b>TUFLOW exe:</b> Path to TUFLOW executable used to package the model. The latest release is best as there is no input processing, backward compatibility is not an issue (and a license is not required). |
<li><b>TCF:</b> Path to the TUFLOW Control File (.tcf) that will be packaged. | <li><b>TCF:</b> Path to the TUFLOW Control File (.tcf) that will be packaged. | ||
<li><b>XF Files:</b> How to treat input files that generate/have xf files. Options are: | <li><b>XF Files:</b> How to treat input files that generate/have xf files. Options are: | ||
| Line 15: | Line 22: | ||
</ul> | </ul> | ||
<li><b>Copy All File Extensions:</b> If checked, will copy all files with the same name (ignoring file extensions). | <li><b>Copy All File Extensions:</b> If checked, will copy all files with the same name (ignoring file extensions). | ||
| − | <li><b>List Files Only:<b> If checked, will only list the files that would be copied ( | + | <li><b>List Files Only:</b> If checked, will only list the files that would be copied (does not copy them). This list will be written to the tool dialog log. |
| − | <li><b>Output Directory:</b> Output directory for the copied files | + | <li><b>Output Directory:</b> Output directory for the copied files. |
| + | <li><b>Zip Output:</b> If checked, will compress the output. | ||
<li><b>Base Directory:</b> Base directory of the TUFLOW model (only required if using a non-standard TUFLOW directory structure). | <li><b>Base Directory:</b> Base directory of the TUFLOW model (only required if using a non-standard TUFLOW directory structure). | ||
| + | <li><b>Scenarios:</b> List of scenarios in the form of <tt>s[n] == [scenario-name] | ...</tt>. Required to copy input files that contain scenario wildcards in their names. | ||
| + | <li><b>Events:</b> List of events in the form of <tt>e[n] == [event-name] | ...</tt>. Required to copy input files that contain event wildcards in their names. | ||
</ul> | </ul> | ||
| + | |||
| + | <br> | ||
| + | <Br> | ||
| + | {{Tips Navigation | ||
| + | |uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]] | ||
| + | }} | ||
Latest revision as of 09:43, 23 September 2024
A dialog interface for TUFLOW's package model functionality. For more information, please see the package model documentation in the TUFLOW Manual or the TUFLOW Wiki.
This tool automatically sets up the command line syntax and the ini file (if required) and runs TUFLOW's package model tool (using the TUFLOW.exe). One additional piece of functionality is added to the the tool that will automatically ZIP the copied folder. This is done outside of TUFLOW using Python.
This tool can be found in the QGIS Processing Toolbox:
Parameters
- TUFLOW exe: Path to TUFLOW executable used to package the model. The latest release is best as there is no input processing, backward compatibility is not an issue (and a license is not required).
- TCF: Path to the TUFLOW Control File (.tcf) that will be packaged.
- XF Files: How to treat input files that generate/have xf files. Options are:
- Do not copy xf files: Do not copy XF Files
- Copy all: Copy both raw inputs and XF Files
- Copy only xf files: Only copy xf files (if they exist) and do not copy raw inputs
- Copy All File Extensions: If checked, will copy all files with the same name (ignoring file extensions).
- List Files Only: If checked, will only list the files that would be copied (does not copy them). This list will be written to the tool dialog log.
- Output Directory: Output directory for the copied files.
- Zip Output: If checked, will compress the output.
- Base Directory: Base directory of the TUFLOW model (only required if using a non-standard TUFLOW directory structure).
- Scenarios: List of scenarios in the form of s[n] == [scenario-name] | .... Required to copy input files that contain scenario wildcards in their names.
- Events: List of events in the form of e[n] == [event-name] | .... Required to copy input files that contain event wildcards in their names.
| Up |
|---|
 Back to TUFLOW QGIS Plugin Main Page
|