Skip to content

Update to DEA Notebooks Template #1386

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

Jump to bottom
Draft
wants to merge 16 commits into
base: develop
Choose a base branch
from
Draft

Update to DEA Notebooks Template #1386

wants to merge 16 commits into from

Conversation

cbur24
Copy link
Collaborator

@cbur24 cbur24 commented Aug 28, 2025 •
edited
Loading

Proposed changes

Proposing a new DEA-Notebooks template to support the switch to loading DEA data with odc-stac. Includes a refresh of the overall aesthetic, as well as updates to the cells at the top of the notebook including replacing the Connect to the Datacube with Connect to DEA's Explorer STAC API and Configure AWS access. I'm uncertain of the best approach to configuring AWS access, whether it should be configure_rio or configure_s3_access by default.

I've also removed the Getting Started cell as I thought it wasn't really adding anything helpful.

This draft PR also includes the set-up for CodeSpaces to work (clicking on the badge in the notebook header will lauch an instance). The .devcontainer and requirements.txt folder/file does not need to survive this PR, but including it here for now so we can test and decide on the way forward.

Closes issues (optional)

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 Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@cbur24 cbur24 changed the title Template Update to DEA Notebooks Template Aug 28, 2025
@jennaguffogg
Copy link
Collaborator

My personal opinion is the dev container should stay, as it gives an easy way for a user to use their local vs code to spin this up if they don't want to use codespaces.

@cbur24
Copy link
Collaborator Author

cbur24 commented Aug 29, 2025

@jennaguffogg ultimately the .devcontainer may stay to support CodeSpaces option for users - I only meant in terms of this PR we may want to consider it through a seperate PR. Whether we support CodeSpaces or not is a somewhat seperate issue from the notebooks template.

jennaguffogg
jennaguffogg reviewed Aug 29, 2025
View reviewed changes
DEA_notebooks_template.ipynb Outdated
"- <b>Personal computer:</b> This notebook loads DEA data using <code>odc-stac</code>. Data streams across the internet, so can be run locally after installing the required <a href=\"https://pypi.org/project/dea-tools/\" style=\"color:inherit;\">DEA Tools</a> Python package, e.g. <code>pip install dea-tools[notebooks]</code>.\n",
"\n",
"\n",
"- <b>Run this notebook online:</b> Click on the badge below to launch a GitHub Codespaces instance to run the notebook from your browser. See this [wiki page]() for more information.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Has the wiki page link been left blank for now on purpose, or should this link to a docs page for codespaces?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Just a placeholder for now

jennaguffogg
jennaguffogg reviewed Aug 29, 2025
View reviewed changes
DEA_notebooks_template.ipynb Outdated
"If you would like to report an issue with this notebook, you can file one on [GitHub](https://github.com/GeoscienceAustralia/dea-notebooks).\n",
"\n",
"**Last modified:** September 2021\n",
"**Last modified:** September 2025\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

If there's an 'updated' date at the top of the notebook, should this be the same? Or, if they serve the same purpose, do both need to be in the notebook template?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've removed it.

jennaguffogg
jennaguffogg reviewed Aug 29, 2025
View reviewed changes
DEA_notebooks_template.ipynb Outdated
],
"outputs": [],
"source": [
"print(datacube.__version__)"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Because this notebook doesn't import datacube, this throws an error. Does this need to be included in the template?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Deleted!

@cbur24
Copy link
Collaborator Author

cbur24 commented Sep 2, 2025 •
edited
Loading

Added a cell at the bottom that prints the date a noteboook was last tested, as something distinct from the date the notebook was created or updated. Worthwhile?

@robbibt
Additional notebook template updates (#1387)
b1bd13b 
* Additional notebook updates

* Remove table layout, use horizontal logo

* Fix formatting

* Minor formatting

* Update header
@robbibt
Fix missing content
293af5e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jennaguffogg jennaguffogg jennaguffogg left review comments

@robbibt robbibt Awaiting requested review from robbibt robbibt will be requested when the pull request is marked ready for review robbibt is a code owner

@BexDunn BexDunn Awaiting requested review from BexDunn BexDunn will be requested when the pull request is marked ready for review BexDunn is a code owner

@erialC-P erialC-P Awaiting requested review from erialC-P erialC-P will be requested when the pull request is marked ready for review erialC-P is a code owner

@Kooie-cate Kooie-cate Awaiting requested review from Kooie-cate Kooie-cate will be requested when the pull request is marked ready for review Kooie-cate is a code owner

@geoscience-aman geoscience-aman Awaiting requested review from geoscience-aman geoscience-aman will be requested when the pull request is marked ready for review geoscience-aman is a code owner

@JM-GA JM-GA Awaiting requested review from JM-GA JM-GA will be requested when the pull request is marked ready for review JM-GA is a code owner

@margaretharrison margaretharrison Awaiting requested review from margaretharrison margaretharrison will be requested when the pull request is marked ready for review margaretharrison is a code owner

@vnewey vnewey Awaiting requested review from vnewey vnewey will be requested when the pull request is marked ready for review vnewey is a code owner

@Ariana-B Ariana-B Awaiting requested review from Ariana-B Ariana-B will be requested when the pull request is marked ready for review Ariana-B is a code owner

@supermarkion supermarkion Awaiting requested review from supermarkion supermarkion will be requested when the pull request is marked ready for review supermarkion is a code owner

@GL-S GL-S Awaiting requested review from GL-S GL-S will be requested when the pull request is marked ready for review GL-S is a code owner

@LaurenSchenk1 LaurenSchenk1 Awaiting requested review from LaurenSchenk1 LaurenSchenk1 will be requested when the pull request is marked ready for review LaurenSchenk1 is a code owner

@colourmeamused colourmeamused Awaiting requested review from colourmeamused colourmeamused will be requested when the pull request is marked ready for review colourmeamused is a code owner

@caitlinadams caitlinadams Awaiting requested review from caitlinadams caitlinadams will be requested when the pull request is marked ready for review caitlinadams is a code owner

@arcisad arcisad Awaiting requested review from arcisad arcisad will be requested when the pull request is marked ready for review arcisad is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@cbur24 @jennaguffogg @robbibt