• full name: tenpy.run_simulation

  • parent module: tenpy

  • type: function

tenpy.run_simulation(simulation_class='GroundStateSearch', simulation_class_kwargs=None, *, simulation_class_name=<object object>, **simulation_params)[source]

Run the simulation with a simulation class.

Deprecated since version 0.9.0: The simulation_class_name argument has been renamed to just simulation_class.

  • simulation_class (str) – The name of a (sub)class of Simulation to be used for running the simulation.

  • 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 Simulation.


results – The results of the Simulation, i.e., what returned.

Return type