diff --git a/docs/source/index.md b/docs/source/index.md index 0e4ce2daeba51113feab2967939c3692e77ecfb2..73e51a77fb7c24e9f0b4c7dee891d68adde55a05 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -47,7 +47,7 @@ Finding a mean-field solution is a 4-step process: import pymf model = pymf.Model(h_0, h_int, filling=filling) -mf_sol = pymf.solver(model, guess) +mf_sol = pymf.solver(model, guess, nk=nk) h_full = pymf.add_tb(h_0, mf_sol) ``` @@ -56,12 +56,15 @@ h_full = pymf.add_tb(h_0, mf_sol) Here is why you should use pymf: * Minimal - It contains the minimum of what you need to solve mean-field equations. + + Pymf contains the minimum of what you need to solve mean-field equations. * Simple + The workflow is simple and straightforward. * Time-effective + As pymf uses tight-binding dictionaries as input and returns, you can calculate the mean-field corrections on a coarse grid, but use the full Hamiltonian on a fine grid for observables afterward.