Skip to content

Remove notebooks and signpost data analysis repo#1112

Merged
alexdewar merged 3 commits intomainfrom
remove-jupyter-notebooks
Feb 9, 2026
Merged

Remove notebooks and signpost data analysis repo#1112
alexdewar merged 3 commits intomainfrom
remove-jupyter-notebooks

Conversation

@alexdewar
Copy link
Collaborator

Description

Now that the muse2_data_analysis repo is set up, users can go here to find example Jupyter notebooks, so we no longer need them in this repository.

Remove the notebooks and signpost this new repo.

Closes #1099.

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copilot AI review requested due to automatic review settings February 2, 2026 12:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Removes in-repo example Jupyter notebooks and updates the user documentation to direct users to the new muse2_data_analysis repository for output-data processing examples (closes #1099).

Changes:

  • Updated the user guide to link to muse2_data_analysis for example notebooks.
  • Deleted the docs/notebooks/*.ipynb notebooks from this repository.
  • Removed notebook-related Python dependencies from doc-requirements.txt.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/user_guide.md Replaces the in-repo notebooks link with a pointer to the external muse2_data_analysis repo.
docs/notebooks/prices.ipynb Removes the notebook (no longer maintained in this repo).
docs/notebooks/capacity.ipynb Removes the notebook (no longer maintained in this repo).
doc-requirements.txt Drops notebook-only dependencies (pandas/matplotlib/notebook).
.gitignore Removes an exception rule for assets/settings.toml (file no longer present).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Feb 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.52%. Comparing base (ff15327) to head (aa1fd52).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1112   +/-   ##
=======================================
  Coverage   87.52%   87.52%           
=======================================
  Files          55       55           
  Lines        7429     7429           
  Branches     7429     7429           
=======================================
  Hits         6502     6502           
  Misses        630      630           
  Partials      297      297           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alexdewar alexdewar requested a review from Aurashk February 2, 2026 12:23
Copy link
Collaborator

@Aurashk Aurashk left a comment

Choose a reason for hiding this comment

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

seems sensible!

@alexdewar alexdewar merged commit 667da49 into main Feb 9, 2026
8 checks passed
@alexdewar alexdewar deleted the remove-jupyter-notebooks branch February 9, 2026 08:18
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.

Remove Jupyter notebooks and signpost new data analysis repo

2 participants