Feature/update documentation
Update the documentation. This includes
- addition of a User Guide
- more examples
- API reference
Other features:
-
relax()
experiment now returns a boolean denoting the relaxation success instead of the sample magnetization - add
verbose={True, False}
option to all numerical experiments.False
will suppress output (except warnings). - add
sample_average()
, callable fromtetrax
namespace