ISWFM v2.0: An updated three-dimensional MITgcm model of Internal solitary waves in the northern South China Sea

This repository contains all publicly available code and data required to run the Northern South China Sea (NSCS) model using the MITgcm ocean model (ISWFM-NSCS v2.0). The model accounts for background currents, horizontally inhomogeneous stratifications, and optimized turbulence parameters. Additionally, the repository includes model output data, such as temperature, velocity, and sea surface gradients at a specific timestep: 12:00 UTC, August 12, 2014.

Please note that our model is primarily developed based on the MITgcm (MIT General Circulation Model), and its operation relies on the MITgcm framework. MITgcm is an open-source ocean model, and its code and documentation are publicly available on its official website (https://mitgcm.org/source-code/, last access: 10 February 2025).

>> Contact Information:Email: [e-mail]: State Key Laboratory of Tropical Oceanography, South China Sea Institute of Oceanology, Chinese Academy of Sciences, Guangzhou 510301, China

>> Repository Structure:===================================================================1. Model Code Files (ISWFM_NSCS_v2.0_Code_Files/)This folder contains all necessary input files for initializing and running the model.

>> Three-dimensional initial stratification:Located in the input/ folder, named SCS_MRGRID3D_TSUV_T.3d (temperature).These files are derived from the HYCOM reanalysis dataset (HYbrid Coordinate Ocean Model) and integrated into the model grids to account for horizontally inhomogeneous conditions.

>> Velocity boundary conditions:Stored in the input/ folder with filenames such as SCS_MRGRID3D_TSUV_U.3d.North (zonal velocity at the north boundary) and SCS_MRGRID3D_TSUV_V.3d.South (meridional velocity at the south boundary).

>> Tidal boundary conditions:Stored in the input/ folder with filenames such as OB_East_u_Amp.bin (amplitude) and OB_East_u_Gph.bin (phase).Derived from the Oregon State University TOPEX/Poseidon Solution (TPXO8-atlas, 1/30° resolution) (Egbert & Erofeeva, 2002).

>> Bathymetry data:File: Luzon.topo.linear.3dSourced from the GEBCO global gridded bathymetry dataset (https://www.gebco.net/data_and_products/gridded_bathymetry_data).

>> Model source code:Stored in the code/ folder, containing all relevant scripts required for compiling the model.

===================================================================2. Model Data Files (ISWFM_NSCS_v2.0_Data_Files/)This folder contains the results generated by the model.

>> Grid information:Available in grid.glob.nc, hFacC.glob.nc, and hFacS.glob.nc.

>> Simulation results (timestep: 12:00 UTC, August 12, 2014):Sea surface elevation: stateEta.0000064800.glob.ncTemperature: stateT.0000064800.glob.ncZonal velocity (U-component): stateU.0000064800.glob.ncMeridional velocity (V-component): V.0000064800.glob.nc