x3cflux.create_simulator_from_data

class x3cflux.create_simulator_from_data(*args, **kwargs)

Overloaded function.

1. create_simulator_from_data(network_data: x3cflux.lib.core.NetworkData, configuration: x3cflux.lib.core.MeasurementConfiguration, sim_method: str = ‘auto’) -> x3cflux::SimulatorBase

   Creates simulator from FluxML data objects.

   Automatically reduces the network by performing backtracking of the simulation state variable required for simulating the measurements.

   param x3cflux.NetworkData network_data:

   Structural network data and atom transitions

   param x3cflux.MeasurementConfiguration configuration:

   Measurement configuration object to simulate

   param str sim_method:

   Simulation state variable (Cumomer, EMU) to be used. Valid options are: “cumomer”, “emu”, “auto”. Automatic variable selection will select the state variable type that results in the lowest number of initial state variables.

   return:

   simulator object

2. create_simulator_from_data(network_data: x3cflux.lib.core.NetworkData, configurations: collections.abc.Sequence[x3cflux.lib.core.MeasurementConfiguration], sim_method: str = ‘auto’) -> x3cflux::SimulatorBase

   Creates multi experiment simulator from FluxML data objects.

   Automatically reduces the network by performing backtracking of the simulation state variable required for simulating the measurements.

   param x3cflux.NetworkData network_data:

   Structural network data and atom transitions

   param List[x3cflux.MeasurementConfiguration] configurations:

   Measurement configuration object to simulate

   param str sim_method:

   Simulation state variable (Cumomer, EMU) to be used. Valid options are: “cumomer”, “emu”, “auto”. Automatic variable selection will select the state variable type that results in the lowest number of initial state variables.

   return:

   simulator object