User:Jcreer/SMS:ADCIRC Tidal Constituents

SMS uses harmonica (https://github.com/Aquaveo/harmonica) for harmonic tidal data extraction. harmonica is an open-source Python API that supports several tidal models. The ADCIRC 2015 and legacy LeProvost models are freely distributed, and the datasets are automatically downloaded from the Internet the first time an extraction is performed using one of these models. The FES2014 and TPXO8/9 models are also supported but require a separate license from their distributors. Complete the following steps to use the licensed datasets in SMS.

Steps for installing the FES2014 model:

1. Copy all FES2014 tidal elevation *.nc files to the <Path to SMS installation>/Python36/Lib/site-packages/harmonica/data/fes2014
   • If the “data” or “fes2014” folders do not exist, create them.
2. Ensure all of the NetCDF files follow the default FES2014 naming convention: <constituent name>.nc (e.g., “2n2.nc”, “k2.nc”).

Steps for installing the TPXO8 model:

1. Copy all TPXO8 tidal elevation *.nc files to the <Path to SMS installation>/Python36/Lib/site-packages/harmonica/data/tpxo8
   • If the “data” or “tpxo8” folders do not exist, create them.
2. harmonica expects the NetCDF files to be named with the default convention used by OSU.
   • For 1/30 degree constituents (K1, K2, M2, M4, N2, O1, P1, Q1, S2): Files should be named “hf.<constituent name>_tpxo8_atlas_30c_v1.nc” (e.g., “hf.k1_tpxo8_atlas_30c_v1.nc”, “hf.m2_tpxo8_atlas_30c_v1.nc”).
   • For 1/6 degree constituents (MF, MM, MN4, MS4): Files should be named “hf.<constituent name>_tpxo8_atlas_6.nc” (e.g., “hf.mf_tpxo8_atlas_6.nc”, “hf.mm_tpxo8_atlas_6.nc”).

Steps for installing the TPXO9 model:

1. Copy the TPXO9 tidal elevation NetCDF file to the <Path to SMS installation>/Python36/Lib/site-packages/harmonica/data/tpxo9/tpxo9_netcdf
   • If the “data”, “tpxo9”, or “tpxo9_netcdf” folders do not exist, create them.
2. harmonica expects the tidal elevation NetCDF file to be named “h_tpxo9.v1.nc”. Rename the file if necessary.