magnopy.Convention.summary#

method

Convention.summary(return_as_string=False)[source]#

Gives human-readable summary of the convention.

Deprecated since version 0.4.0: Will be removed in May of 2026. Use print(convention) or str(convention) instead.

Parameters:

return_as_stringbool, default False: Whether to print or return a str. If True, then returns a str. If False, then prints it.

Examples

>>> from magnopy import Convention
>>> conv_1 = Convention(True, True, c21=1, c22=-0.5)
>>> conv_1.summary()
"custom" convention where
  * Bonds are counted multiple times in the sum;
  * Spin vectors are normalized to 1;
  * Undefined c1 factor;
  * c21 = 1.0;
  * c22 = -0.5;
  * Undefined c31 factor;
  * Undefined c32 factor;
  * Undefined c33 factor;
  * Undefined c41 factor;
  * Undefined c42 factor;
  * Undefined c43 factor;
  * Undefined c44 factor;
  * Undefined c45 factor.