이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- CERN-HSF
- 기술 문서 작성자:
- LuckInTheRain
- 프로젝트 이름:
- ROOT 문서 확장 및 개선
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
이 프로젝트의 목표는 전 세계 고에너지 물리학 커뮤니티에서 사용하는 데이터 분석 및 데이터 프레젠테이션용 기본 소프트웨어 시스템인 ROOT의 문서화를 개선하는 것입니다.
프로젝트에 제공할 수 있는 기술 작가 기술 외에도 ROOT(6 및 7)에 익숙하며 프로젝트에 필요한 다른 구성요소(예:
- C++
- Python
- Git/GitHub
- 웹사이트 구성 도구 (html, 마크다운, Jekyll)
ROOT 문서에서 다음 세 가지 주요 부분을 확인할 수 있습니다.
- 웹사이트 https://root.cern
- C++ 클래스 참조 가이드(https://root.cern/doc/master/)
- 포럼 https://root-forum.cern.ch
ROOT 문서 (새로운 'ROOT 매뉴얼')는 다음과 같은 영역에서 개선 및 보완이 필요한 것으로 보입니다.
- 특히 입문 챕터는 물리학자가 아닌 사람도 더 쉽게 접근하고 이해할 수 있어야 합니다.
- ROOT의 일반적인 기능을 설명하는 튜토리얼이 더 많이 개발될 예정입니다.
- 일부 새로운 주제와 개발사항은 자세한 설명과 예시와 함께 포함되어야 합니다.
그중에는 다음이 포함됩니다.
- Python 바인딩
- 수학 라이브러리
- 고급 그래픽 도구 (TRatioPLot, THStack)에 관한 설명서
- 새로운 데이터 마이닝 분석 도구 (RDataFrame 및 RNtuple)
- 새로운 키 데이터 형식 (RDataFrame 및 RNtuple)에는 자세한 기술 사양과 튜토리얼이 필요합니다.
ROOT 포럼에 게시된 질문과 같은 사용자의 중요한 질문에 대한 답변은 문서에 포함되어야 합니다. 이를 위해서는 가장 자주 묻는 질문을 세부적으로 분석한 후 이를 새로운 'ROOT 매뉴얼' 또는 참조 가이드의 새로운 튜토리얼에 포함된 문서로 변환하는 종합 기간이 필요합니다.
ROOT 7에서 제공하는 기능을 보여주는 튜토리얼입니다.
- 새로운 ROOT 7 히스토그램
- 새로운 ROOT 7 그래픽
예상 일정 (5개월):
- 1단계: 작업 정의 및 ROOT 문서화 및 튜토리얼 범위: 2주
- 2단계: ROOT 포럼에서 중요한 사용자 질문 수집 및 분석: 2주
- 3단계: ROOT 문서 작성: 8주
- 4단계: 튜토리얼 개발: 8주
마지막으로 작년에 장기적인 Google Season of Docs 프로젝트로 ROOT 문서에 이미 기여한 바 있습니다. 설명서의 새로운 구조를 정의했습니다. 올해 제안은 ROOT에서 여전히 누락된 다른 문서화 측면의 완성에 기여할 것입니다.