Merge pull request #1538 from qiboteam/Heisenberg

Add general `Heisenberg` Hamiltonian and `XXX` model
qiboteam · Dec 10, 2024 · 1afd96d · 1afd96d
2 parents 9e00ebd + 707a106
commit 1afd96d
Show file tree

Hide file tree

Showing 4 changed files with 312 additions and 101 deletions.
diff --git a/doc/source/api-reference/qibo.rst b/doc/source/api-reference/qibo.rst
@@ -1267,13 +1267,6 @@ In addition to the abstract Hamiltonian models, Qibo provides the following
 pre-coded Hamiltonians:
 
 
-Heisenberg XXZ
-^^^^^^^^^^^^^^
-
-.. autoclass:: qibo.hamiltonians.XXZ
-    :members:
-    :member-order: bysource
-
 Non-interacting Pauli-X
 ^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -1326,6 +1319,30 @@ Max Cut
     This is useful for systems that contain many qubits for which constructing
     the full matrix is intractable.
 
+
+Heisenberg model
+^^^^^^^^^^^^^^^^
+
+.. autoclass:: qibo.hamiltonians.Heisenberg
+    :members:
+    :member-order: bysource
+
+
+Heisenberg XXX
+^^^^^^^^^^^^^^
+
+.. autoclass:: qibo.hamiltonians.XXX
+    :members:
+    :member-order: bysource
+
+
+Heisenberg XXZ
+^^^^^^^^^^^^^^
+
+.. autoclass:: qibo.hamiltonians.XXZ
+    :members:
+    :member-order: bysource
+
 _______________________
 
 

diff --git a/src/qibo/hamiltonians/__init__.py b/src/qibo/hamiltonians/__init__.py
@@ -1,2 +1,6 @@
-from qibo.hamiltonians.hamiltonians import *
-from qibo.hamiltonians.models import TFIM, XXZ, MaxCut, X, Y, Z
+from qibo.hamiltonians.hamiltonians import (
+    Hamiltonian,
+    SymbolicHamiltonian,
+    TrotterHamiltonian,
+)
+from qibo.hamiltonians.models import TFIM, XXX, XXZ, Heisenberg, MaxCut, X, Y, Z