MEP12: 갤러리 및 예제 개선 #
상태 번호
진전
1.3에 초기 변경 사항이 추가되었습니다. 갤러리의 전환이 진행 중입니다. 2015년 9월 29일 - 마지막 pylab_exampleswhere pylabis import가 use matplotlib.pyplotand 로 변환되었습니다 numpy.
브랜치 및 풀 리퀘스트 #
#1623, #1924, #2181
PR #2474 는 정리되고 적절한 섹션으로 이동되는 단일 예를 보여줍니다.
초록 #
matplotlib 플롯 갤러리를 재구성하면 갤러리 탐색이 크게 간소화됩니다. 또한 명확성을 위해 예제를 정리하고 단순화해야 합니다.
자세한 설명 #
matplotlib 갤러리는 최근 예제를 섹션으로 분할하도록 설정되었습니다. 해당 PR [ 1 ] 에서 설명한 것처럼 현재 예제 섹션( api, pylab_examples)은 사용자에게별로 유용하지 않습니다. 갤러리의 새 섹션은 사용자가 관련 예제를 찾는 데 도움이 됩니다.
이 섹션은 또한 예제 정리를 안내합니다. 처음에는 모든 현재 예제가 유지되고 현재 디렉토리 아래에 나열됩니다. 시간이 지남에 따라 이러한 예제를 정리하고 새 섹션 중 하나로 이동할 수 있습니다.
이 프로세스를 통해 사용자는 정리가 필요한 예제를 쉽게 식별할 수 있습니다. 즉, api및 pylab_examples
디렉토리에 있는 모든 것.
구현 #
새 갤러리 섹션을 만듭니다. [완료]
예제를 정리하고 새 갤러리 섹션으로 이동합니다(많은 PR 과정과 많은 사용자/개발자의 도움으로). [진행중]
갤러리 섹션 #
섹션 이름 지정은 중요하며 정리 작업을 안내합니다. 현재 섹션은 다음과 같습니다.
선, 막대 및 마커(대략 1D 데이터)
모양 및 컬렉션
통계 플롯
이미지, 등고선 및 필드
원형 및 극좌표 차트: 둥근 것
색깔
텍스트, 레이블 및 주석
진드기와 가시
서브플롯, 축 및 그림
특수 플롯(예: Sankey, 레이더, 토네이도)
쇼케이스(출판 품질을 높이기 위해 조정한 플롯)
도구 상자에 대한 별도의 섹션(이미 있음: 'mplot3d', 'axes_grid', 'units', 'widgets')
이 이름은 확실히 논쟁의 여지가 있습니다. 이러한 섹션이 커지면 재평가하고 필요에 따라 분할해야 합니다.
정리 지침 #
api갤러리의 및 섹션에 있는 현재 예제 pylab_examples는 정리될 때까지 해당 디렉터리에 남아 있습니다. 정리 후에는 위에서 설명한 새 갤러리 섹션 중 하나로 이동됩니다. "정리"에는 다음이 포함되어야 합니다.
sphinx-gallery docstrings : 예제 상단에 다음과 같은 형식의 예제 제목 및 설명:
""" =============================== Colormaps alter your perception =============================== Here I plot the function .. math:: f(x, y) = \sin(x) + \cos(y) with different colormaps. Look at how colormaps alter your perception! """
주석 처리된 코드는 제거해야 합니다.
셔뱅 라인을 제거합니다. 예:
#!/usr/bin/env 파이썬
일관된 가져오기를 사용합니다. 특히:
numpy를 np로 가져오기
matplotlib.pyplot을 plt로 가져오기
이러한 모듈에서 특정 기능을 가져오지 마십시오(예: )
from numpy import sin각 예는 특정 기능에 초점을 맞춰야 합니다(
showcase더 "세련된" 플롯을 표시하는 예는 제외). 해당 기능과 관련 없는 조정은 제거해야 합니다. f7b2217 , e57b5fc 및 1458aa8 참조
의 사용은 pylab갤러리 예제 대신 전용 도움말 페이지에서 시연/논의해야 합니다.
참고: 기존 예제를 이동할 때 해당 예제에 대한 참조를 검색해야 합니다. 예를 들어 API 설명서에서
axes.py이러한 pyplot.py예제를 사용하여 플롯을 생성할 수 있습니다. 선호하는 검색 도구(예: grep, ack, grin , pss )를 사용하여 matplotlib 패키지를 검색합니다. 2dc9a46
및 aa6b410 참조
추가 제안 #
사용된 메서드/객체에 대한 예제와 API 문서 간의 링크(양방향)를 제공합니다. (문제 #2222 )
plt.subplots보다 우선적으로 (후행 "s" 참고)를 사용하십시오plt.subplot.용도를 명확히 하기 위해 예제의 이름을 바꿉니다. 예를 들어 의 가장 기본적인 데모는
imshow이고imshow_demo.py다른 보간 설정을 보여주는 데모는imshow_demo_interpolation.py( notimshow_demo2.py)입니다.새로운 것을 표시하지 않는 예제를 삭제하십시오.
일부 예제는 단위 테스트를 위해 난해한 기능을 실행합니다. 이러한 조정은 갤러리에서
unit패키지의 루트 디렉터리에 있는 디렉터리의 예제로 이동해야 합니다.예제의 의도를 명확히 하기 위해 플롯 제목을 추가합니다. bd2b13c 참조
이전 버전과의 호환성 #
각 Matplotlib 버전의 웹 사이트에 쉽게 액세스할 수 있으므로 이전 예제를 참조하려는 사용자는 여전히 참조할 수 있습니다.