Documentation

[jjren]

I think it is time to gradually improve the documentation of Renormalizer and make it more accessible to the community.
Let's begin with the module-level docs first!

[liwt31]

While this is certainly a gradual process, the mlist module is facing a major update (#100) and I recommend postponing the documentation of this part.

[liwt31]

For a more friendly user interface to the community, some of the interfaces require unification. To name a few:

• In MatrixProduct, bond_dims and pbond_list are two relevant properties that have quite different names. pbond_list is also used in MolList2.
• In MatrixProduct, the same as above for check_left_canonical and is_left_canon.
• In MatrixProduct, set_threshold and property setter threshold are duplicate.
• Mps.full_wfn and Mpo.full_operator are better renamed to to_dense.
• In Phonon, n_phys_dim in __init__ and the propertypbond nlevels.
• Return value is sometimes Quantity and sometimes float. I suggest for all return value use float while for input value Quantity is preferred.
• ...

Also, some interfaces seem obsolete and maybe they should be removed:

• Mpo.from_mp
• MatrixProduct.build_none_qn
• MatrixProduct.clear_qn
• ....