Matlab can be executed through command-line instructions, which allows executing complete Matlab scripts. These scripts can, for example, be generated dynamically within VIKTOR. See the Matlab documentation for more info on running Matlab from the command-line.
VIKTOR's Matlab integration requires a Generic worker.
from viktor.external.generic import GenericAnalysis
# Generate the input file(s)
files = [
# Run the analysis and obtain the output file
generic_analysis = GenericAnalysis(files=files, executable_key="matlab", output_filenames=["output.txt"])
output_file = generic_analysis.get_output_file("output.txt")
executable_key in the example above refers to the "matlab" command. This command should also be
specified in the configuration file on the server, located in the same directory as the worker:
maxParallelProcesses: 1 # must be one, please do not change
mock_GenericAnalysis decorator for easier testing of
GenericAnalysis.execute needs to be mocked within
the context of (automated) testing.
viktor.testing module provides the
decorator that facilitate mocking of workers:
from viktor import File
from viktor.testing import mock_GenericAnalysis
from app.my_entity_type.controller import MyEntityTypeController
'result.xml': File.from_path('test_file.xml'), # <name>: <File>
For the decorator's input parameters the following holds:
- If a Sequence type is provided, the next entry is returned for each corresponding method call. When a call is performed on a depleted iterable, an Exception is raised.
- If a single object is provided, the object is returned each time the corresponding method is called (endlessly).
- If None is provided (default), a default File/BytesIO object (with empty content) is returned each time the corresponding method is called (endlessly).