Skip to content

Commit aefc1d6

Browse files
jmcvey3akeeste
andauthored
Update dolfyn function docstrings and associated notebooks (#412)
Reviewed function docstrings, particularly the ones related to turbulence. Corrected some of the mathematical notation so they should build better in Sphinx's api-build. I updated the ADV example notebook with a clip of real data and plots showing how to display data --------- Co-authored-by: akeeste <akeeste@sandia.gov>
1 parent fb005ce commit aefc1d6

8 files changed

Lines changed: 1541 additions & 1142 deletions

File tree

examples/adcp_example.ipynb

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3970,7 +3970,7 @@
39703970
"#### Quick 5-beam ADCP lesson before we dive in:\n",
39713971
"\n",
39723972
"There are a couple caveats to calculating Reynolds stress tensor components:\n",
3973-
" 1. Because this instrument only has 5 beams, we can only find 5 of the 6 components (6 unkowns, 5 knowns)\n",
3973+
" 1. Because this instrument only has 5 beams, we can only find 5 of the 6 components (6 unknowns, 5 knowns)\n",
39743974
" 2. Because the ADCP's instrument (XYZ) axes weren't aligned with the flow during deployment, we don't know what direction these components are aligned to (i.e. the 'u' direction is not necessarily the streamwise direction)\n",
39753975
" 3. It is possible to rotate the tensor, but we'd need to know all 6 components to do so properly (\"coupled ADCPs\")\n",
39763976
" 4. Measurements close to the seafloor can be suspect due to increased vertical flow. ADCPs operate under the \"assumption of homogeneity\", which means that they can only accurate measure consistent horizontal currents with relatively little vertical motion.\n"
@@ -4131,11 +4131,8 @@
41314131
}
41324132
],
41334133
"metadata": {
4134-
"interpreter": {
4135-
"hash": "5cfd453a1a1cce2f32ea80f99ff7da863344217116d39185ac62b248c2577445"
4136-
},
41374134
"kernelspec": {
4138-
"display_name": "Python 3 (ipykernel)",
4135+
"display_name": "work",
41394136
"language": "python",
41404137
"name": "python3"
41414138
},

0 commit comments

Comments
 (0)