Nov 4 – 8, 2019
Adelaide Convention Centre
Australia/Adelaide timezone

User documentation and training at Belle II

Nov 7, 2019, 11:00 AM
Riverbank R4 (Adelaide Convention Centre)

Riverbank R4

Adelaide Convention Centre

Oral Track 8 – Collaboration, Education, Training and Outreach Track 8 – Collaboration, Education, Training and Outreach


Ilya Komarov


Belle II is a rapidly growing collaboration with members from
113 institutes spread around the globe. The software development team of
the experiment, as well as the software users, are very much
decentralised. Together with the active development of the software,
such decentralisation makes the adoption of the latest software
releases by users an essential, but quite challenging task.
To ensure an up-to-date state of the documentation, we adopted the
policy of in-code documentation and configured a website that allows to
get the documentation for specific release. To prevent tutorials becoming
outdated, they are covered by unit-tests. For the user support, we use
a question and answer service that not only allows to reduce repetition
of the same questions, but also turned out to be a place for discussions
among the experts. A prototype of a meta search engine for the different
sources of documentation has been developed. For training of the new
users, we organize centralised StarterKit workshops attached to the
collaboration meetings. The materials of the workshop are available
through a jupyterhub server and used in local training sessions.

Consider for promotion No

Primary authors

Dr Francesco Tenchini (DESY) Ilya Komarov Martin Ritter (LMU / Cluster Universe) Sam Cunliffe (DESY) Thomas Kuhr (Ludwig Maximilians Universitat (DE))

Presentation materials