asr.setup.magnetize

Summary

This is the documentation for asr.setup.magnetize-recipe. This recipe is comprised of a single instruction, namely:

Run this recipe through the CLI interface

$ asr run asr.setup.magnetize

or as a python module

$ python -m asr.setup.magnetize

Detailed description

Generate magnetic atomic structures.

Steps

asr.setup.magnetize

asr.setup.magnetize.main(atoms, state='nm')[source]

Set up atomic magnetic moments.

Parameters
  • atoms (ase.atoms.Atoms) –

  • state (str) –

Return type

ase.atoms.Atoms