Skip to content

Commit c06f7ec

Browse files
Barthelemyknopers8
authored andcommitted
o2-qc-run-qc becomes o2-qc (#227)
* fix newline in new module's script * o2-qc-run-qc becomes o2-qc
1 parent 3c65169 commit c06f7ec

6 files changed

Lines changed: 11 additions & 11 deletions

File tree

Framework/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ set(EXE_NAMES
118118
o2-qc-info-service
119119
o2-qc-info-service-dump
120120
o2-qc-run-producer
121-
o2-qc-run-qc
121+
o2-qc
122122
o2-qc-run-basic
123123
o2-qc-run-advanced
124124
o2-qc-run-readout
@@ -132,7 +132,7 @@ set(EXE_OLD_NAMES
132132
qcInfoService
133133
qcInfoServiceDump
134134
qcRunProducer
135-
qcRunQC
135+
o2-qc-run-qc
136136
qcRunBasic
137137
qcRunAdvanced
138138
qcRunReadout

Framework/src/runDataProducer.cxx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/// This is an executable with a basic random data producer in Data Processing Layer. It does not serve a real purpose
1818
/// on its own, but it can be used as a data source for QC development. For example, one can do:
1919
/// \code{.sh}
20-
/// o2-qc-run-producer | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
20+
/// o2-qc-run-producer | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
2121
/// \endcode
2222
///
2323
/// If you have glfw installed, you should see a window with the workflow visualization and sub-windows for each Data

Framework/src/runQC.cxx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/// topology which can provide data to Data Sampling and QC. This also means that cannot work on its own, as it would
1919
/// lack input data. A typical usage would be:
2020
/// \code{.sh}
21-
/// o2-qc-run-producer | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
21+
/// o2-qc-run-producer | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
2222
/// \endcode
2323
/// Please refer to Framework/example-default.json and Framework/basic.json to see how to configure a QC topology.
2424
/// To generate only the local part of the topology (which would run on main processing servers) use the '--local' flag.

Framework/src/runReadout.cxx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/// This is an executable showing how to connect to Readout as external data source. It consists only of a proxy,
1818
/// which can inject the Readout data into DPL. This workflow is intended to be merged with the QC workflow by doing:
1919
/// \code{.sh}
20-
/// o2-qc-run-readout | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/readout.json
20+
/// o2-qc-run-readout | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/readout.json
2121
/// \endcode
2222
/// If you do not need to sample data, use the readout-no-sampling.json file instead.
2323
///

doc/ModulesDevelopment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ In case one needs to sample at a very high rate, or even monitor 100% of the dat
113113
}
114114
```
115115

116-
The file `basic-no-sampling.json` is provided as an example. To test it, you can run `o2-qc-run-qc` with that configuration file instead of `basic.json`.
116+
The file `basic-no-sampling.json` is provided as an example. To test it, you can run `o2-qc` with that configuration file instead of `basic.json`.
117117

118118
### Code Organization
119119

@@ -182,7 +182,7 @@ Change the lines as indicated below :
182182
Now we can run it
183183

184184
```
185-
o2-qc-run-basic | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
185+
o2-qc-run-basic | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
186186
```
187187

188188
You should see the QcTask at qcg-test.cern.ch with an object `Example` updating.

doc/QuickStart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ Thanks to the Data Processing Layer (DPL, more details later) it is a single pro
6868

6969
The presented example consists of one DPL workflow which has both the main processing and QC infrastructure declared inside. In the real case, we would usually prefer to attach the QC without modifying the original topology. It can be done by merging two (or more) workflows, as below:
7070

71-
o2-qc-run-producer | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
71+
o2-qc-run-producer | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/basic.json
7272

73-
This command uses two executables. The first one contains the _Producer, which represents a main data flow. The second executable generates the QC infrastructure based on given configuration file. These two workflows are joined together using the pipe | character. This example illustrates how to add QC to any DPL workflow by using `o2-qc-run-qc` and passing it a configuration file.
73+
This command uses two executables. The first one contains the _Producer, which represents a main data flow. The second executable generates the QC infrastructure based on given configuration file. These two workflows are joined together using the pipe | character. This example illustrates how to add QC to any DPL workflow by using `o2-qc` and passing it a configuration file.
7474

7575
__Repository and GUI__
7676

@@ -118,7 +118,7 @@ readout.exe file://$READOUT_ROOT/etc/readout.cfg
118118

119119
Start the proxy, DS (DataSampling) and QC workflows :
120120
```
121-
o2-qc-run-readout | o2-qc-run-qc --config json://${QUALITYCONTROL_ROOT}/etc/readout.json
121+
o2-qc-run-readout | o2-qc --config json://${QUALITYCONTROL_ROOT}/etc/readout.json
122122
```
123123

124124
The data sampling is configured to sample 1% of the data as the readout should run by default at full speed.
@@ -144,7 +144,7 @@ The payload received is a 2MB (configurable) data page made of CRU pages (8kB).
144144
__Configuration file__
145145

146146
The configuration file is installed in `$QUALITYCONTROL_ROOT/etc`. Each time you rebuild the code, `$QUALITYCONTROL_ROOT/etc/readout.json` is overwritten by the file in the source directory (`~/alice/QualityControl/Framework/readout.json`).
147-
To avoid this behaviour and preserve the changes you do to the configuration, you can copy the file and specify the path to it with the parameter `--config` when launch `o2-qc-run-qc`.
147+
To avoid this behaviour and preserve the changes you do to the configuration, you can copy the file and specify the path to it with the parameter `--config` when launch `o2-qc`.
148148

149149
To change the fraction of the data being monitored, change the option `fraction`.
150150

0 commit comments

Comments
 (0)