HOW TO add a new model to an NGMS application

This page describes the steps to add a new model to an NGMS application.

The NGMS confuration guide defines the steps starting from scratch. If an existing application is extended, a merge will be needed. This merge is defined at the last step as it is easier to debug an application with only one model.

Go to FEWSDOC for more information on configuring FEWS.
Download config course materials (Oct.07)

How to setup an NGMS configuration from scratch

Step 1. Analyze the model handed over

Step 2. Create and populate default directory structure

Step 3. Update the various Descriptor-files

Step 4. ModuleDataSets and Module Adapter

1. prepare Modules-directory
2. populate the sub-directories
3. update the NAM file
4. prepare OFS file
5. prepare ModuleDataSet-zip files
6. prepare Model States for testing' purposes
7. update the Module Adapter instructions (model references)
8. obtain configuration data via Module Adapter
9. prepare Model States for 'production' purposes
10. update Module Adapter instructions for output (parameters)

Step 5. Prepare Locations

1. prepare Locations spreadsheet
   • Check presence of all worksheets
   • Populate and verify worksheet Grids_loc and Grids_locSets
   • Populate and verify worksheet GWunits_loc and GWunits_locSets
   • Populate and verify worksheet GWabs_org
   • Populate and verify worksheet OBH_org
   • Populate and verify worksheet Gauges_org
   • Populate and verify worksheet SWlat_org
   • Populate and verify worksheet Branches_org
   • Populate and verify worksheets for GWabs_IDMap (4 worksheets)
   • Populate and verify worksheets for SWlat_IDMap (4 worksheets)
2. Generate locations XML-files
3. Update Grids.XML file

Step 6. Import

1. Convert data set into appropriate import format
2. Prepare import IdMap
3. populate import folder
4. Create Module instance for import

Step 7. ModuleInstances (ModuleConfigFiles)

1. generate ModuleConfigFiles for Modflow run
2. generate ModuleConfigFiles for discharges of tributaries (step 8)
3. generate ModuleConfigFiles for interpolations
4. generate ModuleConfigFiles for budgets
5. generate ModuleConfigFiles for statistics
6. generate ModuleConfigFiles for comparison

Step 8. Derivation tributary flows (PCRtransformation)

Step 9. Displays

1. update Map
2. generate GridDisplay
3. generate Filters
4. generate DisplayGroups

Step 10. Merge with existing application

1. merge Locations and LocationSets
2. merge ModuleInstanceDescriptors and ModuleInstanceSets
3. merge WorkflowDescriptors
4. merge IdMapDescriptors
5. merge Branches and Grids
6. create Filters, GridDisplay, DisplayGroups
7. edit Explorer, TimeSeriesDisplay and ScenarioEditor
8. copy IdMapFiles, MapLayerFiles, ModuleConfigFiles, ModuleDataSetFiles, ModuleParFiles and WorkFlowFiles

Updates of existing configurations

HOW TO include RIV and DRA output

1. Preparation
2. Update grids.xml and Locations.xml
3. Update Module Adapter instructions
4. Update Module Instances
5. Update displays

Upgrade ModuleDataSet handling - build 20239 and higher
The ModuleDataSet handling is slightly reorganized to better fit with maintenance tasks within the EA. Steps include:

1. zip all ModulDataSetFiles and baseData into one file
2. regenerate module instanes for runMF

Known NGMS Configuration Problems

Below you will find a list with problems encountered during the setup of the NGMS configuration for a new region. This list is provided for your information as it may help you in solving a problem you have just encountered or it may provide you with a little bit extra information in case the documentation provided by Delft Hydraulics is not sufficient yet.

These problems have been encountered during the setup of the configuration for SouthWest, so some of them are SouthWest specific, but most of them are applicable to other regions and models as well:

1. The map FinalModBoundary.shp is missing in the Map folder of the SouthWest configuration
2. There are no Region specific map layers at all.
3. The file with filters is available, but it is not completely correct as the data does not appear yet.
4. The workflow HA_import is not properly configured. All ModuleConfigFiles specified in this workflow are missing.
   • HA_import_observed
   • HA_extract_staticmodeldata
   • HA_merge_staticmodeldata
5. The workflow 'HA_default_scenarios' is referring to a ModuleConfigFile with the name 'HA_QTRIB_ref(FullyLicenced)' which is not available.
6. The File IDMapDescriptors is not available
7. The structure of the Modules folder is not consistent with the ModuleConfigFile 'HA_runMF_ref(FullyLicenced)'
8. Diagnostic file does not exist: F:\fews\NGMS\SouthWest_SA\Modules\HA\Mfvkd\FulLic\dummy_Modflow_diag.xml
   A dummy file with this name should be available (can be copied from any other example area)
9. HA_QSTOR_merged_MapStacks.xml. The Modflow model does not create this data therefore it is not possible to import it. This should either be changed in the Modflow model or in NGMS.
10. No External file F:\fews\NGMS\SouthWest_SA\Modules\HA\PCR\Qtributaries\toNGMS\branches_grid.map present for variable = branches_grid'. This file and two other files are not created yet.
11. I have removed the line with filename HA.rul from the file 'HA.nam' for scenarios 'Fully Licensed' and 'Recent Actual' as the model is generating an error referring to this filename.
12. The following error is displayed when running HA_import: Cannot find unit conversions config file for Modflow2NGMS_UnitConversions. This is due to an incorrect folder name, it should be UnitConversionsFiles
13. The import files HA_H.obs_PI.xml and HA_Q.obs_PI.xml are not valid against the pi_timeseries schema. For each series the MissVal, Units and Header is duplicated.
14. The importType specified in the ModuleConfigFile HA_import_observed was incorrect, it was EA, but it should be PI (this is different from e.g. Midlands).
15. Some of the timeSeriesTypes in the filters and in the ModuleConfigfiles were incorrectly specified (e.g. they were external historical, but they should be simulated forecasting).
16. The Scenario Editor Configuration file was added to the configuration
17. Some shapefiles were added to the GridDisplay configuration file. The relative view period was shortened (by 50%) to make the spatial plot start up faster. The HTop (Top elevation) layer has been removed from the file.
18. Some ModuleConfigFiles have been extended with extra TimeSeriesSets (parameters) to feed the GridDisplay and filters with extra data. Also some of the synchlevels have changed as they were not specified correctly.
19. The parameter file has been updated as a newer version of this file was available.
20. The Explorer configuration file has been updated to include two extra shapefiles for SouthWest.
21. The DisplayGroups configuration file has been changed to display data for a shorter period. The displays containing references to the LongTermAverage scenarios have been removed as this scenario is not part of the configuration.