Python에서 MATLAB 함수에 대한 도움말 보기

MATLAB 도움말을 찾는 방법

Python^®에서 모든 MATLAB^® 함수에 대한 지원 문서에 액세스할 수 있습니다. 이러한 도움말 문서에는 각 함수에 대한 입력 인수, 출력 인수, 호출하는 구문에 대한 설명과 예제가 들어 있습니다.

Python용 MATLAB Engine API를 사용하면 MATLAB doc 함수와 help 함수를 사용할 수 있습니다. doc를 사용하면 MATLAB 도움말 브라우저를 열 수 있습니다. help를 사용하면 Python 프롬프트에서 MATLAB 함수에 대한 간략한 설명을 볼 수 있습니다.

Python에서 MATLAB 도움말 브라우저 열기

Python에서 도움말 브라우저를 사용하여 MATLAB 함수 도움말 페이지를 열고 도움말 문서를 검색할 수 있습니다.

예를 들어, MATLAB plot 함수에 대한 도움말 페이지를 표시해 보겠습니다. (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)

Python 프롬프트에서 MATLAB 도움말 표시하기

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 함수에 대한 도움말 링크는 들어 있지 않습니다.