Skip to content

Tidal modelling notebook update#610

Open
LeilaMemoi wants to merge 16 commits intomainfrom
maritim_branch
Open

Tidal modelling notebook update#610
LeilaMemoi wants to merge 16 commits intomainfrom
maritim_branch

Conversation

@LeilaMemoi
Copy link

Summary of Changes

  1. Set up the model directory
  2. Updated the functions to use those from the new eo_tides package: tag_tides, pixel-tides, and model_phases
  3. Updated the Markdown documentation to reflect the new changes

Errors

  • The section on swapping dimensions is still not functional
  • The eo_tides API reference does not provide documentation for this feature, so the implementation remains incomplete

@mpho-sadiki
Copy link
Contributor

mpho-sadiki commented Nov 21, 2025

Hi @LeilaMemoi. I tried opening Tidal_modelling.ipynb but Jupyter shows an error saying the file is unreadable (Notebook does not appear to be JSON). It might have been accidentally saved empty or corrupted during the commit. Would you mind checking the notebook on your side?

@LeilaMemoi
Copy link
Author

Hi @LeilaMemoi. I tried opening Tidal_modelling.ipynb but Jupyter shows an error saying the file is unreadable (Notebook does not appear to be JSON). It might have been accidentally saved empty or corrupted during the commit. Would you mind checking the notebook on your side?

@mpho-sadiki , I have made corrections

@robbibt
Copy link
Contributor

robbibt commented Nov 24, 2025

In case it is useful, here's the Australian version of the notebook, updated for eo-tides. We no longer include functionality for swapping dimensions, so you can probably skip that bit.

https://knowledge.dea.ga.gov.au/notebooks/How_to_guides/Tidal_modelling.html

@LeilaMemoi
Copy link
Author

Thanks @robbibt

Copy link
Contributor

@mpho-sadiki mpho-sadiki left a comment

Choose a reason for hiding this comment

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

Hi @LeilaMemoi. Before we do a final review, approval and merge, there are just a few standard DE Africa notebook checks to tidy up. Could you please have a look at the following:

  • 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)

  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated.

Additionally, the two intertidal elevation notebooks, update the Model tide heights markdown to remove reference to OTPS TPXO8 tidal model. You can use the Coastal_erosion and Mangrove_analysis notebook for reference.

Happy to help if anything is unclear.

@LeilaMemoi
Copy link
Author

Hi @LeilaMemoi. Before we do a final review, approval and merge, there are just a few standard DE Africa notebook checks to tidy up. Could you please have a look at the following:

  • 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)
  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated.

Additionally, the two intertidal elevation notebooks, update the Model tide heights markdown to remove reference to OTPS TPXO8 tidal model. You can use the Coastal_erosion and Mangrove_analysis notebook for reference.

Happy to help if anything is unclear.

Hi @mpho-sadiki the requested changes to Tidal_modelling.ipynb have been made. However, I am not quite certain about the guidance cells

Hi @LeilaMemoi. Before we do a final review, approval and merge, there are just a few standard DE Africa notebook checks to tidy up. Could you please have a look at the following:

  • 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)
  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated.

Additionally, the two intertidal elevation notebooks, update the Model tide heights markdown to remove reference to OTPS TPXO8 tidal model. You can use the Coastal_erosion and Mangrove_analysis notebook for reference.

Happy to help if anything is unclear.

Hi @mpho-sadiki, I have made the necessary changes, except for the guidance cells, as I am not entirely sure which ones they refer to. Could you please clarify which cells need updating?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants