Документация

Поиск справки MATLAB

В Python ® можно получить доступ к документации по всем функциям ^MATLAB ®. Эта документация содержит примеры и описывает входные аргументы, выходные аргументы и синтаксис вызова для каждой функции.

API-интерфейс MATLAB Engine для Python позволяет использовать MATLAB. doc и help функции. Использовать doc для открытия браузера справки MATLAB. Использовать help для получения краткого описания функции MATLAB в подсказке Python.

Открыть справочный браузер MATLAB из Python

В Python можно использовать браузер справки для открытия справочных страниц функций MATLAB и поиска документации.

Например, отображение справочной страницы для MATLAB plot функция. (С) doc не возвращает выходные аргументы, необходимо задать nargout=0. )

import matlab.engine
eng = matlab.engine.start_matlab()
eng.doc("plot",nargout=0)

Справочная страница содержит описание функции, примеры и ссылки на связанную документацию.

При звонке eng.doc без позиционных аргументов открывает обозреватель справки. (Необходимо задать аргумент ключевого слова nargout=0).

eng.doc(nargout=0)

Чтобы выполнить поиск в документации MATLAB, введите выражение в поле поиска в верхней части любой страницы браузера справки. Обозреватель возвращает список результатов поиска, выделяя слова, соответствующие выражению.

Кроме того, можно выполнить поиск в документации с помощью docsearch функция. Например, поиск страниц с упоминанием plot.

eng.docsearch("plot",nargout=0)

Отображение справки MATLAB по запросу Python

Для отображения текста справки по функции в подсказке Python вызовите MATLAB help функция. Например, отобразить текст справки для erf.

import matlab.engine
eng = matlab.engine.start_matlab()
eng.help("erf",nargout=0)

 ERF Error function.
    Y = ERF(X) is the error function for each element of X.  X must be
    real. The error function is defined as:
 
      erf(x) = 2/sqrt(pi) * integral from 0 to x of exp(-t^2) dt.
 
    See also ERFC, ERFCX, ERFINV, ERFCINV.

    Other functions named erf:
       codistributed/erf
       gpuArray/erf
       sym/erf

    Reference page in Help browser
       doc erf

Выходные данные содержат текст справки, но не содержат ссылок для справки по другим функциям MATLAB, которые могут быть упомянуты.