SMS:ADCIRC Tidal Constituents: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
(Created page with "__NOINDEX__ {{Version SMS 13.1}} SMS uses Harmonica ([https://github.com/Aquaveo/harmonica github.com/Aquaveo/harmonica]) for harmonic tidal data extraction. Harmonica is an o...") |
No edit summary |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<!--The directory that the user puts their files is out of date. this article tells users to put them in the site-packages directory, but for many users this folder is protected and they can't write ther. | |||
so the directory we look is in appdata. | |||
SMS uses Harmonica ([https://github.com/Aquaveo/harmonica github.com/Aquaveo/harmonica]) for harmonic tidal data extraction. Harmonica is an open-source | To get to that directory, the user can open a file browser and enter %appdata% | ||
That will send them to a directory for their application data. For me, it is in: C:\Users\azundel\AppData\Roaming | |||
From that folder they need a folder named "harmonica" and a folder named "data" in that folder.. | |||
So again, for me, the total path is C:\Users\azundel\AppData\Roaming\harmonica\data | |||
Each tidal database has its own folder in the data folder. | |||
for example, my txpo8 folder is: C:\Users\azundel\AppData\Roaming\harmonica\data\tpxo8 | |||
I am not sure the typical user knows how to get to appdata. That is why I described it to you. | |||
Once they are there, the instructions should be in line with what we have on the wiki--> | |||
This article is about tidal constituent source data. For applying tidal constituents to an ADCIRC simulation, see the [[SMS:ADCIRC_Graphical_Interface#Tidal_Components|''Tidal Constituents'' dialog]]. | |||
SMS uses Harmonica ([https://github.com/Aquaveo/harmonica github.com/Aquaveo/harmonica]) for harmonic tidal data extraction. Harmonica is an open-source 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, TPXO8 and TPXO9 models are also supported but require a separate license from their distributors. Complete the following steps to use the licensed datasets in SMS. | |||
===Appdata Directory=== | |||
Regardless of which model is used, it needs to be ensured that the files are going to the right place. Here are the steps for getting to the right folder. | |||
#Open a file browser and enter "%appdata%". This should go to a directory for the user's application data. | |||
#In this folder, a "harmonica" folder will be needed, which should contain a folder named "data". | |||
===FES2014=== | ===FES2014=== | ||
Steps for installing the FES2014 model: | Steps for installing the FES2014 model: | ||
#Copy all FES2014 tidal elevation *.nc files to the <Path to | #Copy all FES2014 tidal elevation *.nc files to the <Path to Appdata>/harmonica/data/fes2014 | ||
#*If the “data” or “fes2014” folders do not exist, create them. | #*If the “data” or “fes2014” folders do not exist, create them. | ||
#Ensure all of the NetCDF files follow the default FES2014 naming convention: <constituent name>.nc (e.g., “2n2.nc”, “k2.nc”). | #Ensure all of the NetCDF files follow the default FES2014 naming convention: <constituent name>.nc (e.g., “2n2.nc”, “k2.nc”). | ||
| Line 11: | Line 26: | ||
===TPXO8=== | ===TPXO8=== | ||
Steps for installing the TPXO8 model: | Steps for installing the TPXO8 model: | ||
#Copy all TPXO8 tidal elevation *.nc files to the <Path to | #Copy all TPXO8 tidal elevation *.nc files to the <Path to Appdata>/harmonica/data/tpxo8 | ||
#*If the “data” or “tpxo8” folders do not exist, create them. | #*If the “data” or “tpxo8” folders do not exist, create them. | ||
#Harmonica expects the NetCDF files to be named with the default convention used by OSU. | #Harmonica expects the NetCDF files to be named with the default convention used by OSU. | ||
| Line 19: | Line 34: | ||
===TPXO9=== | ===TPXO9=== | ||
Steps for installing the TPXO9 model: | Steps for installing the TPXO9 model: | ||
#Copy the TPXO9 tidal elevation NetCDF file to the <Path to | #Copy the TPXO9 tidal elevation NetCDF file to the <Path to Appdata>/harmonica/data/tpxo9/tpxo9_netcdf | ||
#*If the “data”, “tpxo9”, or “tpxo9_netcdf” folders do not exist, create them. | #*If the “data”, “tpxo9”, or “tpxo9_netcdf” folders do not exist, create them. | ||
#Harmonica expects the tidal elevation NetCDF file to be named “h_tpxo9.v1.nc”. Rename the file if necessary. | #Harmonica expects the tidal elevation NetCDF file to be named “h_tpxo9.v1.nc”. Rename the file if necessary. | ||
| Line 26: | Line 41: | ||
* [[SMS:ADCIRC|ADCIRC]] | * [[SMS:ADCIRC|ADCIRC]] | ||
* [[SMS:ADCIRC_Coverages#Tidal_Attributes|Tidal Attributes]] | * [[SMS:ADCIRC_Coverages#Tidal_Attributes|Tidal Attributes]] | ||
* [[SMS:ADCIRC_Graphical_Interface#Tidal_Components|Tidal Constituents Dialog]] | |||
* [[Tidal Constituents]] | |||
Latest revision as of 16:33, 7 April 2023
This article is about tidal constituent source data. For applying tidal constituents to an ADCIRC simulation, see the Tidal Constituents dialog.
SMS uses Harmonica (github.com/Aquaveo/harmonica) for harmonic tidal data extraction. Harmonica is an open-source 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, TPXO8 and TPXO9 models are also supported but require a separate license from their distributors. Complete the following steps to use the licensed datasets in SMS.
Appdata Directory
Regardless of which model is used, it needs to be ensured that the files are going to the right place. Here are the steps for getting to the right folder.
- Open a file browser and enter "%appdata%". This should go to a directory for the user's application data.
- In this folder, a "harmonica" folder will be needed, which should contain a folder named "data".
FES2014
Steps for installing the FES2014 model:
- Copy all FES2014 tidal elevation *.nc files to the <Path to Appdata>/harmonica/data/fes2014
- If the “data” or “fes2014” folders do not exist, create them.
- Ensure all of the NetCDF files follow the default FES2014 naming convention: <constituent name>.nc (e.g., “2n2.nc”, “k2.nc”).
TPXO8
Steps for installing the TPXO8 model:
- Copy all TPXO8 tidal elevation *.nc files to the <Path to Appdata>/harmonica/data/tpxo8
- If the “data” or “tpxo8” folders do not exist, create them.
- 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”).
TPXO9
Steps for installing the TPXO9 model:
- Copy the TPXO9 tidal elevation NetCDF file to the <Path to Appdata>/harmonica/data/tpxo9/tpxo9_netcdf
- If the “data”, “tpxo9”, or “tpxo9_netcdf” folders do not exist, create them.
- Harmonica expects the tidal elevation NetCDF file to be named “h_tpxo9.v1.nc”. Rename the file if necessary.
Related Topics
SMS – Surface-water Modeling System | ||
|---|---|---|
| Modules: | 1D Grid • Cartesian Grid • Curvilinear Grid • GIS • Map • Mesh • Particle • Quadtree • Raster • Scatter • UGrid |  |
| General Models: | 3D Structure • FVCOM • Generic • PTM | |
| Coastal Models: | ADCIRC • BOUSS-2D • CGWAVE • CMS-Flow • CMS-Wave • GenCade • STWAVE • WAM | |
| Riverine/Estuarine Models: | AdH • HEC-RAS • HYDRO AS-2D • RMA2 • RMA4 • SRH-2D • TUFLOW • TUFLOW FV | |
| Aquaveo • SMS Tutorials • SMS Workflows | ||
