sarkas.processes.Simulation#

class sarkas.processes.Simulation(input_file=None)[source]#

Sarkas simulation wrapper. This class manages the entire simulation and its small moving parts.

Parameters

input_file (str) – Path to the YAML input file.

Methods

Simulation.__init__([input_file])

Simulation.check_restart(phase)

Check if the simulation is a restart.

Simulation.common_parser([filename])

Parse simulation parameters from YAML file.

Simulation.directory_sizes()

Calculate the size of the dumps directories and print them to logger.

Simulation.equilibrate()

Run the time integrator with the thermostat to evolve the system to its thermodynamics equilibrium state.

Simulation.evolve(phase, thermalization, ...)

Evolve the system forward in time.

Simulation.evolve_loop_threading(phase, ...)

Evolve the system forward in time.

Simulation.initialization()

Initialize all classes.

Simulation.instantiate_subclasses_from_dict(...)

Instantiate the process subclasses from a dictionary.

Simulation.magnetize()

Simulation.print_initial_state()

Print the initial energies of the system.

Simulation.produce()

Simulation.run()

Run the simulation.

Simulation.setup([read_yaml, input_file, ...])

Setup simulations' subclasses by reading the YAML input file and update them with other_inputs.

Simulation.setup_from_dict(input_dict)

Setup simulations' subclasses from a nested dictionary.

Simulation.update_subclasses_from_dict(...)

Update the subclasses parameters using a dictionary.