Skip to content

Improves documentation for Devices - #1110

Merged
singhmankrit merged 24 commits into
developfrom
docs-1100
Sep 15, 2026
Merged

singhmankrit merged 24 commits into
developfrom
docs-1100

Conversation

@singhmankrit

@singhmankrit singhmankrit commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Addresses comments from #1100

  • For DMM specific cases, adds parameters ("Total Bottom Detuning", "Minimum Absolute Detuning") and removes others ("Maximum \Omega", "Minimum average amplitude", "Addressing")
  • Rounds floats to 4 significant digits.
  • Units added to Interaction Coefficients and formula.
  • Fixed a small typo in DMM tutorial.
  • Adds additional parameters: Optimal layout fraction, Supports EOM mode, rise time
  • Fixes a previous miss in operators example docstring

@singhmankrit singhmankrit linked an issue Sep 9, 2026 that may be closed by this pull request
@singhmankrit
singhmankrit marked this pull request as ready for review September 10, 2026 08:25
@singhmankrit singhmankrit changed the title Improve documentation for DMM Improves documentation for Devices Sep 10, 2026

@HGSilveri HGSilveri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looking good, I only have a couple nits and one question for you: given your current understanding of Pulser, would you add anything to what we are already showing in these device specs?

Comment thread pulser-core/pulser/devices/_device_datacls.py Outdated
Comment thread pulser-core/pulser/devices/_device_datacls.py Outdated
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@singhmankrit

Copy link
Copy Markdown
Collaborator Author

Looking good, I only have a couple nits and one question for you: given your current understanding of Pulser, would you add anything to what we are already showing in these device specs?

I have added the following:

  1. Optimal layout filling fraction when applicable
  2. Channel Rise time: although this is never None, it is 0 for DigitalAnalogDevice and I'm not sure if that should be displayed in the docs.
  3. EOM Enabled and if yes, EOM Rise time.

Both 2 and 3 are not applicable to DMMs of course, so they are not shown there.

@HGSilveri HGSilveri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looking good!

Comment thread pulser-core/pulser/devices/_device_datacls.py Outdated
Comment thread pulser-core/pulser/devices/_device_datacls.py Outdated
@singhmankrit
singhmankrit enabled auto-merge (squash) September 14, 2026 14:59

@HGSilveri HGSilveri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, great job!

@singhmankrit
singhmankrit merged commit f34375a into develop Sep 15, 2026
14 checks passed
@singhmankrit
singhmankrit deleted the docs-1100 branch September 15, 2026 08:23
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.

Fix and improve displayed device specs in the docs

2 participants