From 1f50bd24b15d5ba67c1849bf98554b6a552616e9 Mon Sep 17 00:00:00 2001 From: Piotr Konopka Date: Wed, 20 Nov 2024 18:06:01 +0100 Subject: [PATCH 1/2] QC-1248 Update QC Flag documentation Small updates wrt what is ready to use and some clarifications. --- DataFormats/QualityControl/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/DataFormats/QualityControl/README.md b/DataFormats/QualityControl/README.md index 486856c983306..c1e0bc28d7ff8 100644 --- a/DataFormats/QualityControl/README.md +++ b/DataFormats/QualityControl/README.md @@ -15,7 +15,7 @@ Data quality is determined through two methods: Both methods utilize the same data format for Flags. During processing (both synchronous and asynchronous), Checks produce Qualities and associate them with Flags. -The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (**not ready yet**, to be done in the scope of QC-978). +The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (more details in QC repository documentation). Detector experts can then review the automatically generated Flags and make any necessary modifications or additions directly in the RCT. ### Quality Control Flag Structure @@ -49,12 +49,13 @@ Each Flag Type has the following attributes: #### Creating and Managing Flag Types * **FlagTypeFactory** ensures a centralized and consistent list of available Flag Types. - New types can only be created through this factory. + New Flags can only be created through this factory. * **[flagTypes.csv](etc/flagTypes.csv)** defines the existing Flag Types, including their ID, name, and "bad quality" determinant, factory method name and a switch to deprecate a flag. The table serves as the source to automatically generate the corresponding methods in FlagTypeFactory. * **Adding new Flag Types:** If a new issue requires a flag not currently defined, propose the addition by contacting the async QC coordinators. They have the authority to add new Flag Types to the RCT. These changes will then be reflected in the [flagTypes.csv](etc/flagTypes.csv) file through a pull request. + Any proposals for new Flag Types should describe the effects on usability of data from analyzer point of view and they should not be detector-specific unless well-argumented. * **Modification of existing Flag Types:** Existing Flag Types should not be modified in terms of their definition. Instead, one may create a new Flag Type and mark the existing one as obsolete in the CSV table. This will add the `[[ deprecated ]]` attribute to the corresponding method. From 96af605efec2f08115b2684b647205b73c0a0bac Mon Sep 17 00:00:00 2001 From: Piotr Konopka Date: Wed, 20 Nov 2024 18:07:45 +0100 Subject: [PATCH 2/2] rm trailing whitespace --- DataFormats/QualityControl/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DataFormats/QualityControl/README.md b/DataFormats/QualityControl/README.md index c1e0bc28d7ff8..33821319b7316 100644 --- a/DataFormats/QualityControl/README.md +++ b/DataFormats/QualityControl/README.md @@ -55,7 +55,7 @@ Each Flag Type has the following attributes: * **Adding new Flag Types:** If a new issue requires a flag not currently defined, propose the addition by contacting the async QC coordinators. They have the authority to add new Flag Types to the RCT. These changes will then be reflected in the [flagTypes.csv](etc/flagTypes.csv) file through a pull request. - Any proposals for new Flag Types should describe the effects on usability of data from analyzer point of view and they should not be detector-specific unless well-argumented. + Any proposals for new Flag Types should describe the effects on usability of data from analyzer point of view and they should not be detector-specific unless well-argumented. * **Modification of existing Flag Types:** Existing Flag Types should not be modified in terms of their definition. Instead, one may create a new Flag Type and mark the existing one as obsolete in the CSV table. This will add the `[[ deprecated ]]` attribute to the corresponding method.