sarkas.processes.Process

class sarkas.processes.Process(input_file=None)

Parent class for sarkas.process.PreProcess, sarkas.process.Simulation, and sarkas.process.PostProcess.

Parameters

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

Variables

• potential (sarkas.potential.base.Potential) – Class handling the interaction between particles.

• integrator (sarkas.time_evolution.integrators.Integrator) – Class handling the integrator.

• particles (sarkas.particles.Particles) – Class handling particles properties.

• parameters (sarkas.core.Parameters) – Class handling simulation’s parameters.

• species (list) – List of sarkas.plasma.Species classes.

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

• timer (sarkas.utilities.timing.SarkasTimer) – Class handling the timing of processes.

• io (sarkas.utilities.io.InputOutput) – Class handling the IO in Sarkas.

Methods

Process.__init__([input_file])
Process.common_parser([filename])	Parse simulation parameters from YAML file.
Process.directory_sizes()	Calculate the size of the dumps directories and print them to logger.
Process.evolve(phase, thermalization, ...)	Evolve the system forward in time.
Process.evolve_loop_threading(phase, ...)	Evolve the system forward in time.
Process.initialization()	Initialize all classes.
Process.instantiate_subclasses_from_dict(...)	Instantiate the process subclasses from a dictionary.
Process.print_initial_state()	Print the initial energies of the system.
Process.setup([read_yaml, input_file, ...])	Setup simulations' subclasses by reading the YAML input file and update them with other_inputs.
Process.setup_from_dict(input_dict)	Setup simulations' subclasses from a nested dictionary.
Process.update_subclasses_from_dict(nested_dict)	Update the subclasses parameters using a dictionary.