Skip to content

Add tutorial notebooks for waveform analysis workflows (Issue #42)#43

Merged
RoxGamba merged 6 commits intomainfrom
copilot/prepare-pages-using-examples
Nov 22, 2025
Merged

Add tutorial notebooks for waveform analysis workflows (Issue #42)#43
RoxGamba merged 6 commits intomainfrom
copilot/prepare-pages-using-examples

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 30, 2025

Converts example scripts into documented tutorial notebooks under docs/source/tutorials/, providing pedagogical content for catalog access, waveform matching, optimization, and scattering angle calculations.

New Tutorials

  • catalog_downloads.ipynb - Unified interface for downloading from SXS, RIT, GRA, ICCUB catalogs
  • nr_eob_mismatch.ipynb - Frequency-domain mismatch calculation between NR and EOB waveforms across mass ranges
  • optimizing_initial_conditions.ipynb - Dual annealing optimization of EOB E₀/pₚₕ₀ parameters to minimize NR mismatches
  • iccub_waveform_integration.ipynb - Fixed Frequency Integration (FFI) method for Ψ₄ → strain conversion
  • scattering_angles.ipynb - Hyperbolic encounter trajectory analysis and scattering angle extraction

Documentation Updates

  • Added tutorials to docs/source/index.md toctree
  • Replaced deprecated jupyter_execute_notebooks with nb_execution_mode in Sphinx config

Each tutorial includes executable examples, parameter explanations, and visualization of results. Original scripts in examples/ retained for reference.

Original prompt

Please start working on issue #42. Use the already existing code under examples as a reference to prepare the pages


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits October 30, 2025 17:50
Co-authored-by: RoxGamba <72128273+RoxGamba@users.noreply.github.com>
Co-authored-by: RoxGamba <72128273+RoxGamba@users.noreply.github.com>
Copilot AI changed the title [WIP] Prepare pages using existing code as reference Add tutorial notebooks for waveform analysis workflows (Issue #42) Oct 30, 2025
Copilot AI requested a review from RoxGamba October 30, 2025 17:58
Copy link
Copy Markdown
Owner

@RoxGamba RoxGamba left a comment

Choose a reason for hiding this comment

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

Some of the notebooks do not currently work out of the box; this is due to the changes the library underwent since the initial notebooks/scripts were added.

@RoxGamba RoxGamba marked this pull request as ready for review November 22, 2025 22:39
@RoxGamba RoxGamba merged commit e37348d into main Nov 22, 2025
1 check passed
@RoxGamba RoxGamba deleted the copilot/prepare-pages-using-examples branch November 22, 2025 22:41
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.

2 participants