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

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

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

MATLAB Engine API для 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 Prompt

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