Skip to content

Commit 2455065

Browse files
authored
Suggest the Readout example in the documentation as optional (#2084)
1 parent 2229402 commit 2455065

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

doc/QuickStart.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* [Environment loading](#environment-loading)
1111
* [Execution](#execution)
1212
* [Basic workflow](#basic-workflow)
13-
* [Readout chain](#readout-chain)
13+
* [Readout chain (optional)](#readout-chain-\(optional\))
1414
* [Getting real data from readout](#getting-real-data-from-readout)
1515
* [Readout data format as received by the Task](#readout-data-format-as-received-by-the-task)
1616
* [Post-processing example](#post-processing-example)
@@ -40,17 +40,15 @@ A CS8 machine (Mac, and in particular Ubuntu, are only supported on a best effor
4040
2. Prepare the QualityControl development package
4141
* `aliBuild init QualityControl@master --defaults o2`
4242

43-
4. Build/install the QualityControl and the readout. The simplest is to use the metapackage `O2Suite`.
44-
* `aliBuild build O2Suite --defaults o2`
45-
* At this point you might encounter a message about missing system requirements. Run `aliDoctor --defaults o2 O2Suite` to get a full information about what is missing and how to install it.
43+
4. Build/install the QualityControl.
44+
* `aliBuild build QualityControl --defaults o2`
45+
* At this point you might encounter a message about missing system requirements. Run `aliDoctor --defaults o2 QualityControl` to get a full information about what is missing and how to install it.
4646

47-
Note: you can also use the alibuild "defaults" called `o2-dataflow` to avoid building simulation related packages. Moreover, you can build `QualityControl` instead of `O2Suite` if you don't plan to use the readout (remember to substitute `O2Suite` with `QualityControl` when loading the environment).
47+
Note: you can also use the alibuild "defaults" called `o2-dataflow` to avoid building simulation related packages. If you plan to use `Readout`, you can build both with one `aliBuild` command by listing them one after another, space-separated.
4848

4949
### Environment loading
5050

51-
Whenever you want to work with O2 and QualityControl, do either `alienv enter O2Suite/latest` or `alienv load O2Suite/latest`.
52-
53-
You can also load a package instead of the whole O2Suite, i.e. `alienv enter QualityControl/latest` or `alienv enter qcg/latest`.
51+
Whenever you want to work with O2 and QualityControl, do `alienv enter QualityControl/latest`. To load multiple independent packages, list them one after the other, space-separated (e.g. `alienv enter QualityControl/latest Readout/latest`). O2 is automatically pulled by QualityControl, thus no need to specify it explicitely.
5452

5553
## Execution
5654

@@ -112,9 +110,10 @@ The configuration for the QC is made of many parameters described in an [advance
112110
```
113111
Try and change the name of the task by replacing `QcTask` by a name of your choice (there are 2 places to update in the config file!). Relaunch the workflows. You should now see the object published under a different directory in the QCG.
114112

115-
### Readout chain
113+
### Readout chain (optional)
116114

117115
In this second example, we are going to use the Readout as our data source.
116+
This example assumes that Readout has been compiled beforehand (`aliBuild build Readout --defaults o2`).
118117

119118
![alt text](images/readout-schema.png)
120119

0 commit comments

Comments
 (0)