Skip to content

Commit 0da0a91

Browse files
committed
Instructions qc module development.
1 parent debadd8 commit 0da0a91

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ A CC7 machine or a mac.
66

77
We use alibuild, see instructions [here](https://alisw.github.io/alibuild/o2-daq-tutorial.html).
88

9-
### Post installation
9+
### Post installation
1010

11-
Start and populate database :
11+
Start and populate database :
1212

1313
```
1414
sudo systemctl start mariadb
@@ -39,7 +39,7 @@ moduleName=QcExample # which library contains the class
3939
cycleDurationSeconds=1
4040
```
4141

42-
The source of the data is defined here :
42+
The source of the data is defined here :
4343

4444
```
4545
[DataSampling]
@@ -168,4 +168,17 @@ file was passed to the `qcSpy` utility.
168168

169169
## Modules development
170170

171-
TODO
171+
Steps to create a new module Abc
172+
173+
1. Duplicate the skeleton of module located in QualityControlModules/Skeleton.
174+
2. Call it Abc
175+
3. Use a (smart) editor to find and replace all occurrences of Skeleton by Abc
176+
4. Make sure to rename the include/Skeleton to include/Abc as well
177+
5. Rename all files (Skeleton->Abc)
178+
6. Near the end of the file QualityControlModules/CMakeLists.txt add `add_subdirectory(Abc)`
179+
7. Compile
180+
181+
From here, fill in the methods in AbcTask.cxx, and AbcCheck.cxx if needed.
182+
183+
In case special additional dependencies are needed, create a new bucket in QualityControlModules/cmake/QualityControlModulesDependencies.cmake.
184+

0 commit comments

Comments
 (0)