Получение справки для функций MATLAB из Python

Как найти справку MATLAB

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

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

Открытие браузера документации MATLAB из Python

Из Python можно использовать Браузер документации, чтобы открыть страницы с описанием функции MATLAB и искать документацию.

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

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

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

Примечание

Кликните по заголовку в качестве примера, или на стрелке рядом с заголовком, если вы не видите примеров на странице с описанием MATLAB. Примеры могут быть свернуты или расширены в странице.

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

eng.doc(nargout=0)

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

Также можно искать документацию с функцией docsearch. Например, ищите страницы то упоминание plot.

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

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

Чтобы отобразить текст справки для функции в подсказке Python, вызовите функцию help MATLAB. Например, отобразите текст справки для 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, которые могут быть упомянуты.

Для просмотра документации необходимо авторизоваться на сайте