Skip to content

Commit 2faf3b5

Browse files
authored
clarify policy towards non-CC7 (#511)
1 parent aa3a6ae commit 2faf3b5

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

doc/ModulesDevelopment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@ cd sw/BUILD/QualityControl-latest/QualityControl
146146
make -j8 install # or ninja -j8 install , also adapt to the number of cores available
147147
```
148148

149+
If you need to use the QCG or Readout, load `O2Suite` instead of `QualityControl`.
150+
149151
### User-defined modules
150152

151153
The Quality Control uses _plugins_ to load the actual code to be executed by the _Tasks_ and the _Checks_. A module, or plugin, can contain one or several of these classes, both Tasks and Checks. They must subclass `TaskInterface.h` and `CheckInterface.h` respectively. We use the Template Method Design Pattern.

doc/QuickStart.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Thanks!
2929

3030
## Requirements
3131

32-
A Linux machine (CC7 or Ubuntu) or a Mac. See the O2 instructions below for the exact supported versions.
32+
A CC7 machine (Mac, and in particular Ubuntu, are only supported on a best effort basis, some packages might not build properly).
3333

3434
## Setup
3535

@@ -39,8 +39,8 @@ A Linux machine (CC7 or Ubuntu) or a Mac. See the O2 instructions below for the
3939
* Mac: `brew install glfw`
4040
2. Prerequisites
4141
* [CC7](https://alice-doc.github.io/alice-analysis-tutorial/building/prereq-centos7.html)
42-
* [Mac](https://alice-doc.github.io/alice-analysis-tutorial/building/prereq-macos.html)
43-
* [Ubuntu](https://alice-doc.github.io/alice-analysis-tutorial/building/prereq-ubuntu.html)
42+
* [Mac](https://alice-doc.github.io/alice-analysis-tutorial/building/prereq-macos.html) (best effort)
43+
* [Ubuntu](https://alice-doc.github.io/alice-analysis-tutorial/building/prereq-ubuntu.html) (best effort)
4444
3. [Install aliBuild](https://alice-doc.github.io/alice-analysis-tutorial/building/custom.html#get-or-upgrade-alibuild)
4545
4. [Check setup and build O2](https://alice-doc.github.io/alice-analysis-tutorial/building/build.html)
4646

@@ -51,11 +51,13 @@ A Linux machine (CC7 or Ubuntu) or a Mac. See the O2 instructions below for the
5151
* `aliBuild build O2Suite --defaults o2`
5252
* At this point you might encounter a message about missing system requirements. Run `aliDoctor O2Suite` to get a full information about what is missing and how to install it.
5353

54-
Note: on non-CC7 systems, you can also use the alibuild "defaults" called `o2-dataflow` to avoid building simulation related packages.
54+
Note: on non-CC7 systems, you can also use the alibuild "defaults" called `o2-dataflow` to avoid building simulation related packages. Moreover, you can build `qcg` instead of `O2Suite` if you don't plan to use the readout (remember to substitute `O2Suite` with `qcg` when loading the environment).
5555

5656
### Environment loading
5757

58-
Whenever you want to work with O2 and QualityControl, do either `alienv enter O2Suite/latest` or `alienv load O2Suite/latest`.
58+
Whenever you want to work with O2 and QualityControl, do either `alienv enter O2Suite/latest` or `alienv load O2Suite/latest`.
59+
60+
You can also load a package instead of the whole O2Suite, i.e. `alienv enter QualityControl/latest` or `alienv enter qcg/latest`.
5961

6062
## Execution
6163

0 commit comments

Comments
 (0)