grogupy.io.save_UppASD

grogupy.io.save_UppASD(builder: Builder, folder: None | str = None, fast_compare: bool = False, spin_moment: Literal['total', 'local'] = 'total', comments: bool = True) → None | list[str]

Writes the UppASD input files to the given folder.

The created input files are the posfile, momfile and jfile. Furthermore a the inpsd.dat file is created with some basic information.

Parameters

builderBuilder

Main simulation object containing all the data

folderUnion[None, str], optional

The output folder where the files are created or if it is set to None, then a list of strings are returned with the input data, by default, None

fast_compare: bool, optional

When determining the magnetic entity index a fast comparison can be used where only the tags are checked, by default False

spin_moment: Literal[“total”, “local”], optional

It switches the used spin moment in the output, can be ‘total’ for the whole atom or atoms involved in the magnetic entity or ‘local’ if we only use the part of the mulliken projections that are exactly on the magnetic entity, which may be just a subshell of the atom, by default ‘total’

comments: bool, optional

Wether to add comments in the beginning of the inpsd.dat, by default True

Returns

out: Union[None, str]

A list of the input file or None, in which case it is written to the path