Skip to content

Update dolfyn function docstrings and associated notebooks #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akeeste merged 4 commits into from
Sep 9, 2025
Merged

Update dolfyn function docstrings and associated notebooks #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
045e357
Backup
jmcvey3 Aug 19, 2025
0a5c2a4
Update jupyter notebooks
jmcvey3 Aug 28, 2025
d048e89
update notebooks
jmcvey3 Aug 29, 2025
d316c62
fix a couple of typos in adv_example
akeeste Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions examples/adcp_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3970,7 +3970,7 @@
"#### Quick 5-beam ADCP lesson before we dive in:\n",
"\n",
"There are a couple caveats to calculating Reynolds stress tensor components:\n",
" 1. Because this instrument only has 5 beams, we can only find 5 of the 6 components (6 unkowns, 5 knowns)\n",
" 1. Because this instrument only has 5 beams, we can only find 5 of the 6 components (6 unknowns, 5 knowns)\n",
" 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",
" 3. It is possible to rotate the tensor, but we'd need to know all 6 components to do so properly (\"coupled ADCPs\")\n",
" 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"
Expand Down Expand Up @@ -4131,11 +4131,8 @@
}
],
"metadata": {
"interpreter": {
"hash": "5cfd453a1a1cce2f32ea80f99ff7da863344217116d39185ac62b248c2577445"
},
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "work",
"language": "python",
"name": "python3"
},
Expand Down
Loading
Loading