AFBuilder.build_afm#

AFBuilder.build_afm(supercell=None, model_file='afm.cif', _progress_callback=None)[source]#

Build AFm structure.

Parameters:
supercellSequence[int], optional

Supercell dimensions [a, b, c].

model_filestr, default=’afm.cif’

CIF file for the AFm structure.

Returns:
AtomicSystem

The built AFm structure.

Examples

>>> builder = AFBuilder(ws_ratio=8.0)
>>> system = builder.build_afm(supercell=[3,1,1])