Add README in example directory

j-otsuki · Mar 1, 2018 · 03c3564 · 03c3564
1 parent 16aaac2
commit 03c3564
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,38 @@
+Example scripts
+---------------
+
+### 2band.atom.py
+
+2-orbital atom with the Hubbard-Kanamori interactions
+
+Representative model parameters:
+
+    num_orb: Number of orbitals (=2)
+    U: Coulomb interaction
+    J: Hund coupling
+    mu: chemical potential
+
+
+### slater.py
+
+A single atom with a Slater-type rotationally invariant interactions
+
+Representative model parameters:
+
+    L: angular momentum
+    U: Coulomb interaction
+    J: Hund coupling
+    ls_coupling: LS coupling
+    mu: chemical potential
+
+### anderson.py
+
+Single orbital Anderson model
+
+Not yet ported to ``pomerol2triqs1.4``
+
+### 2band.py
+
+2-orbital impurity Anderson model (bath: 1 site * 2 orbitals)
+
+Not yet ported to ``pomerol2triqs1.4``