CERN-HSF projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:
CERN-HSF
Teknik yazar:
LuckInTheRain
Projenin adı:
ROOT belgelerini genişletme ve iyileştirme
Proje süresi:
Uzun süreli (5 ay)

Proje açıklaması

Bu proje, dünya çapında yüksek enerjili fizik topluluğu tarafından kullanılan veri analizi ve verilerin sunumu için ana yazılım sistemi olan ROOT ile ilgili belgeleri iyileştirmeyi amaçlamaktadır.

Proje için sağlayabileceğim teknik yazarlık becerilerinin yanı sıra ROOT (6 ve 7) hakkında da bilgim var ve projenin gerektirdiği diğer bileşenler hakkında bilgi sahibiyim. Örneğin:

  • C++
  • Python
  • Git/GitHub
  • Web sitesi oluşturma araçları (html, markdown, Jekyll)

ROOT belgelerinde üç ana unsura karar veriyorum:

  • https://root.cern web sitesini ziyaret edin.
  • C++ sınıfı referans kılavuzu https://root.cern/doc/master/,
  • https://root-forum.cern.ch forumu

Bence ROOT dokümanlarının (yeni "ROOT kılavuzu") aşağıdaki alanlarda iyileştirilmesi ve desteklenmesi gerekiyor:

  • Konu, özellikle giriş bölümleri olmak üzere, fizik uzmanı olmayan kişiler için daha erişilebilir ve anlaşılır olmalıdır.
  • ROOT'un genel işlevselliğini açıklayan daha fazla eğitici hazırlanacaktır.
  • Bazı yeni konular ve geliştirmeler, ayrıntılı açıklama ve örneklerle birlikte eklenecektir. Bunlardan bazılarını listeleyebilirim:
    • Python bağlaması
    • Matematiksel kitaplıklar
    • Üst düzey grafik araçları (TRatioPLot, THStack) için manuel açıklama
    • Yeni veri madenciliği analiz araçları (RDataFrame ve RNtuple)
  • Yeni anahtar veri biçimleri (RDataFrame ve RNtuple) için ayrıntılı teknik spesifikasyonlar ve eğiticiler gerekiyor.

  • Kullanıcılardan gelen önemli sorulara verilen yanıtların (ROOT forumunda yayınlananlar gibi) dokümanlara eklenmesi gerekir. Bunun için, en sık sorulan soruların incelikli bir şekilde analiz edilmesini ve ardından bunları yeni "ROOT Kılavuzu"nda veya Referans Kılavuzu'nda yer alan yeni eğiticilerde çeşitli belgelere dönüştürmek için bir sentez dönemi gerekir.

  • ROOT 7 tarafından sağlanan işlevleri gösteren eğiticiler.

    • Yeni ROOT 7 histogramları
    • Yeni ROOT 7 grafikleri

Tahmini zaman planlaması (5 ay):

  • 1. Aşama: ROOT belgeleri ve eğitimleri için görevlerin ve kapsamın tanımı: 2 hafta.
  • 2. Aşama: ROOT forumunda önemli kullanıcıların sorularını toplama ve analiz etme: 2 hafta
  • 3. Aşama: ROOT belgelerini yazma: 8 hafta.
  • 4. Aşama: Eğitim geliştirme: 8 hafta

Son olarak, geçen yıl Google Dokümanlar'da uzun süreli bir Google Sezonu projesiyle ROOT belgelerine zaten katkıda bulunduğumu eklemeliyim. Kılavuzun yeni yapısını tanımladım. Bu yılki teklif, ROOT alanında hâlâ eksik olan diğer belgeleme unsurlarının tamamlanmasına katkıda bulunacak.