From 8156d781b5b845b54b632d640e7478b869f9f9f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADt=20Ku=C4=8Dera?= Date: Sun, 20 Jun 2021 00:34:23 +0200 Subject: [PATCH] Add instructions for analysis code contributors --- FirstAnalysis/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/FirstAnalysis/README.md b/FirstAnalysis/README.md index 9f94a8f4..a426ca78 100644 --- a/FirstAnalysis/README.md +++ b/FirstAnalysis/README.md @@ -1,4 +1,4 @@ -# O2 First analysis utilities +# O2 first analysis utilities ## Introduction The main purpose of this folder is to provide analysis tools to perform analysis of O2 analysis task outputs. @@ -6,6 +6,17 @@ It includes for the moment a set of QA plotting macros to inspect `AnalysisResul It also includes some preliminary functionalities for performing efficiency corrections of HF analyses. It is currently being used also for performing Run5 analysis. +## Instructions for contributors + +* Write documentation comments to make the code easy to understand. +* Every file should contain the following details at the top: + * what the code does, + * which input it needs (e.g. output of which O2 workflow), + * how to run it (in case simply executing the script is not enough), + * names of authors, contributors, maintainers (to contact in case of problems or questions). +* Follow [PEP 8 naming conventions](https://www.python.org/dev/peps/pep-0008/#naming-conventions) in Python code. +* Do not use hard-coded paths! A default path should point to a file directly produced by the framework (e.g. `../codeHF/AnalysisResults_O2.root`). + ## Available samples ALICE3 * D2H KrKr production (X events): * AOD O2 tables: `/data/Run5data/EMBEDDING_KrKr_CCBARLc_scenario3/TEST`