WIP: Pytides submodule

[rjleveque]

This PR might replace #3, and also clawpack/geoclaw#532, following some offline discussion about how best to organize things.

This includes pytides as a submodule, with some modifications to make the import statements work in Python3. Similar changes have been suggested in an open PR on the original site, but original pytides does not seem to be actively developed.

These changes are also implemented in other forks, e.g.

• https://github.com/titoconte/pytides
• https://github.com/drf5n/pytides

but these seem to have some other potential problems, and also do not seem to be actively developed, so I suggest we just maintain our own fork within this module.

There are also some other changes that have been implemented in the forks above and/or suggested in open PRs on pytides that we might want to consider, in particular at least one typo in a value for K2.

This PR includes a local tidetools.py with the utilities from tide.py in clawpack/geoclaw#532, and some additional utilities we have developed for other projects. There is also a pytides_tools.py that maybe should be combined with tidetools.py.

Currently this PR also contains a couple notebooks illustrating usage:

• pytides_examples/demo_noaa_constituents.ipynb: Adapted from an example on the pytides wiki, with some additional plots an illustration of using tidetools to download the constituents,
• pytides_examples/Tide_Module_Examples_pytides.ipynb: Adapted from the notebook in Updated tide module and Jupyter notebook! #3, now using the local tidetools and pytides.

More examples to come.

[mandli]

@socoyjonathan what are your thoughts regarding these changes?

[socoyjonathan]

@mandli I like these changes to make pytides as a submodule and work around that package! may we schedule a meeting to discuss how I can best contribute to this project further!

@rjleveque I am reviewing your comments on Tide_Module_Examples_pytides.ipynb! thank you for your excellent feedback!

[mandli]

Just a quick update on this. @socoyjonathan is looking into incorporating this module and his into the tide-examples (this repository). Waiting to make sure this seems to work well.

[socoyjonathan]

@rjleveque I have refactored tidetools.py to adequately incorporate our work and improved comments on Tide_Module_Examples_pytides.ipynb (now named Tidetools_Module_Examples).

I would like to contribute these changes to your PR so that your PR can be approved, however I don't know if that is the best option. Or should I open my own PR on clawpack/tidal-examples repository and submit my changes there to be reviewed separately?

[rjleveque]

@socoyjonathan: Thanks for doing this! I think it's simplest if I go ahead and merge this PR, and then you can do a new PR with the improvements. Will that work for you?

[socoyjonathan]

@rjleveque: Yes that would be perfect! Thank you!