SciFi Software review

Planning

• Assign reviewers √ [Blake, Albert, Gloria and Marco]
• Make documentation available. Deadline: end of Nov 2017.
• Open meeting with reviewers on January 24, 2018. See the agenda.
• Written report from reviewers. Deadline on February 21, 2018.
• Second (closed) meeting with reviewers.
• Review report and reply can be found on EDMS.

Scope

• Software organisation and personpower:
  • JIRA tasks
  • milestones.
• Geometry, conditions and detector elements.
  • Code in main repos: DDDB, SIMCOND, LHCb/Det/FTDet and LHCb/Kernel/FTChannelID.
  • Documentation: LHCb-INT-2016-044 and LHCb-INT-2017-027 (v3.0 for review).
• Fibre light yield maps (i.e. attenuation maps).
  • Code in SciFi repos: SciFiSimG4 and LightYieldMapTools.
  • Documentation: LHCb-INT-2016-015, draft v1.0 for review most up-to-date version: LHCb-INT-2016-015, draft v2.1 on CDS
• Digitisation.
  • Code in main repo: Boole/FT/FTDigitisation and LHCb/Event/FTEvent.
  • Documentation: Digitisation note v1.0 for review
• Clustering and raw buffer:
  • Code in main repos: LHCb/FT/FTDAQ, LHCb/Event/FTEvent and Boole/FT/FTDigitisation.
  • Documentation: Clustering note v1.0 for review .
• Test beam framework.
  • Code in Kepler and SciFi repo: Kepler.
  • Documentation: Test beam framework note v1.0 for review

Aim of review

The reviewers are expected to give feedback (mainly but not exclusively based on their expertise) on

• the organisation of the software,
• the documentation,
• the coding style and standards,
• the long-term maintainability of the code (readability),
• the correctness of the simulation (is the code simulating what it is supposed to simulate),
• ...

Guidelines

• Specific comments on the code via JIRA and GitLab are very much encouraged and welcome, but are not considered as part of this review.
• Detailed comments on the documentation are very encouraged and welcome, but are not considered as part of the review.
• The report from the reviewers should be written concise (e.g bullet points). Details can be discussed during the meeting.
• The report should aim for a global review of the state of the software.
• We welcome all recommendations for improvements in the code, improvements in the organisation, etc.

-- JeroenVanTilburg - 2017-11-16