modelon/impact/client/entities.py
def new_experiment_definition(
        self,
        custom_function,
        *,
        compiler_options=None,
        fmi_target="me",
        fmi_version="2.0",
        platform="auto",
        compiler_log_level="warning",
        runtime_options=None,
        solver_options=None,
        simulation_options=None,
        simulation_log_level="WARNING",
    ):
        """
        Returns a new experiment definition using this Model.

        Parameters:

            custom_function --
                The custom function to use for this experiment.

            compiler_options --
                An compilation options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the compiler options.

            fmi_target --
                Compiler target. Possible values are 'me' and 'cs'. Default: 'me'.

            fmi_version --
                The FMI version. Valid options are '1.0' and '2.0'. Default: '2.0'.

            platform --
                Platform for FMU binary.The OS running the Impact server must match the
                environment that runs the compiled FMU. This is necessary as the
                binaries packaged with the FMU are based on the platform generating
                the FMU. For example, if the Impact server is running Linux the binary
                in the downloaded FMU is compiled for Linux. The downloaded FMU can
                then not be simulated on Windows.
                Supported options are:-
                    - 'auto': platform is selected automatically.
                    - "linux64": generate a 32 bit FMU.
                    - "win32": generate a 32 bit FMU.
                    - "win64": generate a 64 bit FMU
                Default: 'auto'.

            compiler_log_level --
                The logging for the compiler. Possible values are "error",
                "warning", "info", "verbose" and "debug". Default: 'warning'.

            runtime_options --
                An runtime options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the runtime options. Default: None.

            solver_options --
                The solver options to use for this experiment. By default the options
                is set to None, which means the default options for the
                custom_function input is used.

            simulation_options --
                The simulation_options to use for this experiment. By default the
                options is set to None, which means the default options for the
                custom_function input is used.

            simulation_log_level --
                Simulation log level for this experiment. Default is 'WARNING'.

        Example::

            model = workspace.get_model("Modelica.Blocks.Examples.PID_Controller")
            dynamic = workspace.get_custom_function('dynamic')
            solver_options = {'atol':1e-8}
            simulation_options = dynamic.get_simulation_options().
            with_values(ncp=500)
            experiment_definition = model.new_experiment_definition(
                dynamic,
                solver_options=solver_options,
                simulation_options=simulation_options
            )
            experiment = workspace.execute(experiment_definition).wait()
        """
        return SimpleModelicaExperimentDefinition(
            model=self,
            custom_function=custom_function,
            compiler_options=compiler_options,
            fmi_target=fmi_target,
            fmi_version=fmi_version,
            platform=platform,
            compiler_log_level=compiler_log_level,
            runtime_options=runtime_options,
            solver_options=solver_options,
            simulation_options=simulation_options,
            simulation_log_level=simulation_log_level,
        )

        Returns a new experiment definition using this Model.

        Parameters:

            custom_function --
                The custom function to use for this experiment.

            compiler_options --
                An compilation options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the compiler options.

            fmi_target --
                Compiler target. Possible values are 'me' and 'cs'. Default: 'me'.

            fmi_version --
                The FMI version. Valid options are '1.0' and '2.0'. Default: '2.0'.

            platform --
                Platform for FMU binary.The OS running the Impact server must match the
                environment that runs the compiled FMU. This is necessary as the
                binaries packaged with the FMU are based on the platform generating
                the FMU. For example, if the Impact server is running Linux the binary
                in the downloaded FMU is compiled for Linux. The downloaded FMU can
                then not be simulated on Windows.
                Supported options are:-
                    - 'auto': platform is selected automatically.
                    - "linux64": generate a 32 bit FMU.
                    - "win32": generate a 32 bit FMU.
                    - "win64": generate a 64 bit FMU
                Default: 'auto'.

            compiler_log_level --
                The logging for the compiler. Possible values are "error",
                "warning", "info", "verbose" and "debug". Default: 'warning'.

            runtime_options --
                An runtime options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the runtime options. Default: None.

            solver_options --
                The solver options to use for this experiment. By default the options
                is set to None, which means the default options for the
                custom_function input is used.

            simulation_options --
                The simulation_options to use for this experiment. By default the
                options is set to None, which means the default options for the
                custom_function input is used.

            simulation_log_level --
                Simulation log level for this experiment. Default is 'WARNING'.

        Example::

            model = workspace.get_model("Modelica.Blocks.Examples.PID_Controller")
            dynamic = workspace.get_custom_function('dynamic')
            solver_options = {'atol':1e-8}
            simulation_options = dynamic.get_simulation_options().
            with_values(ncp=500)
            experiment_definition = model.new_experiment_definition(
                dynamic,
                solver_options=solver_options,
                simulation_options=simulation_options
            )
            experiment = workspace.execute(experiment_definition).wait()
        
Returns a new experiment definition using this Model.
Parameters.

custom_function
The custom function to use for this experiment.

compiler_options
An compilation options class instance of
modelon.impact.client.options.ExecutionOptions or
a dictionary object containing the compiler options.



fmi_version
The FMI version.

platform
Platform for FMU binary.The OS running the Impact server must match the
environment that runs the compiled FMU. This is necessary as the
binaries packaged with the FMU are based on the platform generating
the FMU. For example, if the Impact server is running Linux the binary
in the downloaded FMU is compiled for Linux. The downloaded FMU can
then not be simulated on Windows.
Supported options are:
'auto': platform is selected automatically.
"linux64": generate a 32 bit FMU.
"win32": generate a 32 bit FMU.
"win64": generate a 64 bit FMU
Default: 'auto'.

