Skip to content
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.

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

Support for FES2014 tide model via CNES aviso-fes. #919

Merged
merged 1 commit into from
May 25, 2022
Merged

Support for FES2014 tide model via CNES aviso-fes. #919

merged 1 commit into from
May 25, 2022

Conversation

rtaib
Copy link
Contributor

@rtaib rtaib commented May 23, 2022

  • Coded as replacement drop-in for coastal.py
  • See documentation in pyfes_model.py

Proposed changes

A drop-in alternative to the OTPS tide model in Tools/dea_tools/coastal.py which defaults to OTPS and then tries to use aviso-fes, if installed, to calculate tide heights. It is coded as a new pyfes_model.py with the same method signatures as the current code to allow seamless swapping without changes to the current code. However, the user needs to set the FES2014_OCEAN_INI environment variable as explained in the docstring for the module.
An example of use is provided in Real_world_examples/Coastal_erosion.ipynb.

Closes issues (optional)

  • NA

Checklist (replace [ ] with [x] to check off)

  • Notebook created using the DEA-notebooks template
  • Remove any unused Python packages from Load packages
  • Remove any unused/empty code cells
  • Remove any guidance cells (e.g. General advice)
  • Ensure that all code cells follow the PEP8 standard for code. The jupyterlab_code_formatter tool can be used to format code cells to a consistent style: select each code cell, then click Edit and then one of the Apply X Formatter options (YAPF or Black are recommended).
  • Include relevant tags in the final notebook cell (refer to the DEA Tags Index, and re-use tags if possible)
  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated
  • Test notebook on both the NCI and DEA Sandbox (flag if not working as part of PR and ask for help to solve if needed)
  • If applicable, update the Notebook currently compatible with the NCI|DEA Sandbox environment only line below the notebook title to reflect the environments the notebook is compatible with

- Coded as replacement drop-in for coastal.py
- See documentation in pyfes_model.py
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@robbibt robbibt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me, thanks for this! Depending on whether we can find an easy way to install aviso-fes, we might end up adopting a similar approach later on as the default way to model tides in the DEA Sandbox too

@robbibt robbibt merged commit e41af50 into GeoscienceAustralia:develop May 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants