store_step

store_step

sorts.simulation.store_step(store, iterable=False)

Simulation step storing decorator

Parameters

• store (str/list) – The name/list names of the properties to save the method return as (set using setattr). Can be multiple levels, e.g. object.subobject.a_property. The order of the names correspond to the order of method returned variables.

• iterable (bool) – Determines if the return of the method is an iteration or not. If its an iteration, it splits the return values into different lists based on the number of variables.