run_simulation¶
full name: tenpy.simulations.simulation.run_simulation
parent module:
tenpy.simulations.simulation
type: function
-
tenpy.simulations.simulation.
run_simulation
(simulation_class_name='GroundStateSearch', simulation_class_kwargs=None, **simulation_params)[source]¶ Run the simulation with a simulation class.
- Parameters
simulation_class_name (str) – The name of a (sub)class of
Simulation
to be used for running the simulaiton.simulation_class_kwargs (dict | None) – A dictionary of keyword-arguments to be used for the initializing the simulation.
**simulation_params – Further keyword arguments as documented in the corresponding simulation class, see :cfg:config`Simulation`.
- Returns
The results from running the simulation, i.e., what
tenpy.simulations.Simulation.run()
returned.- Return type
results