From 2819ac624d645f66a70097320473724f7ec073c1 Mon Sep 17 00:00:00 2001 From: Parth Garg Date: Thu, 5 Mar 2026 17:06:28 +0530 Subject: [PATCH] fix incorrect docstring in HamIsing and HamRG classes --- moha/hamiltonians.py | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/moha/hamiltonians.py b/moha/hamiltonians.py index a91ef91..8504ad7 100644 --- a/moha/hamiltonians.py +++ b/moha/hamiltonians.py @@ -388,7 +388,17 @@ def __init__( class HamHeisenberg(HamiltonianAPI): - r"""XXZ Heisenberg Hamiltonian.""" + r"""XXZ Heisenberg Hamiltonian.\r +\r + Models spin-1/2 particles on a lattice with the Hamiltonian:\r +\r + .. math::\r + \hat{H}_{XXZ} = \sum_p (\mu_p^Z - J_{pp}^{\mathrm{eq}}) S_p^Z\r + + \sum_{pq} J_{pq}^{\mathrm{ax}} S_p^Z S_q^Z\r + + \sum_{pq} J_{pq}^{\mathrm{eq}} (S_p^+ S_q^- + S_p^- S_q^+)\r +\r + `HamIsing` and `HamRG` are special cases of this class.\r + """ def __init__(self, mu: np.ndarray, @@ -608,7 +618,7 @@ def __init__(self, J_ax: np.ndarray, connectivity: np.ndarray = None ): - r"""Initialize XXZ Heisenberg Hamiltonian. + r"""Initialize Ising Hamiltonian. Parameters ---------- @@ -651,7 +661,7 @@ def __init__(self, J_eq: np.ndarray, connectivity: np.ndarray = None ): - r"""Initialize XXZ Heisenberg Hamiltonian. + r"""Initialize Richardson-Gaudin Hamiltonian. Parameters ----------