Skip to content

Commit

Permalink
paper
Browse files Browse the repository at this point in the history
  • Loading branch information
chadagreene committed Aug 22, 2023
1 parent fc1f81f commit cbcb884
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![View Tide Model Driver (TMD) version 3.0 on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/133417-tide-model-driver-tmd-version-3-0)
[![status](https://joss.theoj.org/papers/228e6fd7edc42dc6d443ce60feef8c6d/status.svg)](https://joss.theoj.org/papers/228e6fd7edc42dc6d443ce60feef8c6d)

# Tide Model Driver 3.0
![TMD logo](doc/markdown_figures/tmd_logo_v2.gif)
Expand Down
21 changes: 14 additions & 7 deletions paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ @article{carrillo:2005
volume={22},
number={1},
pages={84--97},
year={2005}
year={2005},
doi={10.1175/JTECH-1687.1}
}

@article{loder:1980,
Expand All @@ -16,7 +17,8 @@ @article{loder:1980
volume={10},
number={9},
pages={1399--1416},
year={1980}
year={1980},
doi={10.1175/1520-0485(1980)010<1399:TROTCO>2.0.CO;2}
}

@article{munk:1998,
Expand All @@ -27,7 +29,8 @@ @article{munk:1998
number={12},
pages={1977--2010},
year={1998},
publisher={Elsevier}
publisher={Elsevier},
doi={10.1016/S0967-0637(98)00070-3}
}

@article{padman:2004,
Expand All @@ -37,7 +40,8 @@ @article{padman:2004
volume={31},
number={2},
year={2004},
publisher={Wiley Online Library}
publisher={Wiley Online Library},
doi={10.1029/2003GL019003}
}


Expand All @@ -49,7 +53,8 @@ @article{padman:2018
number={1},
pages={142--184},
year={2018},
publisher={Wiley Online Library}
publisher={Wiley Online Library},
doi={10.1002/2016RG000546}
}

@misc{padman:2022,
Expand All @@ -68,7 +73,8 @@ @article{smith:2000
number={5},
pages={399--413},
year={2000},
publisher={Springer}
publisher={Springer},
doi={10.1007/s001900000101}
}

@article{stammer:2014,
Expand All @@ -79,5 +85,6 @@ @article{stammer:2014
number={3},
pages={243--282},
year={2014},
publisher={Wiley Online Library}
publisher={Wiley Online Library},
doi={10.1002/2014RG000450}
}
1 change: 1 addition & 0 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ bibliography: paper.bib

Astronomically-forced tides influence ocean surface height and currents on timescales of minutes to years. Tides contribute to ocean mixing [@munk:1998] and mean flows [@loder:1980], ice sheet and sea ice dynamics, and melting of ice shelves and marine terminating glaciers [@padman:2018]. Tidal signals must be accurately removed when calculating long-term trends in ocean surface height from tidally aliased satellite altimetry measurements [@smith:2000], and the tidal component of ocean circulation must be removed for analyses of ship-based current measurements [@carrillo:2005]. Several models have been made publicly available to predict tides on global [@stammer:2014] or regional [e.g., @padman:2004] scales. Each model contains only information about the complex coefficients of tidal constituents, and therefore requires software to extract and manipulate the data into a meaningful form.

# Statement of need
The Tide Model Driver for MATLAB version 3.0 (TMD3.0) allows users to access and calculate tidal predictions from model coefficients at arbitrary locations and times, and this version of the software represents decades of development by the tide community. The underlying equations for TMD were originally written in Fortran by Richard Ray, and were converted into MATLAB functions by Oregon State University and Earth and Space Research in 2005 [@padman:2022]. The MATLAB version of TMD developed a global user base well before the advent of GitHub or modern documentation standards, but no major updates have been implemented since its inception. The updated toolbox presented here has been restructured for computational efficiency and ease of use, but relies on the same mathematical equations that have been employed since its earliest implementation. The documentation has been greatly expanded to include clear descriptions of syntax along with many thoroughly explained, replicable examples that use real-world ocean data provided with the software. For TMD3.0, we also introduce a new, consolidated NetCDF tide model data format that is compact, user friendly, and can be used for any barotropic ocean or load tide model. TMD3.0 is issued as a free, open-source software package that is available to all.

# Acknowledgements
Expand Down

0 comments on commit cbcb884

Please sign in to comment.