Model pre-adapter for running SWMM (Storm Water Management Model) model (version 5) from Delft-FEWS.
For information about the SWMM model see https://www.epa.gov/water-research/storm-water-management-model-swmm
Usage: SWMMPreAdapter <PI XML run file pathname relative to current working directory>
Class name: nl.deltares.fews.swmm.SwmmPreAdapter
SWMM_input_file | (required) | Pathname of SWMM input file (*.inp) to update. This should be either an absolute path or a path relative to the workDir specified in the netcdf run file. The input file will be updated to modify only the START_DATE, START_TIME, END_DATE, END_TIME, REPORT_START_DATE and REPORT_START_TIME fields, the rest of the file is not modified in any way. |
---|
Model post-adapter for running SWMM (Storm Water Management Model) model (version 5) from Delft-FEWS.
For information about the SWMM model see https://www.epa.gov/water-research/storm-water-management-model-swmm
Usage: SWMMPostAdapter <PI XML run file pathname relative to current working directory>
Class name: nl.deltares.fews.swmm.SwmmPostAdapter
SWMM_report_file | (required) | Pathname of SWMM report file (*.rpt) to update. This should be either an absolute path or a path relative to the workDir specified in the netcdf run file. |
---|
The following gives an example of how to set up the GeneralAdapterRun file for SWMM in FEWS using the SWMM model pre and post-adapters. The GeneralAdapterRun file follows the general structure as described here.
In this section general information regarding the module such as version number, file directories, missing values, and time zone information can be specified.
<general> <rootDir>$REGION_HOME$/Modules/swmm/$MINE$</rootDir> <workDir>%ROOT_DIR%/model</workDir> <exportDir>%ROOT_DIR%/input</exportDir> <exportDataSetDir>%ROOT_DIR%/model</exportDataSetDir> <exportIdMap>IdExportSWMM</exportIdMap> <importDir>%ROOT_DIR%/output</importDir> <importIdMap>IdImportSWMM</importIdMap> <dumpFileDir>$GA_DUMPFILEDIR$</dumpFileDir> <dumpDir>%ROOT_DIR%</dumpDir> <diagnosticFile>%ROOT_DIR%/piDiagnostic.xml</diagnosticFile> <missVal>-99</missVal> <convertDatum>true</convertDatum> <timeZone> <timeZoneOffset>+10:00</timeZoneOffset> </timeZone> </general> |
It may be useful to clear the model working directory of any previous runs before starting a new run.
<startUpActivities> <purgeActivity> <filter>%ROOT_DIR%/input/*.*</filter> </purgeActivity> <purgeActivity> <filter>%ROOT_DIR%/output/*.*</filter> </purgeActivity> <purgeActivity> <filter>%ROOT_DIR%/model/*.*</filter> </purgeActivity> </startUpActivities> |
In this section the data to be exported from FEWS as input to the module is specified. Data to export to SWMM generally includes:
The run file contains information regarding the input file names, start and stop times, and time step. Additional properties can be passed using the run file as listed above under Properties.
<exportActivities> <exportTimeSeriesActivity> <exportFile>rain.xml</exportFile> <timeSeriesSets> <timeSeriesSet> <moduleInstanceId>$SWMM_MODEL$SWMMProcess</moduleInstanceId> <valueType>scalar</valueType> <parameterId>P.obs</parameterId> <locationSetId>stations.P.$MINE$</locationSetId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep id="day_AEST"/> <relativeViewPeriod unit="day" start="-366" end="0" startOverrulable="true"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </timeSeriesSets> </exportTimeSeriesActivity> <exportTimeSeriesActivity> <exportFile>evaporation.xml</exportFile> <timeSeriesSets> <timeSeriesSet> <moduleInstanceId>$SWMM_MODEL$SWMMProcess</moduleInstanceId> <valueType>scalar</valueType> <parameterId>E.pot</parameterId> <locationSetId>stations.P.$MINE$</locationSetId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep id="day_AEST"/> <relativeViewPeriod unit="day" start="-366" end="0" startOverrulable="true"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </timeSeriesSets> </exportTimeSeriesActivity> <exportTimeSeriesActivity> <exportFile>level.xml</exportFile> <timeSeriesSets> <timeSeriesSet> <moduleInstanceId>$SWMM_MODEL$SWMMProcess</moduleInstanceId> <valueType>scalar</valueType> <parameterId>H.obs</parameterId> <locationSetId>stations.ml.$MINE$.H</locationSetId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep id="month_AEST"/> <relativeViewPeriod unit="day" start="-366" end="0" startOverrulable="true"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </timeSeriesSets> </exportTimeSeriesActivity> <exportTimeSeriesActivity> <exportFile>flow.xml</exportFile> <timeSeriesSets> <timeSeriesSet> <moduleInstanceId>$SWMM_MODEL$SWMMProcess</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.ml</parameterId> <locationSetId>stations.ml.$MINE$.Q</locationSetId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep id="day_AEST"/> <relativeViewPeriod unit="day" start="-366" end="0" startOverrulable="true"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </timeSeriesSets> </exportTimeSeriesActivity> <exportDataSetActivity> <moduleInstanceId>$MODULE_INSTANCE_ID$</moduleInstanceId> </exportDataSetActivity> <exportRunFileActivity> <exportFile>runinfo.xml</exportFile> <properties> <string key="swmm_input_file" value="%ROOT_DIR%/model/$SWMM_INP_FILE$"/> <string key="swmm_report_file" value="%ROOT_DIR%/model/$SWMM_RPT_FILE$"/> </properties> </exportRunFileActivity> </exportActivities> |
This section calls the SWMM pre and post-adapters as well as the SWMM executable. Note: the run file must be passed as an argument to the SWMM pre and post-adapters.
<executeActivities> <executeActivitys> <description>Run SWMM pre</description> <command> <className>nl.deltares.fews.swmm.SwmmPreAdapter</className> <binDir>$SWMM_BIN$</binDir> <moduleDataSetName>UpdateSoftwareSWMM</moduleDataSetName> </command> <arguments> <argument>%ROOT_DIR%/input/runinfo.xml</argument> </arguments> <logFile> <file>%ROOT_DIR%/input/swmm_pre_adapter_log.txt</file> <infoLinePattern>* INFO *</infoLinePattern> <warningLinePattern>* WARNING *</warningLinePattern> <errorLinePattern>* ERROR *</errorLinePattern> </logFile> <timeOut>3600000</timeOut> <ignoreDiagnostics>true</ignoreDiagnostics> </executeActivity> <executeActivity> <description>Run SWMM</description> <command> <executable>$SWMM_BIN$/swmm5.exe</executable> </command> <arguments> <argument>%ROOT_DIR%/model/$SWMM_INP_FILE$</argument> <argument>%ROOT_DIR%/model/$SWMM_RPT_FILE$</argument> </arguments> <timeOut>3600000</timeOut> <ignoreDiagnostics>true</ignoreDiagnostics> </executeActivity> <executeActivity> <description>Run SWMM post</description> <command> <className>nl.deltares.fews.swmm.SwmmPostAdapter</className> <binDir>$SWMM_BIN$</binDir> </command> <arguments> <argument>%ROOT_DIR%/input/runinfo.xml</argument> </arguments> <logFile> <file>%ROOT_DIR%/input/swmm_post_adapter_log.txt</file> <infoLinePattern>* INFO *</infoLinePattern> <warningLinePattern>* WARNING *</warningLinePattern> <errorLinePattern>* ERROR *</errorLinePattern> </logFile> <timeOut>3600000</timeOut> <ignoreDiagnostics>true</ignoreDiagnostics> </executeActivity> </executeActivities> |
In this section the data to be imported into FEWS as output from the module is specified. Data to import from SWMM generally includes:
<importActivities> <importTimeSeriesActivity> <exportPlaceholderFile>true</exportPlaceholderFile> <importFile>outputswmm_links.xml</importFile> <timeSeriesSets> <timeSeriesSet> <moduleInstanceId>$MODULE_INSTANCE_ID$</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.gw</parameterId> <locationSetId>stations.ml.$MINE$.H</locationSetId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep id="day_AEST"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </timeSeriesSets> </importTimeSeriesActivity> </importActivities> |