Examples

Everything related to constructing examples that motivate and teach how to use our package. This includes:

• coming up with new interesting physical systems
• cleaning up the existing ones

and likely more.

pymf/__init__.py

@@ -6,20 +6,36 @@ except ImportError:
     __version__ = "unknown"
     __version_tuple__ = (0, 0, "unknown", "unknown")
 
-from .mf import construct_density_matrix
+from .mf import (
+    construct_density_matrix,
+    construct_density_matrix_kgrid,
+    meanfield,
+    fermi_on_grid,
+)
 from .solvers import solver
 from .model import Model
+from .observables import expectation_value
 from .tb.tb import add_tb, scale_tb
-from .tb.utils import generate_guess
+from .tb.transforms import kham_to_tb, tb_to_khamvector, ifftn_to_tb
+from .tb.utils import generate_guess, generate_vectors, calculate_fermi_energy
 
 
 __all__ = [
     "solver",
     "Model",
+    "expectation_value",
     "add_tb",
     "scale_tb",
     "generate_guess",
+    "generate_vectors",
+    "calculate_fermi_energy",
     "construct_density_matrix",
+    "construct_density_matrix_kgrid",
+    "meanfield",
+    "fermi_on_grid",
+    "kham_to_tb",
+    "tb_to_khamvector",
+    "ifftn_to_tb",
     "__version__",
     "__version_tuple__",
 ]