compiler_log_level
The logging for the compiler.

runtime_options
An runtime options class instance of
modelon.impact.client.options.ExecutionOptions or
a dictionary object containing the runtime options. Default: None.

solver_options
The solver options to use for this experiment. By default the options
is set to None, which means the default options for the
custom_function input is used.

simulation_options
The simulation_options to use for this experiment. By default the
options is set to None, which means the default options for the
custom_function input is used.

simulation_log_level
Simulation log level for this experiment. Default is 'WARNING'.




Returns a new experiment definition using this Model . Parameters . custom_function The custom function to use for this experiment . compiler_options An compilation options class instance of modelon . impact . client . options . ExecutionOptions or a dictionary object containing the compiler options . fmi_version The FMI version . platform Platform for FMU binary . The OS running the Impact server must match the environment that runs the compiled FMU . This is necessary as the binaries packaged with the FMU are based on the platform generating the FMU . For example if the Impact server is running Linux the binary in the downloaded FMU is compiled for Linux . The downloaded FMU can then not be simulated on Windows . Supported options are : ' auto ' : platform is selected automatically . " linux64 " : generate a 32 bit FMU . " win32 " : generate a 32 bit FMU . " win64 " : generate a 64 bit FMU Default : ' auto ' . compiler_log_level The logging for the compiler . runtime_options An runtime options class instance of modelon . impact . client . options . ExecutionOptions or a dictionary object containing the runtime options . Default : None . solver_options The solver options to use for this experiment . By default the options is set to None which means the default options for the custom_function input is used . simulation_options The simulation_options to use for this experiment . By default the options is set to None which means the default options for the custom_function input is used . simulation_log_level Simulation log level for this experiment . Default is ' WARNING ' .
def new_experiment_definition(
        self,
        custom_function,
        *,
        compiler_options=None,
        fmi_target="me",
        fmi_version="2.0",
        platform="auto",
        compiler_log_level="warning",
        runtime_options=None,
        solver_options=None,
        simulation_options=None,
        simulation_log_level="WARNING",
    ):
        return SimpleModelicaExperimentDefinition(
            model=self,
            custom_function=custom_function,
            compiler_options=compiler_options,
            fmi_target=fmi_target,
            fmi_version=fmi_version,
            platform=platform,
            compiler_log_level=compiler_log_level,
            runtime_options=runtime_options,
            solver_options=solver_options,
            simulation_options=simulation_options,
            simulation_log_level=simulation_log_level,
        )
def new_experiment_definition ( self , custom_function , * , compiler_options = None , fmi_target = "me" , fmi_version = "2.0" , platform = "auto" , compiler_log_level = "warning" , runtime_options = None , solver_options = None , simulation_options = None , simulation_log_level = "WARNING" , ) : return SimpleModelicaExperimentDefinition ( model = self , custom_function = custom_function , compiler_options = compiler_options , fmi_target = fmi_target , fmi_version = fmi_version , platform = platform , compiler_log_level = compiler_log_level , runtime_options = runtime_options , solver_options = solver_options , simulation_options = simulation_options , simulation_log_level = simulation_log_level , )
Returns a new experiment definition using this Model.
Returns a new experiment definition using this Model .
"""
        Returns a new experiment definition using this Model.

        Parameters:

            custom_function --
                The custom function to use for this experiment.

            compiler_options --
                An compilation options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the compiler options.

            fmi_target --
                Compiler target. Possible values are 'me' and 'cs'. Default: 'me'.

            fmi_version --
                The FMI version. Valid options are '1.0' and '2.0'. Default: '2.0'.

            platform --
                Platform for FMU binary.The OS running the Impact server must match the
                environment that runs the compiled FMU. This is necessary as the
                binaries packaged with the FMU are based on the platform generating
                the FMU. For example, if the Impact server is running Linux the binary
                in the downloaded FMU is compiled for Linux. The downloaded FMU can
                then not be simulated on Windows.
                Supported options are:-
                    - 'auto': platform is selected automatically.
                    - "linux64": generate a 32 bit FMU.
                    - "win32": generate a 32 bit FMU.
                    - "win64": generate a 64 bit FMU
                Default: 'auto'.

            compiler_log_level --
                The logging for the compiler. Possible values are "error",
                "warning", "info", "verbose" and "debug". Default: 'warning'.

            runtime_options --
                An runtime options class instance of
                modelon.impact.client.options.ExecutionOptions or
                a dictionary object containing the runtime options. Default: None.

            solver_options --
                The solver options to use for this experiment. By default the options
                is set to None, which means the default options for the
                custom_function input is used.

            simulation_options --
                The simulation_options to use for this experiment. By default the
                options is set to None, which means the default options for the
                custom_function input is used.

            simulation_log_level --
                Simulation log level for this experiment. Default is 'WARNING'.

        Example::

            model = workspace.get_model("Modelica.Blocks.Examples.PID_Controller")
            dynamic = workspace.get_custom_function('dynamic')
            solver_options = {'atol':1e-8}
            simulation_options = dynamic.get_simulation_options().
            with_values(ncp=500)
            experiment_definition = model.new_experiment_definition(
                dynamic,
                solver_options=solver_options,
                simulation_options=simulation_options
            )
            experiment = workspace.execute(experiment_definition).wait()
        """
self
custom_function
compiler_options
fmi_target
fmi_version
platform
compiler_log_level
runtime_options
solver_options
simulation_options
simulation_log_level