init_simulation

• full name: tenpy.simulations.simulation.init_simulation

• parent module: tenpy.simulations.simulation

• type: function

tenpy.simulations.simulation.init_simulation(simulation_class='GroundStateSearch', simulation_class_kwargs=None, **simulation_params)

Run the simulation with a simulation class.

If you need to run the simulation, you can use a with statement for proper context management:

with sim:
    results = sim.run()

Parameters

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

Returns

results – The results of the Simulation, i.e., what tenpy.simulations.simulation.Simulation.run() returned.

Return type

dict