Feat/update spin readmes

[TorbjornRasmussenQM]

Pull Request

Description

Updates to readmes for QD/LD quam.

Type of Change

• 🐛 Bug fix (non-breaking change which fixes an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 📚 Documentation update
• 🔧 Refactoring (no functional changes)
• ✅ Test addition/update
• 🎨 Code style/formatting update

Related Issues

Checklist

Code Quality

• My code follows the project's style guidelines
• I have run pre-commit hooks and all checks pass (pre-commit run --all-files)
• My commits follow the Conventional Commits format
• I have performed a self-review of my code
• My changes generate no new warnings

Testing

• I have added tests that prove my fix/feature works
• All new and existing tests pass locally (pytest)
• I have tested my changes with the example scripts (if applicable)

Documentation

• I have updated the documentation (if needed)
• I have added docstrings to new functions/classes
• I have updated the CHANGELOG.md (if applicable)
• I have checked my code and corrected any misspellings

Breaking Changes

Does this PR introduce breaking changes?

Testing Details

Screenshots/Examples

Additional Context

Reviewer Notes

[stephanlphilips]

Hi all,

Hereby my comments,

the overall flow of the docs is good, it builds up chronologically, the way a user would set up an experiment, and the final code block is handy as something people can copy-paste.

A few common topics missing from the docs:

• IQ channels : setup, single-qubit gate pulses, parallel execution, chirps, NCO configuration, phase corrections. windowing functions.
• Readout : a structured way to set up measurements (single and parallel), plus guides for RF and DC readout.
• Baseband : no explanations yet on using custom pulse shapes.
• A section on practical limits : minimum segment length, common causes of gaps, limitations that arise when inputs are QUA variables (e.g. timing or duration constraints), ns-to-cycles conversion (including non-multiple-of-4 handling).

A few more thoughts:

• The introduction could briefly explain why this package was written, with a short motivating example, before diving into the individual classes. A feature list of what the package itself provides (sequence generation, current-voltage tracking, DC compensation, sticky support, virtual gate layers, etc.) would also help orient new readers.
• For the virtual gate layer functionality, a concrete physics example might be handy for the reader, e.g. converting virtual plungers into detunings, handy for exchange-only qubits.