Workflow, Scripts, and Data for paper "Efficient representation of transient tidal overheight in a coastal groundwater flow model using a phase-averaged tidal boundary condition"

Data, scripts, and workflow for the paper

Haehnel, P., Greskowiak, J., Robinson, C. E., Schuett, M., and Massmann, G. (2023). Efficient representation of transient tidal overheight in a coastal groundwater flow model using a phase-averaged tidal boundary condition Models. Advances in Water Resources 181, 104538. https://doi.org/10.1016/j.advwatres.2023.104538

This record provides the complete procedure of data preparation, model simulation, simulation post-processing, and analysis performed to obtain the results presented in the aforementioned publication.

A Python module 'mfpatbc', which provides a flopy comaptible implementation of the phase-averaged tidal boundary condition presented in the publication, is available at https://github.com/phaehnel/mfpatbc [made public if manuscript is accepted].

Brief summary of the record contents

• figures.zip contains figures as present in the publication and corresponding scripts used to create them.
• ICAM.zip contains workflow, data, scripts, and results of the paramater study on an idealized coastal aquifer model (ICAM). The ICAM is a cross-sectional model of a simple coastal aquifer, implemented in MODFLOW-NWT. The empirical correction function for the phase-averaged tidal boundary condition presented in the associated paper is derived from the simulation results of the parameter study.
• LICENSE.txt contains license information for this record as well as all data and software from external sources which was required in the workflow and is provided in this record. References to the metadata of data and software from external sources are provided in 'Related identifiers'.
• prepare_tide_data.zip contains tide gauge data from Wangerooge West, scripts and workflow to prepare them for further usage in the groundwater flow model of Spiekeroog.
• SPK[X].zip contain workflow, data, scripts, and results for the real-world application of the developed phase-averaged tidal boundary condition. This is a transient, three-dimensional, and unconfined numerical groundwater flow model of the barrier island of Spiekeroog (Northwest Germany), implemented in MODFLOW-2005. Is split up into multiple zip-files for size reasons.
• tables.zip contains tables and data sets as present in the publication and corresponding scripts used to create them.
• videos.zip contains movies present in the publications' supporting information and corresponding scripts used to create them.
• zipsplit.idx lists the directory of all files within the folder 'SPK' files in the split zip-files 'SPK[X].zip'.

Folders 'ICAM', 'SPK', and 'prepare_tide_data' contain DOCUMENTATION.txt files that guide through the structure of the folder and shortly describe the contents. Metadata on data files is provided within these folders as well. Such files are named 'META_DATA.txt'. The zip-folders resemble the first level of the folder structure of the workflow. Make sure to merge the folders 'SPK[X].zip' as described below.

Required software

Scripts are written in Python (Version 3.9.12) and R (Version 4.2.2). Some geospatial tasks were performed with QGIS (Version 3.20.1). Groundwater flow simulations were performed with MODFLOW-NWT (Version 1.2.0) and MODFLOW-2005 (Version 1.12.0) with flopy (Version 3.3.5). MODFLOW binary executables compiled on a Ubuntu 20.04 system are included in this record. Should you require other ones, consider https://github.com/MODFLOW-USGS/executables or https://github.com/modflowpy/pymake.

Merging zip-files for folder 'SPK'

The folder containing the workflow of the Spiekeroog model was split into multiple zip-files. They are named 'SPK[X].zip' where [X] = 1, 2, 3, … . On Windows, you may merge them into the original folder by extracting all the zip-files 'SPK[X].zip' into the same folder. Make sure that this folder is named 'SPK', otherwise certain scripts may not work.

On Linux, you may use the terminal and something like

cat SPK*.zip > SPK.zip
unzip SPK.zip

or do it manually as described for Windows.
 

Changes to v2.0.0

• Adapted line styles of low and high water and mean low and mean high water in all figures
• script 'figures/fig_10_SPK_rmsd.R' was updated to include variability ratio VR in output csv-file
• Fig. 2, y-axis tick labels were updated
• Fig. 3, included horizontal line for zep
• Fig. 4, included country codes and administrative boundaries copyright note
• Fig. 9, included "hydraulic" in axes labels
• Fig. 10/Fig. S7 was redesigned to include the additional measure variability ratio (VR)
• Fig. S3, axis labels were updated
• Fig. S11 was added, additional geospatial files in folder 'SPK/data' to create the plot were added