pythtb.TBModel.info#
- TBModel.info(show=True, short=False)[source]#
Print or return a textual report describing the model.
- Parameters:
- showbool, optional
If True, print to stdout and return
None. If False, return the string without printing. Default is True.Added in version 2.0.0.
- shortbool, optional
If True, include only a lattice summary. If False, also include site-energies and hopping information. Default is False.
Added in version 2.0.0.
- Returns:
- str or None
The report string if
showis False; otherwiseNone.
Notes
The report includes lattice vectors, orbital positions, spin information, site energies, hopping terms, and hopping distances (when available).
Examples
>>> text = tb.info(show=False, short=True) >>> isinstance(text, str) True