Skip to content

Refresh the documentation website with figures, rebuilt examples, and cool animations - #23

Merged
Gauthameshwar merged 34 commits into
mainfrom
better-docs
Oct 4, 2026
Merged

Gauthameshwar merged 34 commits into
mainfrom
better-docs

Conversation

@Gauthameshwar

Copy link
Copy Markdown
Owner

Summary

Figures, structure, and consistency

  • Rewrite the theory path so tensor networks lead into process tensors, and replace the diagram placeholders with TikZ figures for vectorisation, MPS/MPO vocabulary, channels, process-tensor anatomy, and contractions.
  • Those figures follow the documentation theme: each diagram has a light and a dark SVG, and the page shows the one that matches the active theme.
  • Split the process-tensor tutorials into construction and instruments, and shorten the unitary and dissipative TEBD/TDVP tutorials.
  • Tighten the examples around one stated observable, the executable run versus the companion figure, and named-tuple diagnostics. This covers the dissipative spin, driven Bose–Hubbard, laser-driven, two-time, Ramsey, noisy-circuit, thermal, and central-spin pages.
  • Drop the boundary-driven XXZ and closed-system TEBD/TDVP example pages. Point installation at the current release versus main.

Scripts rebuilt on current main

  • Rebase onto the ACE and chronological-bond fixes. :zipup is gone. Central spin, e tester, and Ramsey use explicit :zipup_cpp. The thermal example stays on :canonzip.
  • Bump the process-tensor caches to format 2 so cores built before that constructor change are not reused.
  • Regenerate the Dense and ACE figures: single-mode and multimode spin baths, two-time correlations, central spin, thermal spin-boson, the noisy-circuit tester, and Ramsey.
  • Raise the Ramsey bond cap to 512 so the record probabilities stay normalised. The central-spin lower panel is the error against the exact finite-bath formula.
  • Shorten the companion scripts and drop the tester coherence panel. julia --project=. -t auto is the run command in the script headers.

Cool animations in homepage and README

  • Add three Manim clips: ACE compression of bath modes into a process tensor, an instrument tape that fills empty slots with identity, and one process tensor contracted either to an open reduced state or to a closed scalar.
  • Each clip has a light and a dark GIF, plus a static poster. The homepage plays the GIF for the active theme and shows the poster when the browser requests reduced motion.
  • The same clips are on the README.

Test plan

  • Confirm CI passes

  • Confirm the documentation build completes.

  • docs: add new Ramsey POVM example

  • feat: add thermal_mode for bath Gibbs states

  • docs: use thermal_mode in thermal bath examples

  • docs: update landing page, install notes, and Liouville/PT examples

  • docs: better landing page

  • docs: split process-tensor tutorials into construction and instruments

  • docs: rewrite tensor-network theory as a path to process tensors

  • docs: polished liouville space theory

  • docs: more precise statements in pt theory

  • chore: remove boundary-driven spin and tebd/tdvp examples

  • docs: shorten unitary and dissipative TEBD/TDVP tutorials

  • docs: concise pt-mpo construction in example

  • add: support to do + in tester sequences

  • docs: detailed explanation of theory vs results

  • docs: more concise example in rabi oscillations

  • docs: reduce the length of content

  • docs: better figure for noisy qubit tester

  • docs: better placement of the model equations

  • docs: improve ramsey povm discussion

  • docs: tighten example physics and match executable runs

  • scripts: shorten ACE companion scripts and drop the tester coherence panel

  • docs: pin ACE compression and invalidate process-tensor caches

  • test: capture the empty-Hamiltonian warning with test_logs

  • docs: regenerate process-tensor figures on the corrected constructors

  • docs: replace theory diagram placeholders with TikZ figures

  • cool feat: switch theory figures with the documentation theme

  • docs: minor corrections in indices and instruments

  • manim: animate ACE compression of bath modes into a process tensor

  • manim: animate an instrument tape filling empty slots with identity

  • manim: animate contracting one process tensor to a state or a scalar

  • docs: play the three homepage clips in the active documentation theme

  • manim: safer theme-specific gif rendering

  • fix: bad figures of povm and histogram fixed

  • add cool gifs to README

Gauthameshwar and others added 30 commits October 3, 2026 14:00
Construct or replace a bath mode's Liouville initial state from the local Hamiltonian at temperature T, including T = 0 ground states and T = Inf mixed states.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace hand-rolled Gibbs mixtures in Literate examples and companion scripts with thermal_mode, and document the new constructor on the API page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Rebuild the first PT tutorial around a truncated spin–boson model, add a
follow-on instruments walkthrough, and retire the hand-written sequences page.
Rebuild the page around contractions, MPS/MPO bond dimension, and temporal
networks so it leads into the process-tensor tutorials instead of a generic TN survey.
Renumber the tutorial path so construction and instruments come before
unitary and dissipative dynamics, shorten those titles, and remove the
boundary-driven XXZ and closed-system TFIM example pages.
Keep one small model per page, named-tuple diagnostics, and a lighter
Liouville comparison instead of large dense-ED comparison harnesses.
Rewrite the dissipative, driven, laser, and two-time examples around a
stated observable, the page parameters versus the figure run, and named-tuple
diagnostics instead of @printf summaries. Replace takeaway lists with
concrete “try changing” checks, correct companion-script paths, and fix a
few formula slips (central-spin period, thermal J(ω) weights).
…panel

Keep the physical workflow and cache keys visible, and match the noisy-circuit
figure to the two quantities the example page now discusses.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace removed :zipup with explicit :zipup_cpp, keep the thermal example on
:canonzip, and bump cached process tensors to format 2 so cores built before
the chronological-bond fix cannot be reused. Script headers now use -t auto.

Co-authored-by: Cursor <cursoragent@cursor.com>
The suite silences warnings with NullLogger, so test_warn cannot see the
thermal_mode empty-H warning after the rebase.

Co-authored-by: Cursor <cursoragent@cursor.com>
Rebuild the Dense and ACE example figures after the chronological-bond fix.
Raise the Ramsey bond cap to 512 so the :zipup_cpp records stay normalized,
and plot the central-spin error against the exact finite-N formula.

Co-authored-by: Cursor <cursoragent@cursor.com>
Draw vectorisation, tensor-network vocabulary, and the process-tensor network in the theory pages, and reuse two of those figures in the construction and instrument tutorials.
Serve a light and a dark SVG for each diagram, and show the one that matches Documenter's active theme.
Show two environment modes over three time steps joined and compressed,
right to left, into a three-core process tensor.

Co-authored-by: Cursor <cursoragent@cursor.com>
Snap a preparation, a custom map, and an open output onto a three-step
tape, and fill the unspecified slot with an identity.

Co-authored-by: Cursor <cursoragent@cursor.com>
Contract the same three-core process twice: leave the final leg open as a
reduced state, or close it as a scalar.

Co-authored-by: Cursor <cursoragent@cursor.com>
Gauthameshwar and others added 4 commits October 4, 2026 16:41
Show the ACE, instrument, and contraction GIFs on the landing page, with a
static poster when motion is reduced, and ignore Manim draft renders.

Co-authored-by: Cursor <cursoragent@cursor.com>
Copilot AI balanced review requested due to automatic review settings October 4, 2026 14:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codecov

codecov Bot commented Oct 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Gauthameshwar
Gauthameshwar merged commit 6da8b4c into main Oct 4, 2026
12 checks passed
@Gauthameshwar
Gauthameshwar deleted the better-docs branch October 4, 2026 14:29
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