State¶
The state contains the chain of spin systems (also called images).
To create a new state with containing a single image and run a simple example of a spin dynamics simulation:
or call setup and delete manually:
You can pass an input file specifying your initial system parameters. If you do not pass an input file, the implemented defaults are used.
-
class
spirit.state.
State
(configfile='', quiet=False)¶ Bases:
object
Wrapper Class for a Spirit State.
Can be used as with spirit.state.State() as p_state:
-
__dict__
= mappingproxy({'__module__': 'spirit.state', '__doc__': 'Wrapper Class for a Spirit State.\n\n Can be used as `with spirit.state.State() as p_state:`\n ', '__init__': <function State.__init__>, '__enter__': <function State.__enter__>, '__exit__': <function State.__exit__>, '__dict__': <attribute '__dict__' of 'State' objects>, '__weakref__': <attribute '__weakref__' of 'State' objects>})¶
-
__enter__
()¶
-
__exit__
(exc_type, exc_value, traceback)¶
-
__init__
(configfile='', quiet=False)¶ Initialize self. See help(type(self)) for accurate signature.
-
__module__
= 'spirit.state'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
spirit.state.
date_time
(p_state)¶ Returns a string containing the date-time of the creation of the state.
-
spirit.state.
delete
(p_state)¶
-
spirit.state.
setup
(configfile='', quiet=False)¶
-
spirit.state.
to_config
(p_state, filename, comment='')¶ Write a config (input) file corresponding to the current parameters etc. of the state.