Skip to content

Conversation

@LaurenSchenk1
Copy link
Collaborator

Proposed changes

A Wetlands Insight tool interactive app where polygons can be drawn or uploaded to produce a stacked line plot, csv and (optionally) spatial wit outputs.

This app is based on the DE Africa WIT app.

Some questions I have still which you may wish to consider when reviewing:

  1. Is the location of the wit_app tool the best spot? And is it name descriptive enough?
  2. Should I include warning suppressions in the WIT_drill? It is used in the DE Africa app
  3. Is more explanation on dry veg vs non green veg, etc. needed?
  4. Is WOfS accurate in the plot axis or should it be WOs?

Checklist
If this is a notebook, then have you:

  • Checked the structure of the notebook follows our DEA-notebooks template
  • Removed any unused Python packages from Load packages
  • Removed any unused/empty code cells
  • Removed any guidance cells (e.g. General advice)
  • Ensured 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).
  • Included relevant tags in the final notebook cell (refer to the DEA Tags Index, and re-use tags if possible)
  • Tested notebook on the DEA Sandbox
  • Cleared all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated
  • If applicable, update the Notebook currently compatible with line below the notebook title to reflect the environments the notebook is compatible with
  • Check for any spelling mistakes using the DEA Sandbox's built-in spellchecker (double click on markdown cells then right-click on pink highlighted words). For example:

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@erialC-P
Copy link
Collaborator

erialC-P commented Mar 19, 2025

I've just pushed a small commit to this PR with a few grammatical suggestions to the markdown boxes in the notebook. Feel free to accept or revert them as you like.
I think the notebook is awesome!!! Great job on interpreting the DEAfrica version and making it Austral-centric!

For the questions in your PR:

  • I think you've chosen a great demonstrator plot in the bkg section! Perhaps you could add a caption below it interpreting the plot? You could probably put the state name following the location name but if that's a bit too fiddly then don't worry.
  • I think you could adopt some figure naming in the bkg and description cells (eg figure 1, figure 2) and link explicitly to the plots and have a caption for each to tie all your info together.
  • I dont think you need to worry about the warning suppressions (though that might just be because I'm used to them!). We have a pretty high tolerance of suppression warnings in the rest of the repo so these would easily fit in with the rest.
  • I added a teeny tiny bit more explanation to the WIT classes and pointed people to the knowledge hub pages for the input DEA datasets. I think you've pointed to enough other sources that you dont need to go into great detail on the classes. (This is probably a personal preference thing though - but I think you're good!)
  • I updated the WOfS reference to WOs to align with our current vocab and knowledge hub terminology.

Additionally:

  • I think it could be helpful to output the spatial WIT .gif file into the upper /Interactive_apps folder, to avoid confusion with all the .tif files that are generated in /deawetlands_outputs
  • Perhaps when generating the spatial_wit .gif you can update the code to overwrite the existing .tif files to help minimise the risk of filling up a users sandbox storage with multiple animations?
  • There is also a spatial time steps .png generated with the spatial_wit workflow. This could also be output to the /Interactive_apps folder for consistency. Could the figsize also be reduced? I tried to open it in the sandbox and it was huge!
    Check my edits and let me know if you want to add figure captions or not. Otherwise, I'm happy to approve! Amazing work @LaurenSchenk1 and @margaretharrison

@margaretharrison
Copy link
Collaborator

I am so happy with this Lauren!! Happy to chat tomorrow about Claire's feedback and implementing it if you need! I don't think it will take long at all :)

Copy link
Collaborator

@BexDunn BexDunn left a comment

Choose a reason for hiding this comment

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

Looks great Lauren. I made some changes to your licencing and publications section, hope that helps.

Copy link
Collaborator

@erialC-P erialC-P left a comment

Choose a reason for hiding this comment

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

This is a great notebook that is really well put-together. Great job @LaurenSchenk1 and @margaretharrison!!! Very happy to approve 🎉
Feel free to merge once the tests are complete!

@LaurenSchenk1
Copy link
Collaborator Author

Thank you @erialC-P !

@LaurenSchenk1 LaurenSchenk1 merged commit bc86f0a into develop Mar 26, 2025
7 checks passed
@LaurenSchenk1 LaurenSchenk1 deleted the WIT_app_update branch March 26, 2025 22:08
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.

5 participants