Skip to content

docs(notebooks): port compute qmd notebook fixes - #528

Merged
marcorudolphflex merged 1 commit into
pre/2.12from
marco/port-compute-qmd-edits-pre212
Jun 29, 2026
Merged

docs(notebooks): port compute qmd notebook fixes#528
marcorudolphflex merged 1 commit into
pre/2.12from
marco/port-compute-qmd-edits-pre212

Conversation

@marcorudolphflex

@marcorudolphflex marcorudolphflex commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Port the compute-side Autograd12LightExtractor.qmd history filename fix back into the source notebook: misc/qe_light_coupler_autograd.pkl -> misc/qe_light_coupler.pkl.
  • Port the compute-side ChargeSolver.qmd Palankovski & Quay carrier lifetime update back into the source notebook.
  • Add spelling dictionary entries for the transferred ChargeSolver API terms.

Why

These edits were made directly in compute qmd files after the Quarto migration, but they were not present in tidy3d-notebooks on develop or pre/2.12. Keeping them only in generated qmd files makes future notebook-to-qmd syncs regress those docs.

The related compute changes were:

  • flexcompute/compute#5392 by Dario: Autograd12LightExtractor.qmd history filename fix.
  • flexcompute/compute#5322 by Marc: ChargeSolver.qmd Palankovski & Quay carrier lifetime docs/code update.

The Autograd23FabricationAwareInvdes.qmd change from compute was whitespace-only generated qmd cleanup, so there is no source-notebook change to port.

Rerun result on ChargeSolver

image

Validation

  • python3 -m json.tool Autograd12LightExtractor.ipynb ChargeSolver.ipynb custom_dictionary.json
  • uvx ruff==0.14.1 format --check --diff Autograd12LightExtractor.ipynb ChargeSolver.ipynb
  • uv run --no-project python scripts/validate_notebook_metadata.py Autograd12LightExtractor.ipynb ChargeSolver.ipynb
  • uv run --no-project ./spellcheck.py Autograd12LightExtractor.ipynb ChargeSolver.ipynb
  • python3 misc/check_misc_references.py
  • uv run --no-project python scripts/sync_metadata_tags.py --check
  • git diff --check origin/pre/2.12..HEAD

Note: spellcheck prints existing invalid-metadata messages from unrelated reference notebooks while building its dictionary, but exits successfully for the changed notebook set.


Note

Low Risk
Documentation-only path string in a notebook; no runtime, auth, or API behavior changes.

Overview
Ports a compute-side Quarto doc fix back into the source notebook by renaming the optimization history file from misc/qe_light_coupler_autograd.pkl to misc/qe_light_coupler.pkl.

save_history / load_history still use the same history_fname variable—only the path string changes so future notebook→qmd syncs match the published docs and bundled misc asset name.

Reviewed by Cursor Bugbot for commit 763b79c. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Spell check passed successfully for 2 notebook(s).
Generated by GitHub Action run: https://github.com/flexcompute/tidy3d-notebooks/actions/runs/28088936087

@marcorudolphflex
marcorudolphflex marked this pull request as ready for review June 24, 2026 08:25
@marcorudolphflex
marcorudolphflex force-pushed the marco/port-compute-qmd-edits-pre212 branch from 4607173 to 763b79c Compare June 24, 2026 09:29
@marcorudolphflex
marcorudolphflex merged commit 5e70485 into pre/2.12 Jun 29, 2026
2 checks passed
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.

1 participant