diff --git a/ratapi/__init__.py b/ratapi/__init__.py index 98683c7..8f441f4 100644 --- a/ratapi/__init__.py +++ b/ratapi/__init__.py @@ -9,7 +9,7 @@ from ratapi.outputs import BayesResults, Results from ratapi.project import Project from ratapi.run import run -from ratapi.utils import convert, plotting +from ratapi.utils import convert, matlab, plotting with suppress(ImportError): # orsopy is an optional dependency from ratapi.utils import orso as orso @@ -26,4 +26,5 @@ "run", "plotting", "convert", + "matlab", ] diff --git a/ratapi/utils/matlab.py b/ratapi/utils/matlab.py new file mode 100644 index 0000000..9784c4a --- /dev/null +++ b/ratapi/utils/matlab.py @@ -0,0 +1,70 @@ +"""Runs RAT from the MATLAB API.""" + +import os +import tempfile +import warnings +from pathlib import Path + +from ..outputs import Results +from ..project import Project +from ..wrappers import MatlabWrapper + +RUNNER = """function executeRAT() + +cur_dir = pwd; +cd('{rat_path}'); +addPaths; +cd(cur_dir); + +project = jsonToProject('{project}'); +controls = jsonToControls('{control}'); +for i=1:project.customFile.rowCount + addpath(project.customFile.varTable{{i, 5}}); +end +[project, results] = RAT(project, controls); + +projectToJson(project, '{project}'); +resultsToJson(results, '{result}'); +end +""" + + +def run_matlab_directly(project, controls, matlab_rat_path): + """Run User provided MATLAB RAT for the given project and controls inputs. + + Parameters + ---------- + project : RAT.Project + The project model, which defines the physical system under study. + controls : RAT.Controls + The controls model, which defines algorithmic properties. + matlab_rat_path : str + The path to MATLAB RAT folder. + """ + if MatlabWrapper.loader is None: + raise ImportError(MatlabWrapper.loader_error_message) from None + + engine = MatlabWrapper.loader.result() + + with tempfile.TemporaryDirectory() as tmp: + project_file = Path(tmp, "project.json") + control_file = Path(tmp, "controls.json") + result_file = Path(tmp, "results.json") + runner_file = Path(tmp, "executeRAT.m") + + with open(runner_file, "w") as f: + f.write(RUNNER.format(project=project_file, control=control_file, result=result_file, + rat_path=matlab_rat_path)) + + with warnings.catch_warnings(): # Avoid warning about relative paths + warnings.simplefilter("ignore") + project.save(project_file) + controls.save(control_file) + + engine.addpath(tmp, nargout=0) + engine.executeRAT(nargout=0) + engine.rmpath(tmp, nargout=0) + + project = Project.load(project_file) + results = Results.load(result_file) + return project, results