Add page on Register creation and Rydberg-Atom interactions + Retire old tutorials #790

HGSilveri · 2025-01-15T11:53:41Z

~~Deletes tutorials we don't want to keep~~ Removes old tutorials from the docs and into tutorials/retired
Changes the TOC closer to what we want
Adds the "Register and Rydberg-Atom Interactions" page to the Fundamentals

review-notebook-app · 2025-01-15T11:53:46Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

awennersteen · 2025-01-15T12:28:25Z

Would you consider keeping the rydberg crystals one as at least I've referenced that in various places to externals?

Another suggestion would be to have a place to store retired tutorials (a different github repo e.g.)

(I haven't really followed the docs revamp so ignoring this is already considered it OK)

HGSilveri · 2025-01-15T13:19:14Z

Would you consider keeping the rydberg crystals one as at least I've referenced that in various places to externals?

Another suggestion would be to have a place to store retired tutorials (a different github repo e.g.)

(I haven't really followed the docs revamp so ignoring this is already considered it OK)

Thanks for pointing this out! If we keep it in the tutorials\ folder but out of the docs, would that be ok?

awennersteen · 2025-01-15T13:23:46Z

Yeah that's OK for me :)

HGSilveri · 2025-01-15T13:26:22Z

Yeah that's OK for me :)

Is it important that the URL stays the same? I was thinking I could maybe move these to a tutorials/retired/ subdir to signal they are no longer maintained.

awennersteen · 2025-01-15T14:10:42Z

I was thinking I could maybe move these to a tutorials/retired/ subdir to signal they are no longer maintained.

I think that's OK. Any other workaround is just very cumbersome

docs/source/register.ipynb

HGSilveri · 2025-01-23T10:38:01Z

@a-corni @ferrulli1pasqal Can you take a look at last changes I added here so we can merge this?

docs/source/programming.md

docs/source/conventions.md

* Setting up Markdown support * Convert Conventions page to markdown * Attempt to use auto-generated labels * Introduce section about hardware * Redirect api core * Add pulse section * Direct to API core instead of pulse * Add some elements about pulser.devices * Create getting started notebook (#776) * Create initial notebook * Add temporary links * Add programming section * Fix installation of mermaid * Fix figure caption * Taking into account review comments * Fix doc * Try mermaid with mkdown * Address review comments * Fix doc * Add picture * Addressing review comments * Add figure, vector on the bloch sphere, complement to the Device * Make introduction * Add programming.md in ref * Add label * delete ref * Fix programming * Create tutorial Excitation to rydberg state * Address review comments * Add AFM state prep * Fix programming.md * Address review * Delete docs, add hbar * Fix picture * Fixing programming * Transfer cell as raw * Fix sequence * 4-hand fixing * Final fixes * Add paragraph along br * Address review comment * Fix referencing * Fix the notebook * Add note about neighbouring atoms * Creating notebook for hardware section, reorganising specs display in Device, adding the presence of EOM in Channel display * Fix typing * Fix build * fix typing * Fix flake8 * Fix reference * Fix ref * Fix figure * Re-reading myself * Fix rendering * Fix rendering * Fix build * Available devices * Address review comments * Add page on Register creation and Rydberg-Atom interactions + Retire old tutorials (#790) * Deleting tutorials * Adding the Register user manual * Adding links * Undo deleting the tutorials for the repo * Retire tutorials instead * Do the same for the tutorials deleted in #776 * Address review comments * Fix notebook reference * Clear all outputs * Adressing review comments * Address review comments * Add section in conventions on indexed operator notation * Small fixes * Improve formula rendering * Shuffle the description of the arguments * Trying new raw cells * Add remove-input tag to last cell * Fix typing * Add no-index * Delete no-members * Dlete no-index * Reintroduce :noindex: * Improve description of device * Try fixing link to * Fix device and channel description, try hidding the input * Try fixing build * Fix tags to hide_input * Change device descr to "Args", stop trying to mask input * Add link to backend * Move Attributes to Args in Device * Add mention to API doc * Apply some Pasqal branding to the HTML documentation * Use Pulser logo :) * Remove obsolete file * Add seealso sections in programming * Deleting the-channels * Tag The-Channels * referencing to html instead * Going for hardware.ipynb * Add page on Pulses and Waveforms (#793) * Add tutorial on Pulses and Waveforms * Address review comments * Reference fundamentals pages in Programming * Remove signatures from autosummary * API Reference Rework (#722) * Improving autodoc typehints generation * Improving the Register API doc * WIP: New API reference for pulser-core * Try to pass RTD build * Adding `pulser-simulation` module to the API ref * Adding pulser_pasqal ref * Import sorting * Fix UTs * Fix links in new pages * Adding the Sequence page (#802) * WIP * Getting links to work at top-level pulser API * Writing Sequence page * Address review comments * Fix typo * Merge remote-tracking branch 'origin' into docs-v2 * Modifications to the TOC tree (#806) * Reorder pages in Extended Usage * Retire tutorial on AFM state preparation * Slight modifications to the Backend page * Move and update the XY Hamiltonian page * Fix broken links * Fix typo Co-authored-by: Antoine Cornillot <61453516+a-corni@users.noreply.github.com> --------- Co-authored-by: Antoine Cornillot <61453516+a-corni@users.noreply.github.com> * Create introduction to Extended Usage (#800) * Add tanh function to ParamObj (#798) * added tanh function to paramobj * Update tests/test_parametrized.py Co-authored-by: Henrique Silvério <29920212+HGSilveri@users.noreply.github.com> * fixed test --------- Co-authored-by: Henrique Silvério <29920212+HGSilveri@users.noreply.github.com> * Create extended usage doc * Fix doc * Post-rereading correction * Allow switch_device to work when Channel uses BaseEOM (#804) * Allow switch_device to work when Channel uses BaseEOM * Bump to v1.2.2 * Bump to v1.3dev2 * Addressing the confusion btw Weighted Analog and XY * Add more specific links, descr of digital qc * Address review comments * Testing with : * Try with #- * Fix reference * Fix links to sections * Fix hamiltonian * Fix apidoc ref --------- Co-authored-by: Vytautas Abramavicius <145791635+vytautas-a@users.noreply.github.com> Co-authored-by: Henrique Silvério <29920212+HGSilveri@users.noreply.github.com> Co-authored-by: HGSilveri <henrique.silverio@tecnico.ulisboa.pt> --------- Co-authored-by: a_corni <antoine.cornillot@pasqal.com> Co-authored-by: Antoine Cornillot <61453516+a-corni@users.noreply.github.com> Co-authored-by: Benjamin Becquet <benjamin.becquet@pasqal.com> Co-authored-by: Benjamin Becquet <benjamin.becquet@gmail.com> Co-authored-by: Vytautas Abramavicius <145791635+vytautas-a@users.noreply.github.com>

HGSilveri added 3 commits January 15, 2025 12:49

Deleting tutorials

f49edb5

Adding the Register user manual

37dc1ac

Adding links

bb361da

HGSilveri requested a review from a-corni January 15, 2025 11:53

HGSilveri self-assigned this Jan 15, 2025

Undo deleting the tutorials for the repo

9424d42

HGSilveri added 2 commits January 15, 2025 16:37

Retire tutorials instead

be45e99

Do the same for the tutorials deleted in #776

6b5966f

HGSilveri changed the title ~~Add page on Register creation and Rydberg-Atom interactions~~ Add page on Register creation and Rydberg-Atom interactions + Retire old tutorials Jan 15, 2025

a-corni reviewed Jan 15, 2025

View reviewed changes

HGSilveri added 3 commits January 16, 2025 10:31

Address review comments

315a65f

Fix notebook reference

22b8995

Clear all outputs

6cb6b52

HGSilveri force-pushed the hs/register-doc branch from 158371c to 6cb6b52 Compare January 16, 2025 10:30