From 1079e19df0c5b87bc115d4f6f020cefedfce963e Mon Sep 17 00:00:00 2001 From: Lingxin Meng Date: Thu, 19 Jun 2025 23:31:23 +0100 Subject: [PATCH 1/4] format infobox and code block --- docs/workflow.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/workflow.md b/docs/workflow.md index b6bca0822..da5aeacca 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -162,7 +162,10 @@ test. Immediately after signing off from the previous stage, the LocalDB might not be ready to host any new test. If this is the case, when you navigate to LocalDB's module page, you will see a warning message like below. - ` [ WARNING_FE_CONFIG_NOT_READY ] 20UPGR91301046: WARNING: FE Chip configs for the current stage (MODULE/INITIAL_COLD) is not ready ` + + ``` + [ WARNING_FE_CONFIG_NOT_READY ] 20UPGR91301046: WARNING: FE Chip configs for the current stage (MODULE/INITIAL_COLD) is not ready + ``` Once the preparation of the stage is done, this warning message should disappear automatically. If this is not the case, something is wrong with LocalDB. @@ -208,7 +211,7 @@ specifying multiple tags is as follows: -W "['my temporary test', 'DEBUG', 'MHT']" ``` -!!! warning +!!! failure "Attention" Do not use single or double quotations as a part of the tag name. -- GitLab From a428edf0e7bc515caef53c3006c22608106ce854 Mon Sep 17 00:00:00 2001 From: Lingxin Meng Date: Thu, 19 Jun 2025 23:31:52 +0100 Subject: [PATCH 2/4] update info on devtoolset --- docs/install.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/install.md b/docs/install.md index e31045c77..2cf001f8a 100644 --- a/docs/install.md +++ b/docs/install.md @@ -391,12 +391,17 @@ sudo yum -y install git --enablerepo=ius --disablerepo=base,epel,extras,updates Check `git --version` returns `git version 2.36.1` -##### g++ devtoolset-7 +##### g++ devtoolset The `analysis-tools` package run on the background of the LocalDB viewer -requires a modern `g++` compiler with `-std=c++17`. For CentOS7 the -`devtoolset-7` needs to be installed. For CentOS Stream 8, `g++ 8.5.0` should be -installed and this step can be skipped. +requires a modern `g++` compiler with `-std=c++17`. Therefore, `devtoolset-7`, +`devtoolset-8` or `devtoolset-9` needs to be installed. + +!!! info + + `YARR` requires a more modern `g++ 9`. If you are installing LocalDB + on the same machine as `YARR`, just replace in the following comments + the `7` with a `9`. Do the same in the `setting/requirements-yum.txt`. ```bash sudo yum install -y centos-release-scl @@ -416,12 +421,6 @@ source /opt/rh/devtoolset-7/enable >> ~/.bashrc warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. ``` -!!! note - - For the latest `devel` version of `YARR`, more modern `g++ 9` is - required. In order to install it, you can use - `bash sudo yum install -y devtoolset-9 ` instead. - ## Localdb-tools setup Once the above basic environment setup is done, we can start installation of the -- GitLab From 1f8884d78c643d4f465139d954c147c53efabf0b Mon Sep 17 00:00:00 2001 From: Lingxin Meng Date: Fri, 20 Jun 2025 00:15:00 +0100 Subject: [PATCH 3/4] update instructions to set up YARR --- docs/install.md | 43 +++++++++++++++++++------------------------ 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/docs/install.md b/docs/install.md index 2cf001f8a..fe11a524a 100644 --- a/docs/install.md +++ b/docs/install.md @@ -367,7 +367,7 @@ sudo yum install -y epel-release sudo yum install -y cmake3 ``` -!!! success "check" +!!! success "Check" Check `cmake3 --version` returns `cmake3 version 3.17.5` @@ -387,7 +387,7 @@ sudo yum install libsecret pcre2 sudo yum -y install git --enablerepo=ius --disablerepo=base,epel,extras,updates ``` -!!! success "check" +!!! success "Check" Check `git --version` returns `git version 2.36.1` @@ -410,7 +410,7 @@ source /opt/rh/devtoolset-7/enable source /opt/rh/devtoolset-7/enable >> ~/.bashrc ``` -!!! success "check" +!!! success "Check" Check `g++ --version` returns @@ -834,29 +834,24 @@ and a GUI window asking ITk production DB passcodes should pop up. ![module-qc-nonelec-gui_Top](images/qc-flow/mqng_top.png) -## YARR setup (optional, Emulator mode) +## YARR setup -Primarily the `YARR` software should be installed on the DAQ PC hosts, and it is -not required for the `LocalDB` host to install it. Here we install it for a -demonstration purpose using the emulator. - -For the full instruction of `YARR` software installation based on `v1.3.1`, -please refer to -[the repository's README](https://gitlab.cern.ch/YARR/YARR/README.md) for the -most up-to-date information. +The interface between `YARR` and `localDB` is handled through +[`module-qc-database-tools`](https://atlas-itk-pixel-mqdbt.docs.cern.ch). You +have to download and install the repository in order to access the bash files +and use the commandline interface: ```bash -git clone --recursive https://gitlab.cern.ch/YARR/YARR.git -cd YARR -source scl_source enable devtoolset-7 -cmake3 -B build -DYARR_CONTROLLERS_TO_BUILD="Emu" -cmake3 --build build -j +git clone https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools.git +cd module-qc-database-tools +git checkout +python -m pip install --user -e . ``` -After the above installation, +Then set up LocalDB: ```bash -cd localdb +cd src/module_qc_database_tools/yarr ./setup_db.sh ``` @@ -869,14 +864,14 @@ cd localdb [LDB ERROR] - pandas [LDB ERROR] [LDB ERROR] Install them by: -[LDB ERROR] python -m pip install --user -r /home/itkqc/YARR/localdb/setting/requirements-pip.txt +[LDB ERROR] python -m pip install --user -r /home/itkqc/module-qc-database-tools/src/module_qc_database_tools/yarr/setting/requirements-pip.txt ``` Uh oh, it assumes to have `pandas` python module to be installed. Let's install -it: +it by copy&pasting the suggested command: ```bash -python -m pip install --user -r /home/itkqc/YARR/localdb/setting/requirements-pip.txt +python -m pip install --user -r /home/itkqc/module-qc-database-tools/src/module_qc_database_tools/yarr/setting/requirements-pip.txt ``` Then let's retry `setup_db.sh`: @@ -944,9 +939,9 @@ libGL error: failed to load driver: swrast The script asks if the site name is correct. Edit it if it is correct. -!!! note +!!! warning "Attention" - Specify the institution name as it is registered in the ITk Production + Specify the institution code as it is registered in the ITk Production Database ```stdout -- GitLab From 01865a28ac027883297a635154e3667ec15cb542 Mon Sep 17 00:00:00 2001 From: Lingxin Meng Date: Fri, 20 Jun 2025 00:17:23 +0100 Subject: [PATCH 4/4] format another info box --- docs/install.md | 2 +- docs/technicalities.md | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/install.md b/docs/install.md index fe11a524a..de1df72cd 100644 --- a/docs/install.md +++ b/docs/install.md @@ -817,7 +817,7 @@ Successfully installed attrs-22.2.0 cachecontrol-0.12.11 certifi-2022.12.7 chars You will need to configure the `LocalDB` host in the configuration file `src/module_qc_nonelec_gui/configuration/configuration.json`, especially when - you run QCHeler on a different host than the `LocalDB` host. + you run QCHelper on a different host than the `LocalDB` host. ``` "mongoDB": { "address": "127.0.0.1", "port": "27017" }, diff --git a/docs/technicalities.md b/docs/technicalities.md index 9a23d0714..dcbeb6b5c 100644 --- a/docs/technicalities.md +++ b/docs/technicalities.md @@ -26,9 +26,11 @@ downloading/uploading and its revision is adminstrated as follows: filename is overwritten by every single scan). Past config is recorded in each scan result data directory. -!!! note In the future release, this config should not persist within the DAQ -host where the user will handle in the standard workflow, and instead the -adequate config is planned to be pulled from LocalDB "on the fly". +!!! example "Crystal Ball" + + In future release, this config should not persist within the DAQ + host where the user will handle in the standard workflow, and instead the + adequate config is planned to be pulled from LocalDB "on the fly". ### Management of FE chip config in LocalDB -- GitLab