The generation of the General Adapter ModuleConfigFiles to run Modflow is split in two steps. The first step is to create the ModuleConfigFiles using the runMF sheet. This will create a set of configuration files with all available elements. Some of these elements are not required in the reference scenarios, therefore these elements should be removed using the remove sheet (step 2).
Step 1
The following section provides an explanation of all the columns in the runMF sheet which is part ModuleConfigFile generation spreadsheet:
Column Name |
Explanation of contents |
|---|---|
SECTION |
The elements in this column refer to a specific section of the (General Adapter) configuration file. Each of the rows in the sheet apply to one of the four sections: general, export, execute and import |
NAME |
Refers to the name of the file to export data to, to execute or to import data from. In case of the first row it is the folder name abbreviation you used for this model |
FILETYPE |
Refers to the type of the file to export data to, to execute or to import data from. The options are: Timeseries, Mapstacks or Parameters. In case of the general and execute section it is the folder name specifying the Modflow version used (Mf96 or MFvkd) |
MI_PREFIX |
The ModuleInstance prefix is the model abbreviation and is applied to all elements in the configuration files where the model prefix is used (file names, etc) |
MI_SOURCE |
This is the ModuleInstance source and refers to a unique part of the ModuleInstanceId which is used to store the data. In case of an import activity it is referring to the ModuleInstanceID of the current ModuleConfigFile. In case of an export activity it should refer to the ModuleInstanceId which was used to create the original data |
VALTYPE |
The type of data to be exported or imported. The options are scalar, polygon, grid and longitudinalprofile |
PAR |
This column contains a reference to the parameter to be exported or imported. The name of the parameter should be taken from the parameters.xml. In the general and execute section of the sheet the cell should be blank |
LOC |
This column is referring to the location used for importing or exporting the data. Locations and LocationSet are mutually exclusive. Either one or the other should be filled in |
LOCSET |
This column is referring to the locationSet used for importing or exporting the data. Locations and LocationSet are mutually exclusive. Either one or the other should be filled in |
SYNCH |
This column is used to specify the synchronisation level of the data that is being created and stored in the database. More information about the synchronisation levels can be found in Step 7. ModuleInstances (ModuleConfigfiles) |
EXPIRY_UNIT |
Defines the unit of the expiry time you want to specify. The expiry time determines how long data will be kept in the database. Typically we use either (16) hour for temporary data or (26) week |
EXPIRY_MULTIPLIER |
Defines the multiplier of the expiry time you want to specify. The expiry time determines how long data will be kept in the database. Typically we use either 16 (hour) for temporary data or 26 (week) |
TIMEOUT |
This defines the amount of time (in milliseconds) NGMS is waiting for the executable to complete its task. If the task has not been completed within this time NGMS is going to continu with the next task and will regard the executable as being failed |
O_DIAGNOSTICS |
This colum is only used for the 'execute'-section of the sheet and it contains the path and name of the diagnostics file created by the executable |
TIMESTEP |
This is referring to the the TimeStep used for the data being exported or imported. It can either be nonequidistant or DaysOfMonth |
EXPORTUNIT |
This column is referring to the unit of the period for which you want to export data. Typically we specify the export period in days. It is only used for the 'export'-section of the sheet |
EXPORTSTART |
This column is referring to the start of the period for which you want to export data. Typically the start of the export period should be the end of the first model timeStep. It is only used for the 'export'-section of the sheet |
EXPORTEND |
This column is referring to the end of the period for which you want to export data. Typically the end of the export period should be the end of the simulation. It is only used for the 'export'-section of the sheet |
Step 2
The following section provides an explanation of all the columns in the remove sheet which is part ModuleConfigFile generation spreadsheet:
Column Name |
Explanation of contents |
|---|---|
SECTION |
This column indicates the action that needs to take place. Three options are available: file, remove and print. File indicates that this line conatins information on the file involved, remove indicvates the actual elements taht need removing and print refers to the print action after removing some elements |
MODEL |
Model abbreviation to create name of ModuleConfigFiles to change |
FILE |
Name (without model abbreviation) of ModuleConfigFile that needs to be changed |
FILE_NEW |
New File name version number |
FILE_OLD |
Version number of old file |
SECTION |
The elements in this column refer to a specific section of the (General Adapter) configuration file. Each of the rows in the sheet apply to one of the four sections: general, export, execute and import |
NAME |
Refers to the name of the file to export data to, to execute or to import data from. In case of the first row it is the folder name abbreviation you used for this model |
FILETYPE |
Refers to the type of the file to export data to, to execute or to import data from. The options are: Timeseries, Mapstacks or Parameters. In case of the general and execute section it is the folder name specifying the Modflow version used (Mf96 or MFvkd) |
MI_PREFIX |
The ModuleInstance prefix is the model abbreviation and is applied to all elements in the configuration files where the model prefix is used (file names, etc) |
MI_SOURCE |
This is the ModuleInstance source and refers to a unique part of the ModuleInstanceId which is used to store the data. In case of an import activity it is referring to the ModuleInstanceID of the current ModuleConfigFile. In case of an export activity it should refer to the ModuleInstanceId which was used to create the original data |
VALTYPE |
The type of data to be exported or imported. The options are scalar, polygon, grid and longitudinalprofile |
PAR |
This column contains a reference to the parameter to be exported or imported. The name of the parameter should be taken from the parameters.xml. In the general and execute section of the sheet the cell should be blank |
LOC |
This column is referring to the location used for importing or exporting the data. Locations and LocationSet are mutually exclusive. Either one or the other should be filled in |
LOCSET |
This column is referring to the locationSet used for importing or exporting the data. Locations and LocationSet are mutually exclusive. Either one or the other should be filled in |
SYNCH |
This column is used to specify the synchronisation level of the data that is being created and stored in the database. More information about the synchronisation levels can be found in Step 7. ModuleInstances (ModuleConfigfiles) |
EXPIRY_UNIT |
Defines the unit of the expiry time you want to specify. The expiry time determines how long data will be kept in the database. Typically we use either (16) hour for temporary data or (26) week |
EXPIRY_MULTIPLIER |
Defines the multiplier of the expiry time you want to specify. The expiry time determines how long data will be kept in the database. Typically we use either 16 (hour) for temporary data or 26 (week) |
TIMEOUT |
This defines the amount of time (in milliseconds) NGMS is waiting for the executable to complete its task. If the task has not been completed within this time NGMS is going to continu with the next task and will regard the executable as being failed |
O_DIAGNOSTICS |
This colum is only used for the 'execute'-section of the sheet and it contains the path and name of the diagnostics file created by the executable |
TIMESTEP |
This is referring to the the TimeStep used for the data being exported or imported. It can either be nonequidistant or DaysOfMonth |
EXPORTUNIT |
This column is referring to the unit of the period for which you want to export data. Typically we specify the export period in days. It is only used for the 'export'-section of the sheet |
EXPORTSTART |
This column is referring to the start of the period for which you want to export data. Typically the start of the export period should be the end of the first model timeStep. It is only used for the 'export'-section of the sheet |
EXPORTEND |
This column is referring to the end of the period for which you want to export data. Typically the end of the export period should be the end of the simulation. It is only used for the 'export'-section of the sheet |
