x3cflux.create_simulator_from_fml

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

Overloaded function.

1. create_simulator_from_fml(fml_file_path: str, config_name: str = ‘default’, sim_method: str = ‘auto’) -> x3cflux::SimulatorBase

   Creates simulator from FluxML file.

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

   param str fml_file_path:

   Absolute or relative path to FluxML file

   param str config_name:

   Name of the measurement configuration to simulate. Default: “default”

   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_fml(fml_file_path: str, config_names: collections.abc.Sequence[str], sim_method: str = ‘auto’) -> x3cflux::SimulatorBase

   Creates multi experiment simulator from FluxML file.

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

   param str fml_file_path:

   Absolute or relative path to FluxML file

   param List[str] config_names:

   Names of the measurement configurations 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