Skip to content

Conversation

@frayle-ons
Copy link
Contributor

resolves #128

✨ Summary

These changes add more detailed instructions for each DEMO notebook, on how to set up the virtual environment with UV or PIP and install from wheel reversion release with the appropriate optional dependency installs for each notebook. It also adds some additional setup requirements around DEMO datasets, ipykernel and how to access those

📜 Changes Introduced

  • chore: updated demo notebooks with new installation section and instructions
  • chore: updated readme with installation section now containing wheel release install path
  • chore: updated DEMO readme with context about installation instructions for each notebook

✅ Checklist

  • Code passes linting with Ruff
  • Security checks pass using Bandit
  • API and Unit tests are written and pass using pytest
  • Terraform files (if applicable) follow best practices and have been validated (terraform fmt & terraform validate)
  • DocStrings follow Google-style and are added as per Pylint recommendations
  • Documentation has been updated if needed

🔍 How to Test

Trying out the demo notebooks and following the corresponding instructions, possibly in a fresh folder environment with just the single ipynb file downloaded would be good a good way to determine if the instructions are sufficient for user to follow through and acquire any additional data that is needed

@frayle-ons frayle-ons linked an issue Feb 10, 2026 that may be closed by this pull request
@frayle-ons frayle-ons changed the title Chore: Updated demos and readmes for wheel release chore: Updated demos and readmes for wheel release Feb 10, 2026
@github-actions github-actions bot added the chore label Feb 10, 2026
@Tom-Owen-ONS Tom-Owen-ONS self-requested a review February 10, 2026 15:34
@frayle-ons
Copy link
Contributor Author

Key consideration @Tom-Owen-ONS for your review:

currently there's a lot of duplication in that roughly the same install instructions section is in every notebook. Whereas we could put one set of install instructions in the /DEMO/readme.md so that the notebooks have less content.

However, if we keep it the way it is currently proposed then the notebooks are much more self-contained, i.e. the user doesn't need to download the whole DEMO folder, and each notebook has complete instructions on how it should be run.

Copy link
Collaborator

@Tom-Owen-ONS Tom-Owen-ONS left a comment

Choose a reason for hiding this comment

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

Key consideration @Tom-Owen-ONS for your review:

currently there's a lot of duplication in that roughly the same install instructions section is in every notebook. Whereas we could put one set of install instructions in the /DEMO/readme.md so that the notebooks have less content.

However, if we keep it the way it is currently proposed then the notebooks are much more self-contained, i.e. the user doesn't need to download the whole DEMO folder, and each notebook has complete instructions on how it should be run.

I think for notebooks I prefer having the installation instructions inside as they are: I kind of see them as self-contained and data scientists/testers who use them might treat them more like that as well.

Tom-Owen-ONS
Tom-Owen-ONS previously approved these changes Feb 12, 2026
Copy link
Collaborator

@Tom-Owen-ONS Tom-Owen-ONS left a comment

Choose a reason for hiding this comment

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

Notebooks all run on a cloud workstation for me and the updated docs make sense (just the little note on the README that is up to you to be honest). Haven't tried on an on-net due to issues we discussed.

Thanks for this!

Copy link
Collaborator

@Tom-Owen-ONS Tom-Owen-ONS 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!

@frayle-ons frayle-ons merged commit 55b9566 into main Feb 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Updating package installation info for .whl release

2 participants