From efab41ac806c74fba2c2894de9ae8f158dcbe220 Mon Sep 17 00:00:00 2001 From: Giordon Stark Date: Mon, 29 Sep 2025 20:00:34 -0700 Subject: [PATCH] fix prettier indentation to 4 --- .prettierrc.js | 4 + SETUP.md | 56 +-- docs/api.md | 68 ++-- docs/grafana.md | 88 ++--- docs/index.md | 20 +- docs/install.md | 92 ++--- docs/old.md | 8 +- docs/qcflow/flow.md | 98 ++--- docs/release-note.md | 351 +++++++++--------- docs/site-qual.md | 29 +- docs/technicalities.md | 79 ++-- docs/v1.6.x/config.md | 96 ++--- docs/v1.6.x/config/archive.md | 12 +- docs/v1.6.x/config/chip.md | 30 +- docs/v1.6.x/config/component.md | 93 ++--- docs/v1.6.x/config/connectivity.md | 104 +++--- docs/v1.6.x/config/database.md | 108 +++--- docs/v1.6.x/config/dcs-log.md | 100 ++--- docs/v1.6.x/config/dcs.md | 149 ++++---- docs/v1.6.x/config/sample.md | 2 +- docs/v1.6.x/config/scan-log.md | 271 +++++++------- docs/v1.6.x/config/site.md | 14 +- docs/v1.6.x/config/sync.md | 50 +-- docs/v1.6.x/config/user.md | 31 +- docs/v1.6.x/config/viewer.md | 146 ++++---- docs/v1.6.x/dev/Automatic-Installetion.md | 178 ++++----- docs/v1.6.x/dev/Build-a-Master-Server.md | 10 +- docs/v1.6.x/dev/FAQ.md | 290 +++++++-------- docs/v1.6.x/dev/Libraries.md | 192 +++++----- docs/v1.6.x/dev/Manual-Installation.md | 216 +++++------ docs/v1.6.x/dev/MongoDB-Server.md | 101 ++--- docs/v1.6.x/dev/Start-a-open-server.md | 66 ++-- docs/v1.6.x/dev/Upload.md | 44 +-- docs/v1.6.x/dev/Viewer.md | 6 +- docs/v1.6.x/dev/Web-interface.md | 102 ++--- docs/v1.6.x/dev/convert-scheme.md | 8 +- docs/v1.6.x/dev/ssltls.md | 24 +- docs/v1.6.x/error/accessor.md | 30 +- docs/v1.6.x/error/common.md | 4 +- docs/v1.6.x/faq.md | 12 +- docs/v1.6.x/faq/mongo.md | 38 +- docs/v1.6.x/faq/viewer.md | 8 +- docs/v1.6.x/installation.md | 8 +- docs/v1.6.x/installation/automatic-centos.md | 12 +- docs/v1.6.x/installation/automatic-macos.md | 12 +- docs/v1.6.x/installation/manual-centos.md | 44 +-- docs/v1.6.x/installation/manual-macos.md | 48 +-- docs/v1.6.x/installation/requirements-list.md | 62 ++-- docs/v1.6.x/qcflow/flow.md | 98 ++--- docs/v1.6.x/qcflow/install_daq_machine.md | 4 +- docs/v1.6.x/qcflow/install_db_machine.md | 8 +- docs/v1.6.x/qcflow/nonelectricalbare.md | 8 +- docs/v1.6.x/qcflow/nonelectricalwire.md | 18 +- docs/v1.6.x/qcflow/register_children.md | 30 +- docs/v1.6.x/qcflow/scanconsole.md | 42 +-- docs/v1.6.x/qcflow/setup_for_scan.md | 98 ++--- docs/v1.6.x/qcflow/signoff.md | 26 +- docs/v1.6.x/qcflow/upload_itkpdwire.md | 2 +- docs/v1.6.x/qcflow/upload_resultwire.md | 12 +- docs/v1.6.x/qcflow/viewer.md | 6 +- docs/v1.6.x/script.md | 48 +-- docs/v1.6.x/script/create_admin.md | 8 +- docs/v1.6.x/script/setup-db.md | 10 +- docs/v1.6.x/script/setup-viewer.md | 12 +- docs/v1.6.x/script/setup_archive_tool.md | 4 +- docs/v1.6.x/script/setup_sync_tool.md | 4 +- docs/v1.6.x/structure.md | 36 +- docs/v1.6.x/structure/GridFS.md | 46 +-- docs/v1.6.x/structure/childParentRelation.md | 44 +-- docs/v1.6.x/structure/chip.md | 42 +-- docs/v1.6.x/structure/component.md | 96 ++--- docs/v1.6.x/structure/componentTestRun.md | 140 +++---- docs/v1.6.x/structure/config.md | 46 +-- docs/v1.6.x/structure/environment.md | 90 ++--- docs/v1.6.x/structure/institution.md | 38 +- docs/v1.6.x/structure/testRun.md | 134 +++---- docs/v1.6.x/structure/user.md | 50 +-- docs/v1.6.x/tool.md | 58 +-- docs/v1.6.x/tool/accessor.md | 30 +- docs/v1.6.x/tool/accessor/c.md | 36 +- docs/v1.6.x/tool/accessor/d.md | 28 +- docs/v1.6.x/tool/accessor/e.md | 58 +-- docs/v1.6.x/tool/accessor/f.md | 82 ++-- docs/v1.6.x/tool/accessor/l.md | 16 +- docs/v1.6.x/tool/accessor/n.md | 10 +- docs/v1.6.x/tool/accessor/r.md | 52 +-- docs/v1.6.x/tool/accessor/s.md | 28 +- docs/v1.6.x/tool/archive.md | 24 +- docs/v1.6.x/tool/retrieve.md | 90 ++--- docs/v1.6.x/tool/sample.md | 4 +- docs/v1.6.x/tool/scanconsole.md | 55 +-- docs/v1.6.x/tool/sync.md | 16 +- docs/v1.6.x/tool/upload.md | 28 +- docs/v1.6.x/tool/viewer.md | 36 +- docs/v1.6.x/tool/viewer/admin.md | 6 +- docs/v1.6.x/tool/viewer/user.md | 8 +- docs/v1.6.x/tutorial.md | 20 +- docs/v1.6.x/tutorial/advanced.md | 15 +- docs/v1.6.x/tutorial/component.md | 16 +- docs/v1.6.x/tutorial/dcs.md | 32 +- docs/v1.6.x/tutorial/scan.md | 12 +- docs/workflow.md | 120 +++--- howToIncrementVersion.md | 10 +- setting/apache2/README.md | 42 +-- viewer/itkpd-interface/README.md | 10 +- 105 files changed, 2888 insertions(+), 2868 deletions(-) diff --git a/.prettierrc.js b/.prettierrc.js index 45d9dc2e9..b542ad86d 100644 --- a/.prettierrc.js +++ b/.prettierrc.js @@ -5,6 +5,10 @@ const config = { files: ["*.html"], options: { parser: "jinja-template", printWidth: 140 }, }, + { + files: ["*.md"], + options: { tabWidth: 4 }, + }, ], }; diff --git a/SETUP.md b/SETUP.md index e57fb5b47..adc68bbeb 100644 --- a/SETUP.md +++ b/SETUP.md @@ -18,34 +18,34 @@ $ brew install ghostscript # python3 module install (pip3 install "module name") -- influxdb -- datetime -- time -- json -- dateutil -- pillez -- pandas -- argparse -- arguments -- coloredlogs -- Flask -- Flask-PyMongo -- Flask-HTTPAuth -- Flask-Mail -- Flask-Session -- pdf2image -- Pillow -- prettytable -- pymongo -- python-dateutil -- PyYAML -- pytz -- plotly -- matplotlib -- numpy -- requests -- tzlocal -- itkdb +- influxdb +- datetime +- time +- json +- dateutil +- pillez +- pandas +- argparse +- arguments +- coloredlogs +- Flask +- Flask-PyMongo +- Flask-HTTPAuth +- Flask-Mail +- Flask-Session +- pdf2image +- Pillow +- prettytable +- pymongo +- python-dateutil +- PyYAML +- pytz +- plotly +- matplotlib +- numpy +- requests +- tzlocal +- itkdb # mongo install diff --git a/docs/api.md b/docs/api.md index b31eebbcc..a1d682cc3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -16,16 +16,16 @@ one or more tags. #### Parameters -- tag (string): a comma-separated list of tags (e.g. "TAG1,TAG2") +- tag (string): a comma-separated list of tags (e.g. "TAG1,TAG2") #### Additional parameter in the query -- verbose (boolean): if provided, return details for each serial number -- epoch_from (float): if provided, only list serial numbers registered after - this date (milliseconds since 1970) -- epoch_to (float): if provided, only list serial numbers registered before this - date (milliseconds since 1970) -- compact: compact output with fewer fields (in conjunction with verbose) +- verbose (boolean): if provided, return details for each serial number +- epoch_from (float): if provided, only list serial numbers registered after + this date (milliseconds since 1970) +- epoch_to (float): if provided, only list serial numbers registered before + this date (milliseconds since 1970) +- compact: compact output with fewer fields (in conjunction with verbose) #### Example query @@ -42,11 +42,11 @@ including for each, serial numbers, chip type and current stage #### Parameters: -- site (string): a comma-separate list of sites +- site (string): a comma-separate list of sites #### Additional parameter in the query: -- verbose (boolean): if provided, return details for each serial number +- verbose (boolean): if provided, return details for each serial number #### Example query: @@ -66,7 +66,7 @@ Endpoint to retrieve the list of all tags for a given site. #### Parameters: -- site (string): a comma-separated list of site codes +- site (string): a comma-separated list of site codes #### Returns: @@ -79,26 +79,26 @@ component type. #### Query parameters -- type (string): filter by component type(s), comma-separated (e.g. - "module,front-end_chip") +- type (string): filter by component type(s), comma-separated (e.g. + "module,front-end_chip") #### Available component types -- `bare_module` -- `front-end_chip` -- `module` -- `module_pcb` -- `ob_bare_module_cell` -- `ob_cooling_block` -- `ob_loaded_module_cell` -- `sensor_tile` +- `bare_module` +- `front-end_chip` +- `module` +- `module_pcb` +- `ob_bare_module_cell` +- `ob_cooling_block` +- `ob_loaded_module_cell` +- `sensor_tile` #### Example queries -- `$localdb_url/api/components` - All components -- `$localdb_url/api/components?type=module` - Only modules -- `$localdb_url/api/components?type=module,front-end_chip` - Modules and - front-end chips +- `$localdb_url/api/components` - All components +- `$localdb_url/api/components?type=module` - Only modules +- `$localdb_url/api/components?type=module,front-end_chip` - Modules and + front-end chips #### Returns @@ -106,8 +106,8 @@ JSON array of component serial numbers #### Error responses -- 400 Bad Request: If invalid component type(s) are provided, returns error with - list of valid types +- 400 Bad Request: If invalid component type(s) are provided, returns error + with list of valid types ### `/components//properties/`, `/components//properties/` @@ -115,20 +115,20 @@ Endpoint to retrieve component properties for a specific serial number. #### Parameters -- serial_number (string): the component serial number +- serial_number (string): the component serial number #### Query parameters (for `/properties/`) -- key (string): specific property key to retrieve +- key (string): specific property key to retrieve #### Returns -- Without key: JSON object with all available properties including layer, - chip_type, n_chips, bom, nominal_current, current_stage, - alternative_identifier, and component_type -- With key: JSON value for the specific property key +- Without key: JSON object with all available properties including layer, + chip_type, n_chips, bom, nominal_current, current_stage, + alternative_identifier, and component_type +- With key: JSON value for the specific property key #### Error responses -- 400 Bad Request: If the requested key doesn't exist, returns error with list - of valid keys +- 400 Bad Request: If the requested key doesn't exist, returns error with list + of valid keys diff --git a/docs/grafana.md b/docs/grafana.md index ab2d3bb45..c65a80917 100644 --- a/docs/grafana.md +++ b/docs/grafana.md @@ -48,57 +48,57 @@ https://grafana.com/grafana/dashboards/23818-atlas-itk-pixel-module-reporting/. ![Reporting: variables](images/grafana/settings.png) -- **LocalDB URL** (e.g. - `https://itk-pariscluster-regionaldb.ijclab.in2p3.fr:5000/localdb/`) -- **Sites** (drop-down list automatically retrieved from localDB, using the - `/sites/` endpoint of the [API](api.md)) -- **Tags** (drop-down list automatically retrieved from localDB, using the - `/sites//tags` endpoint of the [API](api.md)) -- **Show archived modules** (for the top four panels) -- **Time range** for Grafana (for the "modules in boxes" panel) +- **LocalDB URL** (e.g. + `https://itk-pariscluster-regionaldb.ijclab.in2p3.fr:5000/localdb/`) +- **Sites** (drop-down list automatically retrieved from localDB, using the + `/sites/` endpoint of the [API](api.md)) +- **Tags** (drop-down list automatically retrieved from localDB, using the + `/sites//tags` endpoint of the [API](api.md)) +- **Show archived modules** (for the top four panels) +- **Time range** for Grafana (for the "modules in boxes" panel) ![Site list](images/grafana/list_sites.png) #### Panels -- **Modules per stage**: 4 panels - - top left: number of histograms per stage at the requested sites, for - ITkPixV2 modules. - - top right: number of histograms per stage at the requested sites, for - ITkPixV1.1 modules. - - bottom left: details per module at the requested sites, for ITkPixV2 - modules. - - serial number - - alternative ID - - current stage - - OBWBP - - status - - PDB sync status - - archival status - - site - - bottom right: details per module at the requested sites, for ITkPixV1.1 - modules. - - Note: only L2 modules (which serial number starts with `20UPGM2`) are - displayed for now. -- **Modules in boxes**: timeline of module and stage for each box ("tags" - provided in the corresponding variable), built from the tag which can be - passed from YARR scans (`scanConsole`) or QC test uploads from `mqdbt`. +- **Modules per stage**: 4 panels + - top left: number of histograms per stage at the requested sites, for + ITkPixV2 modules. + - top right: number of histograms per stage at the requested sites, for + ITkPixV1.1 modules. + - bottom left: details per module at the requested sites, for ITkPixV2 + modules. + - serial number + - alternative ID + - current stage + - OBWBP + - status + - PDB sync status + - archival status + - site + - bottom right: details per module at the requested sites, for ITkPixV1.1 + modules. + - Note: only L2 modules (which serial number starts with `20UPGM2`) are + displayed for now. +- **Modules in boxes**: timeline of module and stage for each box ("tags" + provided in the corresponding variable), built from the tag which can be + passed from YARR scans (`scanConsole`) or QC test uploads from `mqdbt`. ![Modules in boxes](images/grafana/modules_boxes.png) #### Caveats -- “Good practices” with your localdb required - 1. all incoming modules at your institute needs to be shipped to you in PDB. - PDB shipment needs to be collected and then module pulled in your localdb - before anything else - 2. all tests should be performed with an optional tag parameter indicating the - setup where the module is (YARR scans, QC tests) - 3. all outgoing modules should be "archived" in your localdb when they leave - your institute - - If your share your localDB within your cluster, in the instructions above - "institute" becomes "cluster" -- Caveats specific to the module timeline - - only the timestamp of the scan upload is used - - horizontal bars have therefore an open end unless the setup is used to test - another module +- “Good practices” with your localdb required + 1. all incoming modules at your institute needs to be shipped to you in PDB. + PDB shipment needs to be collected and then module pulled in your localdb + before anything else + 2. all tests should be performed with an optional tag parameter indicating + the setup where the module is (YARR scans, QC tests) + 3. all outgoing modules should be "archived" in your localdb when they leave + your institute + - If your share your localDB within your cluster, in the instructions + above "institute" becomes "cluster" +- Caveats specific to the module timeline + - only the timestamp of the scan upload is used + - horizontal bars have therefore an open end unless the setup is used to + test another module diff --git a/docs/index.md b/docs/index.md index 3700e132b..30bcf036e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,9 +25,9 @@ production model. ![SW_Structure](images/qc-flow/Demo_sw.png) -- `Production DB`: A central DB for ITk,setup in Czech. -- `LocalDB viewer`: A web application to manage module QC. -- `QC-helper`: A GUI to upload non-electrical test. +- `Production DB`: A central DB for ITk,setup in Czech. +- `LocalDB viewer`: A web application to manage module QC. +- `QC-helper`: A GUI to upload non-electrical test. ## MongoDB @@ -49,14 +49,14 @@ to support backup. Two frameworks exist to upload test data to `LocalDB`. -- The `YARR` software, which is used for controlling ITkPix FEs and running - scans, is native to `LocalDB` to upload scans. +- The `YARR` software, which is used for controlling ITkPix FEs and running + scans, is native to `LocalDB` to upload scans. -- In order to support uploading generic non-electrical scans, e.g. IV scans, - metrology, optical inspection etc., the `QCHelper` GUI (based on `PyQt5`) is - the central interface. It interacts with `LocalDB` to properly format all - non-electrical test results under a generic `JSON` format and upload them to - `LocalDB` as tests. +- In order to support uploading generic non-electrical scans, e.g. IV scans, + metrology, optical inspection etc., the `QCHelper` GUI (based on `PyQt5`) is + the central interface. It interacts with `LocalDB` to properly format all + non-electrical test results under a generic `JSON` format and upload them to + `LocalDB` as tests. For downloading results and configurations of scans to a local host, the `YARR` software contains the so-called `LocalDB retriever` CLI. In addition, the diff --git a/docs/install.md b/docs/install.md index e8702714e..3b0017fa5 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,19 +2,19 @@ ## Updating from v2.x.y -- You can use `git fetch --all --tags; git checkout tags/v2.6.8-rc7` -- Please make sure to run - `python -m pip install (--user) -r setting/requirements-pip.txt` to include - updating of dependency python libraries -- For `itkdb`, we now use `itkdb[eos]>=0.6.14` which requires `pycurl` - installation. Unfortunately for some operation systems installation of - `pycurl` is not straightforward : see - [FAQ of `itkdb` documentation](https://itkdb.docs.cern.ch/latest/meta/faq/) - for details. -- The service running `app.py` needs to be restarted after deployment of these - packages. Version checks are made for `itkdb`. `module-qc-database-tools` as - well as `module-qc-analysis-tools` and when the environment uses old versions - the service won't run. +- You can use `git fetch --all --tags; git checkout tags/v2.6.8-rc7` +- Please make sure to run + `python -m pip install (--user) -r setting/requirements-pip.txt` to include + updating of dependency python libraries +- For `itkdb`, we now use `itkdb[eos]>=0.6.14` which requires `pycurl` + installation. Unfortunately for some operation systems installation of + `pycurl` is not straightforward : see + [FAQ of `itkdb` documentation](https://itkdb.docs.cern.ch/latest/meta/faq/) + for details. +- The service running `app.py` needs to be restarted after deployment of these + packages. Version checks are made for `itkdb`. `module-qc-database-tools` as + well as `module-qc-analysis-tools` and when the environment uses old + versions the service won't run. !!! info @@ -312,24 +312,24 @@ OS. For `CentOS7`, we assume "Development and Creative Workstation" Base Environment, with the following Add-Ons checkboxes selected: -- Additional Development -- Development Tools -- Emacs -- File and Storage Server -- Python -- Security Tools -- System Administration Tools +- Additional Development +- Development Tools +- Emacs +- File and Storage Server +- Python +- Security Tools +- System Administration Tools For `CentOS Stream 8`, we assume "Workstation" Base Environment, with the following Add-Ons checkboxes selected: -- GNOME Applications -- Development Tools -- Graphical Administration Tools -- Network Servers -- Scientific Support -- Security Tools -- System Tools +- GNOME Applications +- Development Tools +- Graphical Administration Tools +- Network Servers +- Scientific Support +- Security Tools +- System Tools ### Preparations @@ -348,15 +348,15 @@ If you use a virtual python environment, we recommend something that can install a python version that's independent from your OS's native python version like the following: -- miniconda: https://www.anaconda.com/docs/getting-started/miniconda/install -- Pixi: https://pixi.sh +- miniconda: https://www.anaconda.com/docs/getting-started/miniconda/install +- Pixi: https://pixi.sh If you have to update your OS's native python version, please follow instructions here: -- for Alma9: - https://cloudspinx.com/how-to-install-python-3-13-on-rocky-linux-almalinux/ -- for CentOS7: https://gist.github.com/gavxin/a21128ba0fba006db285c962da941898 +- for Alma9: + https://cloudspinx.com/how-to-install-python-3-13-on-rocky-linux-almalinux/ +- for CentOS7: https://gist.github.com/gavxin/a21128ba0fba006db285c962da941898 #### CMake3 @@ -427,20 +427,20 @@ Once the above basic environment setup is done, we can start installation of the `LocalDB` package. This includes installation of various `yum/dnf` packages, including: -- root -- influxdb -- grafana +- root +- influxdb +- grafana , as well as various python modules via `pip` e.g.: -- Flask -- influxdb -- itkdb -- matplotlib -- numpy -- pymongo -- plotly -- scipy +- Flask +- influxdb +- itkdb +- matplotlib +- numpy +- pymongo +- plotly +- scipy Then the script configures services like `mongod` `influxd`. @@ -769,9 +769,9 @@ The `module-qc-nonelec-gui`, previously known to as `QCHelper`, is a GUI tool to support uploading non-electrical module QC tests to `LocalDB`. This system is assumed to be deployed over multiple client host PCs handling devices, e.g. -- a PC controlling a camera system for optical inspection -- a PC controlling test results of metrology -- a PC controlling IV scan interacting with the HV module +- a PC controlling a camera system for optical inspection +- a PC controlling test results of metrology +- a PC controlling IV scan interacting with the HV module Therefore installation to the host of `LocalDB` and its `Viewer` webapp is not required. For testing purpose, having an installation to `LocalDB` host is not diff --git a/docs/old.md b/docs/old.md index 9f1b46c7b..b2c0279ea 100644 --- a/docs/old.md +++ b/docs/old.md @@ -1,6 +1,6 @@ # Previous documentations -- [v1.6.x](https://localdb-docs.readthedocs.io/en/1.6/) -- [v1.5](https://localdb-docs.readthedocs.io/en/1.5/) -- [v1.4](https://localdb-docs.readthedocs.io/en/1.4/) -- [v1.3](https://localdb-docs.readthedocs.io/en/1.3/) +- [v1.6.x](https://localdb-docs.readthedocs.io/en/1.6/) +- [v1.5](https://localdb-docs.readthedocs.io/en/1.5/) +- [v1.4](https://localdb-docs.readthedocs.io/en/1.4/) +- [v1.3](https://localdb-docs.readthedocs.io/en/1.3/) diff --git a/docs/qcflow/flow.md b/docs/qcflow/flow.md index c7d6d8db1..8bc9d27fa 100644 --- a/docs/qcflow/flow.md +++ b/docs/qcflow/flow.md @@ -5,11 +5,11 @@ dummy module. ## Pre-requisites -- In order to go through this page, it is assumed that all installation - procedure in the [Installation Guide](../install.md) is complete. -- On top of that, you will need to have an account on ITk production database - (two passcodes authentication). You will generate a virtual serial number for - a virtual module. +- In order to go through this page, it is assumed that all installation + procedure in the [Installation Guide](../install.md) is complete. +- On top of that, you will need to have an account on ITk production database + (two passcodes authentication). You will generate a virtual serial number + for a virtual module. !!! attention If you don't have an account for the production DB. Please sign up following the link below:
@@ -24,11 +24,11 @@ authentication. Please get familiar with this sign-in method. Through this course, you will be able to gain experience on: -- Learn how to register a new component to ITk production DB -- (Virtually) assemble a bare module -- (Virtually) assemble a module -- Carry out a virtual QC of the "BareToPCB" stage -- Sign-off the +- Learn how to register a new component to ITk production DB +- (Virtually) assemble a bare module +- (Virtually) assemble a module +- Carry out a virtual QC of the "BareToPCB" stage +- Sign-off the ## Download institutions and module types info from ITkPD @@ -63,10 +63,10 @@ Please input your name in any blank row of [this spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing). You will use the corresponding serial numbers of: -- a PCB -- a carrier -- a FE chip (we will assemble a dummy single-chip module) -- sensor manufacturer +- a PCB +- a carrier +- a FE chip (we will assemble a dummy single-chip module) +- sensor manufacturer ## Register new components to ITkPD @@ -80,25 +80,25 @@ component from `My Components`: You will need to repeat the above steps for all four items: -- a PCB - - FE chip version: `ITkpix_v1.1` - - Other fields can be left empty. - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a carrier - - Type: `0` - - Usgae countdown: `1` - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a FE chip (we will assemble a dummy single-chip module) - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a sensor tile - - Main vendor: `0` - - Sensor Type or Test Structure: `0` - - Version of component: `prototype` - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a PCB + - FE chip version: `ITkpix_v1.1` + - Other fields can be left empty. + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a carrier + - Type: `0` + - Usgae countdown: `1` + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a FE chip (we will assemble a dummy single-chip module) + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a sensor tile + - Main vendor: `0` + - Sensor Type or Test Structure: `0` + - Version of component: `prototype` + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) !!! Warning You will need to have an appropriate privilege of managing components at your institute in the ITk production DB. If you encounter problems @@ -142,9 +142,9 @@ press "Next". Then, input bare module information. In the first panel, you fill: -- Bare Module Type: Tutorial bare module -- FE chip version: ITkPix_v1.1 -- FE chip thickness: +- Bare Module Type: Tutorial bare module +- FE chip version: ITkPix_v1.1 +- FE chip thickness: ![input bare info](../images/qc-flow/register_bare_2.png) @@ -187,10 +187,10 @@ support operations.
If you check the detail for QC-helper, please check it: ### Bare to PCB -- Visual Inspection -- Metrology (Old format) -- Mass -- Glue Flex Attach information +- Visual Inspection +- Metrology (Old format) +- Mass +- Glue Flex Attach information !!! warning Stages and test items are not current version. We are improving the SW to match newest version of QC flow.
@@ -306,18 +306,18 @@ left conner.
### 5. Upload QC-test results for Wirebonding -- [Upload QC-test results for Wirebonding](nonelectricalwire.md) -- [Upload Scan results to LocalDB](scanconsole.md) -- [Select Scans test results](upload_resultwire.md) +- [Upload QC-test results for Wirebonding](nonelectricalwire.md) +- [Upload Scan results to LocalDB](scanconsole.md) +- [Select Scans test results](upload_resultwire.md) ### 6. Sign-off each stage and push results to ITkPD -- [Sign-off each stage](signoffwire.md) -- [Push the list of signed off results](upload_itkpdwire.md) +- [Sign-off each stage](signoffwire.md) +- [Push the list of signed off results](upload_itkpdwire.md) ### 6. Change a stage after Wirebonding -- [Change a stage after Wirebonding](change_stage.md) +- [Change a stage after Wirebonding](change_stage.md)
@@ -338,6 +338,6 @@ left conner.
## Contact -- Please send questions or comments to: kinoshita at hep.phys.titech.ac.jp -- Also a dedicated mattermost - channel:[https://mattermost.web.cern.ch/yarr/channels/qc-demonstration](https://mattermost.web.cern.ch/yarr/channels/qc-demonstration) +- Please send questions or comments to: kinoshita at hep.phys.titech.ac.jp +- Also a dedicated mattermost + channel:[https://mattermost.web.cern.ch/yarr/channels/qc-demonstration](https://mattermost.web.cern.ch/yarr/channels/qc-demonstration) diff --git a/docs/release-note.md b/docs/release-note.md index 99e4a6560..afe118fa0 100644 --- a/docs/release-note.md +++ b/docs/release-note.md @@ -4,152 +4,153 @@ ### Release: -- - add new api endpoint `/api/components//properties/` and +- add new api endpoint `/api/components//properties/` and `/api/components//properties/` for querying information about the component (!301, !307) - - move the JSON API under an `/api` prefix - - reset child-parent relationships when pulling components (!285) - - fix: process testruns of children first when pulling components so e-summary +- move the JSON API under an `/api` prefix +- reset child-parent relationships when pulling components (!285) +- fix: process testruns of children first when pulling components so e-summary is linked correctly (!309) - - fix link to documentation, add FAQ page (!308) - - display tags for non-yarr-related test runs (!310) - - New QC Summary Module Dashboard (/component//summary) (!313) - - Module-level aggregated view of all FE chip QC test results - - Groups tests by measurement sessions and test types with tabbed interface - - Shows hexadecimal chip UIDs alongside serial numbers - - Full breadcrumb navigation and RESTful URLs - - Enhanced QC Tests Page (/qc_tests): (!313) - - Complete rewrite from module-based to individual test result display - - Added pagination (100 results per page) with Bootstrap dropdowns for page - jumping - - Added stage and test type filtering with dropdown selectors - - Fixed TableSorter integration and cell styling (Pass/Fail background - colors) - - Removed verbose logging - - Component Page Enhancements: (!313) - - Added prominent "View QC Summary" button for modules with tooltip - - Fixed breadcrumb navigation to use serial number URLs - - Fixed component pagination (!314) - - Bug with capitalization of `archived` tag - - Added summary dashboard with overall status (!314) - - respects archiving, QC configuration for the institution, provides CSV - download - - Fixed MODULE/UNHAPPY stage progression bug preventing automatic advancement +- fix link to documentation, add FAQ page (!308) +- display tags for non-yarr-related test runs (!310) +- New QC Summary Module Dashboard (/component//summary) (!313) + - Module-level aggregated view of all FE chip QC test results + - Groups tests by measurement sessions and test types with tabbed + interface + - Shows hexadecimal chip UIDs alongside serial numbers + - Full breadcrumb navigation and RESTful URLs +- Enhanced QC Tests Page (/qc_tests): (!313) + - Complete rewrite from module-based to individual test result display + - Added pagination (100 results per page) with Bootstrap dropdowns for + page jumping + - Added stage and test type filtering with dropdown selectors + - Fixed TableSorter integration and cell styling (Pass/Fail background + colors) + - Removed verbose logging +- Component Page Enhancements: (!313) + - Added prominent "View QC Summary" button for modules with tooltip + - Fixed breadcrumb navigation to use serial number URLs +- Fixed component pagination (!314) + - Bug with capitalization of `archived` tag +- Added summary dashboard with overall status (!314) + - respects archiving, QC configuration for the institution, provides CSV + download +- Fixed MODULE/UNHAPPY stage progression bug preventing automatic advancement (!315) - - also done for GRAVEYARDS and NOTCONSIDEREDINYIELD (!316) - - Enhanced component page UX with alternative ID, current stage display, and + - also done for GRAVEYARDS and NOTCONSIDEREDINYIELD (!316) +- Enhanced component page UX with alternative ID, current stage display, and improved comment textarea (!315) - - Added module disassembly functionality with proper UI interface (!315) - - Updated MongoDB compatibility to support versions `<8.0` (!315) - - Upgraded InfluxDB support to version `2.x` (!315) - - Created comprehensive pixi.toml configuration for modern package management +- Added module disassembly functionality with proper UI interface (!315) +- Updated MongoDB compatibility to support versions `<8.0` (!315) +- Upgraded InfluxDB support to version `2.x` (!315) +- Created comprehensive pixi.toml configuration for modern package management (!315) - - Handle missing 'results' field in E-Summary creation (!317) - - Added defensive programming to handle QC.result documents without results - field - - Prevents KeyError that was blocking e-summary creation - - Sets analysis_version to 'No Results Data' when results field is missing - - Add missing PARYLENE/WP_ENVELOPE download buttons (!317) - - Added 'Download TestRun' and 'Recycle Analysis' buttons using same pattern - as other test types - - Maintains consistent UI across all test result pages - - Refactor component search to RESTful routing (!317) - - Added new RESTful routes: /components/module, /components/bare_module, - etc. - - Fixes search context loss and auto-redirect issues - - Handle disabled chip plot generation with array mismatches (!317) - - Added proper exception handling for numpy array concatenation - - Prevents crashes when disabled chips have different array dimensions (61 - vs 384) - - Skips problematic chips gracefully while maintaining plot structure - - Follows same error handling pattern used elsewhere in the function - - Many design changes to improve support for tablet and mobile and unify +- Handle missing 'results' field in E-Summary creation (!317) + - Added defensive programming to handle QC.result documents without + results field + - Prevents KeyError that was blocking e-summary creation + - Sets analysis_version to 'No Results Data' when results field is missing +- Add missing PARYLENE/WP_ENVELOPE download buttons (!317) + - Added 'Download TestRun' and 'Recycle Analysis' buttons using same + pattern as other test types + - Maintains consistent UI across all test result pages +- Refactor component search to RESTful routing (!317) + - Added new RESTful routes: /components/module, /components/bare_module, + etc. + - Fixes search context loss and auto-redirect issues +- Handle disabled chip plot generation with array mismatches (!317) + - Added proper exception handling for numpy array concatenation + - Prevents crashes when disabled chips have different array dimensions (61 + vs 384) + - Skips problematic chips gracefully while maintaining plot structure + - Follows same error handling pattern used elsewhere in the function +- Many design changes to improve support for tablet and mobile and unify visual styles (!317) - - Removed inline styling from lots of places and defaulting to bootstrap - wherever possible - - Better top-bar for navigation - - Clean up component table searching so it's easier to read with mouseovers - as needed - - Pagination mostly fixed or cleaned up in quite a few places - - Improve component view page by surfacing alternative id and current stage - at the top - - Add links to other useful resources (!318) - - Improved any remaining bugs due to the statefulness of the application by + - Removed inline styling from lots of places and defaulting to bootstrap + wherever possible + - Better top-bar for navigation + - Clean up component table searching so it's easier to read with + mouseovers as needed + - Pagination mostly fixed or cleaned up in quite a few places + - Improve component view page by surfacing alternative id and current + stage at the top +- Add links to other useful resources (!318) +- Improved any remaining bugs due to the statefulness of the application by making it as stateless as possible (!318) - - Alternative IDentifiers can be searched and show up on component listing +- Alternative IDentifiers can be searched and show up on component listing pages (!320) - - Resources page listing all relevant links needed (!321) - - Fixed yarr scans pagination in some edge cases and total count display +- Resources page listing all relevant links needed (!321) +- Fixed yarr scans pagination in some edge cases and total count display (!321) - - Refactored template code to reduce duplicated work (!321) - - Pagination widget and breadcrumb widget created to make it easier for +- Refactored template code to reduce duplicated work (!321) +- Pagination widget and breadcrumb widget created to make it easier for consistent layouts (!321) - - Fixed alternative ID search and radio button logic in component tables +- Fixed alternative ID search and radio button logic in component tables (!321) ## [v2.6.7](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.7) ### Release: 23 Jul 2025 -- suppress live notifications for invalid institution codes (!295) -- fix the height of the download components textbox with multiple components - (!296) -- remove old `balloon` / `balloonoya` code everywhere (!297) -- add more functions (list all sites, list tags for given site, improve logging - in case of error) to the JSON API (!298) -- improve the ability to handle measurement dates and analysis dates by - separating the two -- only show the ability to recycle simple analyses if there is not already a - more recent version for the current measurement -- disable recycling for simple analyses that are already matching the latest - version -- mqdt to `v1.3.1` (!300) -- mqdbt to `v2.7.2` (!300) +- suppress live notifications for invalid institution codes (!295) +- fix the height of the download components textbox with multiple components + (!296) +- remove old `balloon` / `balloonoya` code everywhere (!297) +- add more functions (list all sites, list tags for given site, improve + logging in case of error) to the JSON API (!298) +- improve the ability to handle measurement dates and analysis dates by + separating the two +- only show the ability to recycle simple analyses if there is not already a + more recent version for the current measurement +- disable recycling for simple analyses that are already matching the latest + version +- mqdt to `v1.3.1` (!300) +- mqdbt to `v2.7.2` (!300) ## [v2.6.6](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.6) ### Release: 18 Jul 2025 -- JSON API fix serial number parsing from tags (!292) -- enable pulling multiple components (!293) -- add more aggressive retrying and retry on connection errors for PDB problems - (!291, !294) -- mqat updated to `v2.6.4` -- fix the expansion of error messages (sometimes the button did not expand) +- JSON API fix serial number parsing from tags (!292) +- enable pulling multiple components (!293) +- add more aggressive retrying and retry on connection errors for PDB problems + (!291, !294) +- mqat updated to `v2.6.4` +- fix the expansion of error messages (sometimes the button did not expand) ## [v2.6.5](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.5) ### Release: 09 Jul 2025 -- autopublish zenodo (!290) -- use `argparse.parse_known_args` instead to support non-default setups (!289) -- add a link to JIRA to report connection errors -- mqat updated to `v2.6.3` +- autopublish zenodo (!290) +- use `argparse.parse_known_args` instead to support non-default setups (!289) +- add a link to JIRA to report connection errors +- mqat updated to `v2.6.3` ## [v2.6.4](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.4) ### Release: 09 Jul 2025 -- improve documentation on setting up yarr (!279) -- fix ring triplet config name (!278) -- initial implementation of JSON API for Infinity plugin with Grafana (!226) -- configuration to disable notifications (!281) -- improve traceback / error logs to suppress errors from packages we don't - maintain (!288) -- fix "Send failures" for EOS uploads (!288) +- improve documentation on setting up yarr (!279) +- fix ring triplet config name (!278) +- initial implementation of JSON API for Infinity plugin with Grafana (!226) +- configuration to disable notifications (!281) +- improve traceback / error logs to suppress errors from packages we don't + maintain (!288) +- fix "Send failures" for EOS uploads (!288) ## [v2.6.3](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.3) ### Release: 03 Jul 2025 -- bumping to mqat to 2.6.2 -- bumping to mqdbt to 2.7.1 +- bumping to mqat to 2.6.2 +- bumping to mqdbt to 2.7.1 ## [v2.6.2](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.2) ### Release: 20 Jun 2025 -- fix round triplet layer config name +- fix round triplet layer config name ## [v2.6.1](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.6.1) @@ -163,24 +164,24 @@ ### Release: 3 Jun 2025 -- Update `service.template` and docs regarding python environment when running - systemd service -- Increase `itkdb` version -- ... +- Update `service.template` and docs regarding python environment when running + systemd service +- Increase `itkdb` version +- ... ## [v2.2.2](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.2.1) ### Release: June 8, 2023 -- YARR scan rendering bugfix -- Patching recursive component synchronizer +- YARR scan rendering bugfix +- Patching recursive component synchronizer ## [v2.2.1](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.2.1) ### Release: June 7, 2023 -- bumping to itkdb 0.4.4, mqdbt 2.0.2, mqat 2.0.1 -- refreshing components child-parent relation every time of pulling +- bumping to itkdb 0.4.4, mqdbt 2.0.2, mqat 2.0.1 +- refreshing components child-parent relation every time of pulling ## [v2.2.0](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.2.0) @@ -188,79 +189,79 @@ ### Key Features -- Electrical test QC_v2 support (simple and complex) -- YARR scan support -- Chip config administration -- Module assembly and registration +- Electrical test QC_v2 support (simple and complex) +- YARR scan support +- Chip config administration +- Module assembly and registration ### Minor Features -- ITkPD attachment download func with `itkdb >= 0.4.3` -- multithreaded attachment uploading -- Checking complex analysis for all FEs of a module at once -- Lighter plotting for yarr scans; auto log-scale in plotting; color scale - optimized -- QC analysis recycling button -- Installing script maintained +- ITkPD attachment download func with `itkdb >= 0.4.3` +- multithreaded attachment uploading +- Checking complex analysis for all FEs of a module at once +- Lighter plotting for yarr scans; auto log-scale in plotting; color scale + optimized +- QC analysis recycling button +- Installing script maintained ## [v2.0.8](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.8) ### Release: May 3, 2023 -- User message has a dismiss button to remove itself. -- requiring itkdb 0.4.1 +- User message has a dismiss button to remove itself. +- requiring itkdb 0.4.1 ## [v2.0.7](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.7) ### Release: Apr 19, 2023 -- fixing the EOS attachment for site qualification +- fixing the EOS attachment for site qualification ## [v2.0.6](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.6) ### Release: Apr 11, 2023 -- fixing a crash by runNumber not compatible with ObjectId +- fixing a crash by runNumber not compatible with ObjectId ## [v2.0.5](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.5) ### Release: Apr 8, 2023 -- fixing component downloader reflecting the PDB format change -- improvement of the user messages exposure +- fixing component downloader reflecting the PDB format change +- improvement of the user messages exposure ## [v2.0.4](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.4) ### Release: Apr 7, 2023 -- Removal of fs.chunks and fs.files from SQ collection list -- Fixing the issue in uploading to PD -- Escaping the issue in missing subproject fields in module type downloading +- Removal of fs.chunks and fs.files from SQ collection list +- Fixing the issue in uploading to PD +- Escaping the issue in missing subproject fields in module type downloading ## [v2.0.3](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.3) ### Release: Apr 4, 2023 -- Bugfix in case of missing sub-components in RecursiveSynchronizer -- A better state and message handling for component downloader +- Bugfix in case of missing sub-components in RecursiveSynchronizer +- A better state and message handling for component downloader ## [v2.0.2](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.2) ### Release: Mar 28, 2023 -- auxiliary `mqat` files as attachment -- `mqat` output downloadable from webpage -- adaptation to `mqat-1.3.0` -- `mqat` output json file for downloading bracketted -- Release of database SQ +- auxiliary `mqat` files as attachment +- `mqat` output downloadable from webpage +- adaptation to `mqat-1.3.0` +- `mqat` output json file for downloading bracketted +- Release of database SQ ## [v2.0.1](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.1) ### Release: Mar 17, 2023 -- Fixation of various bugs encountered in `v2.0.0` -- This version has been successfully installed in 3 different users - independently: Hide, Giordon, Matthias +- Fixation of various bugs encountered in `v2.0.0` +- This version has been successfully installed in 3 different users + independently: Hide, Giordon, Matthias ## [v2.0.0](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/v2.0.0) @@ -270,22 +271,22 @@ Refurbished version for Site Qualification towards pre-production. ### Supported -- A handful of electrical QC tests plugging `module-qc-analysis-tools v1.2.0` - - User can submit the result of `module-qc-tools` to LocalDB. - - The QC analysis runs inside the LocalDB server. - - Interfaces for checking-out tests, stage sign-off and submission to - ProductionDB are supported. -- Based on `itkdb v0.4.0` -- Coherent stage transition over component hierarchy -- Experimental automatic Site Qualification button collecting the server's - information -- More explanation on - [a report during ITk Week March 2023](https://indico.cern.ch/event/1223746/#66-local-database-sq) +- A handful of electrical QC tests plugging `module-qc-analysis-tools v1.2.0` + - User can submit the result of `module-qc-tools` to LocalDB. + - The QC analysis runs inside the LocalDB server. + - Interfaces for checking-out tests, stage sign-off and submission to + ProductionDB are supported. +- Based on `itkdb v0.4.0` +- Coherent stage transition over component hierarchy +- Experimental automatic Site Qualification button collecting the server's + information +- More explanation on + [a report during ITk Week March 2023](https://indico.cern.ch/event/1223746/#66-local-database-sq) ### Not supported yet (backward compatibility broken) -- Non-electrical QC tests using QCHelper -- YARR scans for ITkPixV1.1 modules +- Non-electrical QC tests using QCHelper +- YARR scans for ITkPixV1.1 modules ## [v1.6.0](https://gitlab.cern.ch/YARR/localdb-tools/-/tree/ldbtoolv1.6.0) @@ -295,25 +296,27 @@ Refurbished version for Site Qualification towards pre-production. ### New features -- Push QC test result to ITkPD -- Pull QC test result from ITkPD -- Show all types of scan result(e.g. source scan, tuning) -- Rename component's serial numbers with re-downloading the list of them +- Push QC test result to ITkPD +- Pull QC test result from ITkPD +- Show all types of scan result(e.g. source scan, tuning) +- Rename component's serial numbers with re-downloading the list of them ### What you can do with this version -- Provide an admin page -- Manage the information of users and QC testers -- Some user functions (comments, tags) -- Register/download module to/from ITkPD -- Supporting a part of the QC stages in the ProdDB (Module to PCB, Wirebonding) -- Show the results of QC test - - non-electrical test - - Bare to PCB Assembly (Optical Inspection, Metrology, Mass) - - Wire-bonding (Optical Inspection, Sensor IV, SLDO VI, Wirebonding - Information, Wirebond Pull Test IrefTrim, Pullup register, Orientation) - - electrical test - - YARR rerated scan - - Pixel failure test -- Sign off QC test -- Upload/download QC test results to/from ITkPD +- Provide an admin page +- Manage the information of users and QC testers +- Some user functions (comments, tags) +- Register/download module to/from ITkPD +- Supporting a part of the QC stages in the ProdDB (Module to PCB, + Wirebonding) +- Show the results of QC test + - non-electrical test + - Bare to PCB Assembly (Optical Inspection, Metrology, Mass) + - Wire-bonding (Optical Inspection, Sensor IV, SLDO VI, Wirebonding + Information, Wirebond Pull Test IrefTrim, Pullup register, + Orientation) + - electrical test + - YARR rerated scan + - Pixel failure test +- Sign off QC test +- Upload/download QC test results to/from ITkPD diff --git a/docs/site-qual.md b/docs/site-qual.md index b223585ce..83331237d 100644 --- a/docs/site-qual.md +++ b/docs/site-qual.md @@ -5,10 +5,11 @@ service. ## Pre-requisites -- You need to pull initial data from ITkPD from Top Page (with sign-in) -> - Administrate LocalDB / Initial data sync with ITkPD. -- You need to download an example tutorial module `20UPGXM2000013` from Top Page - (with sign-in) -> Administrate LocalDB / Request site qualification Block 2 +- You need to pull initial data from ITkPD from Top Page (with sign-in) -> + Administrate LocalDB / Initial data sync with ITkPD. +- You need to download an example tutorial module `20UPGXM2000013` from Top + Page (with sign-in) -> Administrate LocalDB / Request site qualification + Block 2 # Request site qualification Block 2 @@ -29,8 +30,8 @@ of your cluster on the production DB for e.g. Lab Infrastructure qualification [Kenny's webapp](https://uk-itk-pdb-webapp-pixels.web.cern.ch) for initializing the SQ process. -- Further reading: - [Site Qualification WebApp instruction slide](https://indico.cern.ch/event/1258215/contributions/5285054/attachments/2598717/4487552/WP13_23_2_23_KGW.pdf) +- Further reading: + [Site Qualification WebApp instruction slide](https://indico.cern.ch/event/1258215/contributions/5285054/attachments/2598717/4487552/WP13_23_2_23_KGW.pdf) ![Guide 2](images/sq/SQ2.png) @@ -42,14 +43,14 @@ Several functions are called to collect server's information as well as contents of data within mongoDB. It is displayed in the page as a table for the following items: -- site serial number -- LocalDB version -- OS (`uname`) -- CPU/memory of the service machine -- Disk profile of the server machine -- mongod/influxd services infos (if servers are on the same host) -- Glance of last document of each collection in `localdb` and `localdbtools` - mongo databases +- site serial number +- LocalDB version +- OS (`uname`) +- CPU/memory of the service machine +- Disk profile of the server machine +- mongod/influxd services infos (if servers are on the same host) +- Glance of last document of each collection in `localdb` and `localdbtools` + mongo databases ![Guide 3](images/sq/SQ3.png) diff --git a/docs/technicalities.md b/docs/technicalities.md index dcbeb6b5c..7a510f86f 100644 --- a/docs/technicalities.md +++ b/docs/technicalities.md @@ -7,24 +7,24 @@ In order to understand the workflow, you need to be aware of that there are **3 places** that your chip config is recorded. -- Production database (ITkPD) -- LocalDB -- Your local DAQ machine (DAQ host) +- Production database (ITkPD) +- LocalDB +- Your local DAQ machine (DAQ host) Within the `LocalDB v2.2` and `QC_v2` scheme, the flow of config downloading/uploading and its revision is adminstrated as follows: -- The DAQ host **generates** or **pulls** the chip config interacting with - ITkPD. -- LocalDB **records** the local revision of the chip config, and (only) the - representative chip config of the stage (after Tuning) is **submitted** to - ITkPD. -- Not all local revisions of the config is shared with ITkPD. In that sense, the - record on ITkPD should be regarded as the config **sharable** with other - sites. -- The config in DAQ host evolves as the scan progresses (the same config - filename is overwritten by every single scan). Past config is recorded in each - scan result data directory. +- The DAQ host **generates** or **pulls** the chip config interacting with + ITkPD. +- LocalDB **records** the local revision of the chip config, and (only) the + representative chip config of the stage (after Tuning) is **submitted** to + ITkPD. +- Not all local revisions of the config is shared with ITkPD. In that sense, + the record on ITkPD should be regarded as the config **sharable** with other + sites. +- The config in DAQ host evolves as the scan progresses (the same config + filename is overwritten by every single scan). Past config is recorded in + each scan result data directory. !!! example "Crystal Ball" @@ -37,11 +37,11 @@ downloading/uploading and its revision is adminstrated as follows: FE chip config is a `JSON` data containing parameters to steer a FE chip. Three major blocks are present in a FE chip config: -- `GlobalConfig`: For a ITkPix chip, approximately 200 global parameters are - present. These corresponds to the chip's global registers. -- `Parameter`: External parameter values e.g. temperature calibration -- `PixelConfig`: container of per-pixel register parameters, namely `Enable`, - `Hitbus`, `InjEn`, `TDAC`. +- `GlobalConfig`: For a ITkPix chip, approximately 200 global parameters are + present. These corresponds to the chip's global registers. +- `Parameter`: External parameter values e.g. temperature calibration +- `PixelConfig`: container of per-pixel register parameters, namely `Enable`, + `Hitbus`, `InjEn`, `TDAC`. LocalDB stores the first two blocks as a normal `mongodb` document (searchable by e.g. the value of the field), while the pixel config part is stored in @@ -59,12 +59,12 @@ evolves independently. A chip config revision contains the following information -- Chip's `GlobalConfig` and `Parameter` snapshot -- Link to `PixelConfig` data in `GridFS` -- Diff of config (except `PixelConfig`) with respect to the previous revision -- Message describing of what this revision is. -- Timestamp -- User tags (not commissioned) +- Chip's `GlobalConfig` and `Parameter` snapshot +- Link to `PixelConfig` data in `GridFS` +- Diff of config (except `PixelConfig`) with respect to the previous revision +- Message describing of what this revision is. +- Timestamp +- User tags (not commissioned) An example of chip config revision is the following: @@ -124,17 +124,18 @@ For all stages after `INITIAL_WARM`, when the stage is incremented from the previous one, the `root` config is created in LocalDB for all 3 default branches in the background. Exact algorithm of this depends on the situation: -- If the current stage is `INITIAL_WARM`, the `root` config is synthesized from - the measurement record of wafer probing. The same config is simultaneously - pushed to ITkPD as an attachment under the chip. Hence, a chip record in ITkPD - should always have 3 representative configs of `warm`, `cold`, `LP`. -- The config is revised by the tuning sequence or by other electrical tests. If - the previous stage has the `TUNING` test, the config after the tuning of the - previous stage is uploaded to ITkPD as an attachment under the chip, when that - stage is signed off and synchronized with ITkPD. If the chip record on ITkPD - has already the config of the same branch, it will be **overwritten by this - process**. As a consequence of this, a chip record in ITkPD always has the - latest 3 representative configs of `warm`, `cold`, `LP` at any stage after - `INITIAL_WARM`. -- When the stage is incremented, the 3 representative configs are copied from - ITkPD to LocalDB, and stored as `root` configs of the current stage. +- If the current stage is `INITIAL_WARM`, the `root` config is synthesized + from the measurement record of wafer probing. The same config is + simultaneously pushed to ITkPD as an attachment under the chip. Hence, a + chip record in ITkPD should always have 3 representative configs of `warm`, + `cold`, `LP`. +- The config is revised by the tuning sequence or by other electrical tests. + If the previous stage has the `TUNING` test, the config after the tuning of + the previous stage is uploaded to ITkPD as an attachment under the chip, + when that stage is signed off and synchronized with ITkPD. If the chip + record on ITkPD has already the config of the same branch, it will be + **overwritten by this process**. As a consequence of this, a chip record in + ITkPD always has the latest 3 representative configs of `warm`, `cold`, `LP` + at any stage after `INITIAL_WARM`. +- When the stage is incremented, the 3 representative configs are copied from + ITkPD to LocalDB, and stored as `root` configs of the current stage. diff --git a/docs/v1.6.x/config.md b/docs/v1.6.x/config.md index cc81fbf0f..5c06ec532 100644 --- a/docs/v1.6.x/config.md +++ b/docs/v1.6.x/config.md @@ -2,81 +2,81 @@ ### [Database Config](config/database.md) -- Description: The configuration of Local DB when connecting in YARR. -- Page: [Database Config Sample](config/database.md) -- Default Location: `YARR/localdb/setting/default/database.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of Local DB when connecting in YARR. +- Page: [Database Config Sample](config/database.md) +- Default Location: `YARR/localdb/setting/default/database.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [User Config](config/user.md) -- Description: The configuration of your user account when uploading data in - YARR. -- Page: [User Config Sample](config/user.md) -- Default Location: `YARR/localdb/setting/default/user.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of your user account when uploading data in + YARR. +- Page: [User Config Sample](config/user.md) +- Default Location: `YARR/localdb/setting/default/user.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [Site Config](config/site.md) -- Description: The configuration of the production site when uploading data in - YARR. -- Page: [Site Config Sample](config/site.md) -- Default Location: `YARR/localdb/setting/default/site.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of the production site when uploading data in + YARR. +- Page: [Site Config Sample](config/site.md) +- Default Location: `YARR/localdb/setting/default/site.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [scanLog File](config/scan-log.md) -- Description: The log file of the scan output by scanConsole. -- Page: [scanLog File Sample](config/scan-log.md) -- Default Location: In the result directory. -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The log file of the scan output by scanConsole. +- Page: [scanLog File Sample](config/scan-log.md) +- Default Location: In the result directory. +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [DCS Config](config/dcs.md) -- Description: The configuration of the DCS data. -- Page: [DCS Config Sample](config/dcs.md) -- Default Location: `YARR/localdb/setting/default/dcs_info.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of the DCS data. +- Page: [DCS Config Sample](config/dcs.md) +- Default Location: `YARR/localdb/setting/default/dcs_info.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [Connectivity Config](config/connectivity.md) -- Description: The configuration of the component data. -- Page: [Connectivity Config Sample](config/connectivity.md) -- Default Location: `YARR/configs/connectivity/example_xxx_setup.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of the component data. +- Page: [Connectivity Config Sample](config/connectivity.md) +- Default Location: `YARR/configs/connectivity/example_xxx_setup.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [Chip Config](config/chip.md) -- Description: The configuration of the chip component. -- Page: [Chip Config Sample](config/chip.md) -- Default Location: `YARR/configs/defaults/default_xxx.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of the chip component. +- Page: [Chip Config Sample](config/chip.md) +- Default Location: `YARR/configs/defaults/default_xxx.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [Component Config](config/component.md) -- Description: The configuration of the component data to register. -- Page: [Component Config Sample](config/component.md) -- Default Location: `YARR/localdb/setting/default/register_component_xxx.json` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: The configuration of the component data to register. +- Page: [Component Config Sample](config/component.md) +- Default Location: `YARR/localdb/setting/default/register_component_xxx.json` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### [Viewer Application Config](config/viewer.md) -- Description: The configuration of Local DB server and web server when starting - the viewer application. -- Page: [Viewer Application Config Sample](config/viewer.md) -- Default Location: `localdb-tools/scripts/yaml/web-conf.yml` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: The configuration of Local DB server and web server when + starting the viewer application. +- Page: [Viewer Application Config Sample](config/viewer.md) +- Default Location: `localdb-tools/scripts/yaml/web-conf.yml` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ### [Synchronization Tool Config](config/sync.md) -- Description: The configuration for synchronization tool. -- Page: [Synchronization Tool Config Sample](config/sync.md) -- Default Location: `localdb-tools/sync-tool/src/etc/localdbtools/default.yml` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: The configuration for synchronization tool. +- Page: [Synchronization Tool Config Sample](config/sync.md) +- Default Location: `localdb-tools/sync-tool/src/etc/localdbtools/default.yml` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ### [Archive Tool Config](config/archive.md) -- Description: The configuration for archive tool. -- Page: [Archive Tool Config Sample](config/archive.md) -- Default Location: - `localdb-tools/archive-tool/src/etc/localdbtools/archive.yml` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: The configuration for archive tool. +- Page: [Archive Tool Config Sample](config/archive.md) +- Default Location: + `localdb-tools/archive-tool/src/etc/localdbtools/archive.yml` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) diff --git a/docs/v1.6.x/config/archive.md b/docs/v1.6.x/config/archive.md index b34db6fe1..435848d14 100644 --- a/docs/v1.6.x/config/archive.md +++ b/docs/v1.6.x/config/archive.md @@ -14,11 +14,11 @@ n_archives: 2 #### Options -- `data_path`
_Default_ : /var/lib/mongo
Specifies path to MongoDB - database. +- `data_path`
_Default_ : /var/lib/mongo
Specifies path to MongoDB + database. -- `archive_path`
_Default_ : ./archive-mongo-data
Specifies path to put - archives (Recommendation: use external HDD/SSD) +- `archive_path`
_Default_ : ./archive-mongo-data
Specifies path to + put archives (Recommendation: use external HDD/SSD) -- `n_archive`
_Default_ : 2
Specifies the number of archives want to - keep (It depends on size of your disk storage) +- `n_archive`
_Default_ : 2
Specifies the number of archives want to + keep (It depends on size of your disk storage) diff --git a/docs/v1.6.x/config/chip.md b/docs/v1.6.x/config/chip.md index e922273f6..a463b215d 100644 --- a/docs/v1.6.x/config/chip.md +++ b/docs/v1.6.x/config/chip.md @@ -12,12 +12,12 @@ The chip configuration file uses the JSON format. ```json { - "FE-I4B": { - "Parameter": { - "chipId": 0 - }, - "name": "FEI4B-001" - } + "FE-I4B": { + "Parameter": { + "chipId": 0 + }, + "name": "FEI4B-001" + } } ``` @@ -25,19 +25,19 @@ The chip configuration file uses the JSON format. ```json { - "RD53A": { - "Parameter": { - "ChipId": 0, - "Name": "RD53A-001" + "RD53A": { + "Parameter": { + "ChipId": 0, + "Name": "RD53A-001" + } } - } } ``` #### Options -- `name`/`Name`
_Type_ : string
Specifies the name (serial number) of - the chip component. +- `name`/`Name`
_Type_ : string
Specifies the name (serial number) of + the chip component. -- `chipId`/`ChipId`
_Type_ : int
Specifies the geometrical ID determined - by wirebonding. +- `chipId`/`ChipId`
_Type_ : int
Specifies the geometrical ID + determined by wirebonding. diff --git a/docs/v1.6.x/config/component.md b/docs/v1.6.x/config/component.md index 0eb54590e..f0f3cc89c 100644 --- a/docs/v1.6.x/config/component.md +++ b/docs/v1.6.x/config/component.md @@ -11,14 +11,14 @@ The component configuration file uses the JSON format. ```json { - "chipType": "RD53A", - "chips": [ - { - "serialNumber": "RD53A-001", - "componentType": "Front-end Chip", - "chipId": 0 - } - ] + "chipType": "RD53A", + "chips": [ + { + "serialNumber": "RD53A-001", + "componentType": "Front-end Chip", + "chipId": 0 + } + ] } ``` @@ -26,33 +26,33 @@ The component configuration file uses the JSON format. ```json { - "module": { - "serialNumber": "RD53A-001", - "componentType": "Module" - }, - "chipType": "RD53A", - "chips": [ - { - "serialNumber": "RD53A-001-001", - "componentType": "Front-end Chip", - "chipId": 1 + "module": { + "serialNumber": "RD53A-001", + "componentType": "Module" }, - { - "serialNumber": "RD53A-001-002", - "componentType": "Front-end Chip", - "chipId": 2 - }, - { - "serialNumber": "RD53A-001-003", - "componentType": "Front-end Chip", - "chipId": 3 - }, - { - "serialNumber": "RD53A-001-004", - "componentType": "Front-end Chip", - "chipId": 4 - } - ] + "chipType": "RD53A", + "chips": [ + { + "serialNumber": "RD53A-001-001", + "componentType": "Front-end Chip", + "chipId": 1 + }, + { + "serialNumber": "RD53A-001-002", + "componentType": "Front-end Chip", + "chipId": 2 + }, + { + "serialNumber": "RD53A-001-003", + "componentType": "Front-end Chip", + "chipId": 3 + }, + { + "serialNumber": "RD53A-001-004", + "componentType": "Front-end Chip", + "chipId": 4 + } + ] } ``` @@ -60,19 +60,20 @@ The component configuration file uses the JSON format. ##### Core Options -- `chipType`
_Type_ : string
Specifies the chip type (e.g. FEI4B, RD53A) +- `chipType`
_Type_ : string
Specifies the chip type (e.g. FEI4B, + RD53A) -- `chips`
_Type_ : list
Specifies the chips to register. - - `serialNumber`
_Type_ : string
Specifies the serial number of the chip - component. - `chipId`/`ChipId`
_Type_ : int
Specifies the geometrical - ID determined by wirebonding. - `componentType`
_Type_ : string
If you - want to register the component with a component type other than "Front-end - Chip", you can specify it. +- `chips`
_Type_ : list
Specifies the chips to register. - + `serialNumber`
_Type_ : string
Specifies the serial number of the + chip component. - `chipId`/`ChipId`
_Type_ : int
Specifies the + geometrical ID determined by wirebonding. - `componentType`
_Type_ : + string
If you want to register the component with a component type other + than "Front-end Chip", you can specify it. ##### Additional Options -- `module`
_Type_ : dictionary
Specifies the module to register. - - `serialNumber`
_Type_ : string
Specifies the serial number of the - module component. - `componentType`
_Type_ : string
If you want to - register the component with a component type other than "module", you can - specify it.
+- `module`
_Type_ : dictionary
Specifies the module to register. - + `serialNumber`
_Type_ : string
Specifies the serial number of the + module component. - `componentType`
_Type_ : string
If you want to + register the component with a component type other than "module", you can + specify it.
diff --git a/docs/v1.6.x/config/connectivity.md b/docs/v1.6.x/config/connectivity.md index 7ef59e397..e70fdc005 100644 --- a/docs/v1.6.x/config/connectivity.md +++ b/docs/v1.6.x/config/connectivity.md @@ -11,14 +11,14 @@ The connectivity configuration file uses the JSON format. ```json { - "chipType": "RD53A", - "chips": [ - { - "config": "configs/RD53A-001.json", - "tx": 0, - "rx": 0 - } - ] + "chipType": "RD53A", + "chips": [ + { + "config": "configs/RD53A-001.json", + "tx": 0, + "rx": 0 + } + ] } ``` @@ -26,32 +26,32 @@ The connectivity configuration file uses the JSON format. ```json { - "module": { - "serialNumber": "RD53A-Quad" - }, - "chipType": "RD53A", - "chips": [ - { - "config": "configs/RD53A-001.json", - "tx": 0, - "rx": 0 + "module": { + "serialNumber": "RD53A-Quad" }, - { - "config": "configs/RD53A-002.json", - "tx": 0, - "rx": 1 - }, - { - "config": "configs/RD53A-003.json", - "tx": 0, - "rx": 2 - }, - { - "config": "configs/RD53A-004.json", - "tx": 0, - "rx": 3 - } - ] + "chipType": "RD53A", + "chips": [ + { + "config": "configs/RD53A-001.json", + "tx": 0, + "rx": 0 + }, + { + "config": "configs/RD53A-002.json", + "tx": 0, + "rx": 1 + }, + { + "config": "configs/RD53A-003.json", + "tx": 0, + "rx": 2 + }, + { + "config": "configs/RD53A-004.json", + "tx": 0, + "rx": 3 + } + ] } ``` @@ -59,32 +59,34 @@ The connectivity configuration file uses the JSON format. ##### Core Options -- `chipType`
_Type_ : string
Specifies the chip type (e.g. FEI4B, RD53A) +- `chipType`
_Type_ : string
Specifies the chip type (e.g. FEI4B, + RD53A) -- `chips`
_Type_ : list
Specifies the chips to test and upload.
You - can upload scan results linked to the chip data with the name written in the - [chip config file](chip.md) specified by the "config". - `config`
_Type_ : - string
Specifies the path to [chip config file](chip.md) - `tx`
_Type_ - : int
Specifies the TX channel. - `rx`
_Type_ : int
Specifies the - RX channel. +- `chips`
_Type_ : list
Specifies the chips to test and upload.
+ You can upload scan results linked to the chip data with the name written in + the [chip config file](chip.md) specified by the "config". - `config`
+ _Type_ : string
Specifies the path to [chip config file](chip.md) - + `tx`
_Type_ : int
Specifies the TX channel. - `rx`
_Type_ : + int
Specifies the RX channel. ##### Additional Options -- `module`
_Type_ : dictionary
Specifies the module to test and - upload.
If the module component data is registered in the Local DB, you - can upload scan results linked to the module data as well.
If not, the - scan results will only be linked to the chip data. - `serialNumber`
_Type_ - : string
Specifies the serial number of the module component.
- - `componentType`
_Type_ : string
If you register the component with a - component type other than "module" when registering it, you need to specify - it.
+- `module`
_Type_ : dictionary
Specifies the module to test and + upload.
If the module component data is registered in the Local DB, you + can upload scan results linked to the module data as well.
If not, the + scan results will only be linked to the chip data. - `serialNumber`
+ _Type_ : string
Specifies the serial number of the module + component.
- `componentType`
_Type_ : string
If you register the + component with a component type other than "module" when registering it, you + need to specify it.
-- `stage`
_Type_ : string
You can name the stage (type) of the scan by: +- `stage`
_Type_ : string
You can name the stage (type) of the scan + by: ```json { - "stage": "Testing", - "chipType": "RD53A" + "stage": "Testing", + "chipType": "RD53A" } ``` diff --git a/docs/v1.6.x/config/database.md b/docs/v1.6.x/config/database.md index 86e6c1d34..ab49af69f 100644 --- a/docs/v1.6.x/config/database.md +++ b/docs/v1.6.x/config/database.md @@ -9,23 +9,23 @@ Local DB configuration file uses the JSON format: ```json { - "hostIp": "127.0.0.1", - "hostPort": "27017", - "dbName": "localdb", - "auth": "default", - "KeyFile": "null", - "QC": false, - "environment": [ - "vddd_voltage", - "vddd_current", - "vdda_voltage", - "vdda_current", - "vddcom_voltage", - "vddcom_current", - "hv_voltage", - "hv_current", - "temperature" - ] + "hostIp": "127.0.0.1", + "hostPort": "27017", + "dbName": "localdb", + "auth": "default", + "KeyFile": "null", + "QC": false, + "environment": [ + "vddd_voltage", + "vddd_current", + "vdda_voltage", + "vdda_current", + "vddcom_voltage", + "vddcom_current", + "hv_voltage", + "hv_current", + "temperature" + ] } ``` @@ -33,65 +33,65 @@ Local DB configuration file uses the JSON format: ##### Core Options -- `hostIp`
_Type_ : string
_Default_ : "127.0.0.1"
Specifies the - name or IP address of the host machine where the Local DB is running. +- `hostIp`
_Type_ : string
_Default_ : "127.0.0.1"
Specifies the + name or IP address of the host machine where the Local DB is running. -- `hostPort`
_Type_ : string
_Default_ : "27017"
Specifies the port - number where the Local DB is listening. +- `hostPort`
_Type_ : string
_Default_ : "27017"
Specifies the + port number where the Local DB is listening. -- `dbName`
_Type_ : string
_Default_ : "localdb"
Specified the name - of the database registered as Local DB in MongoDB to connect to. +- `dbName`
_Type_ : string
_Default_ : "localdb"
Specified the + name of the database registered as Local DB in MongoDB to connect to. -- `auth`
_Type_ : string
_Default_ : "default"
Specifies the - authentication mode used in MongoDB.
If this is not specified, specifies - ["default" (SCRAM)](https://docs.mongodb.com/manual/core/security-scram/#authentication-scram), - the default authentication mechanism for MongoDB.
If you use - [x.509 certificate authentication](https://docs.mongodb.com/manual/core/security-x.509/#security-auth-x509) - you need to specify "x509" here. +- `auth`
_Type_ : string
_Default_ : "default"
Specifies the + authentication mode used in MongoDB.
If this is not specified, specifies + ["default" (SCRAM)](https://docs.mongodb.com/manual/core/security-scram/#authentication-scram), + the default authentication mechanism for MongoDB.
If you use + [x.509 certificate authentication](https://docs.mongodb.com/manual/core/security-x.509/#security-auth-x509) + you need to specify "x509" here. -- `QC`
_Type_ : boolean
_Default_ : False
If you want to upload data - for QC, you need to set **true** here.
+- `QC`
_Type_ : boolean
_Default_ : False
If you want to upload + data for QC, you need to set **true** here.
-- `Environment`
_Type_ : list
The DCS data with a key listed here can be - registered in Local DB.
If you want to register other DCS data, you need - to add key here. +- `Environment`
_Type_ : list
The DCS data with a key listed here can + be registered in Local DB.
If you want to register other DCS data, you + need to add key here. ##### SSL/TLS Options ```json { - "ssl": { - "enabled": false, - "PEMKeyFile": "path/to/mongodb.pem", - "CAFile": "path/to/ca.pem" - } + "ssl": { + "enabled": false, + "PEMKeyFile": "path/to/mongodb.pem", + "CAFile": "path/to/ca.pem" + } } ``` -- `ssl.enabled`
If Local DB server uses SSL connection, set **true** here. +- `ssl.enabled`
If Local DB server uses SSL connection, set **true** here. -- `ssl.PEMKeyFile`
Specifies the .pem file that contains both the SSL - certificate and key to present to the Local DB server. +- `ssl.PEMKeyFile`
Specifies the .pem file that contains both the SSL + certificate and key to present to the Local DB server. -- `ssl.CAFile`
Specifies the .pem file that contaibns the root certificate - chain from the Certificate Authority to validate the server certificate. +- `ssl.CAFile`
Specifies the .pem file that contaibns the root certificate + chain from the Certificate Authority to validate the server certificate. ##### TLS Options ```json { - "tls": { - "enabled": false, - "CertificateKeyFile": "path/to/mongodb.pem", - "CAFile": "path/to/ca.pem" - } + "tls": { + "enabled": false, + "CertificateKeyFile": "path/to/mongodb.pem", + "CAFile": "path/to/ca.pem" + } } ``` -- `tls.enabled`
If Local DB server uses TLS connection, set **true** here. +- `tls.enabled`
If Local DB server uses TLS connection, set **true** here. -- `tls.CertificateKeyFile`
Specifies the .pem file that contains both the - TLS certificate and key to present to the Local DB server. +- `tls.CertificateKeyFile`
Specifies the .pem file that contains both the + TLS certificate and key to present to the Local DB server. -- `tls.CAFile`
Specifies the .pem file that contaibns the root certificate - chain from the Certificate Authority to validate the server certificate. +- `tls.CAFile`
Specifies the .pem file that contaibns the root certificate + chain from the Certificate Authority to validate the server certificate. diff --git a/docs/v1.6.x/config/dcs-log.md b/docs/v1.6.x/config/dcs-log.md index 1925599dc..8d922724d 100644 --- a/docs/v1.6.x/config/dcs-log.md +++ b/docs/v1.6.x/config/dcs-log.md @@ -10,46 +10,46 @@ The log file (usually named "dbDcsLog.json") use the JSON format: ```json { - "dbCfg": { - "KeyFile": "null", - "auth": "default", - "dbName": "localdb", - "environment": [ - "vddd_voltage", - "vddd_current", - "vdda_voltage", - "vdda_current", - "vddcom_voltage", - "vddcom_current", - "hv_voltage", - "hv_current", - "temperature" + "dbCfg": { + "KeyFile": "null", + "auth": "default", + "dbName": "localdb", + "environment": [ + "vddd_voltage", + "vddd_current", + "vdda_voltage", + "vdda_current", + "vddcom_voltage", + "vddcom_current", + "hv_voltage", + "hv_current", + "temperature" + ], + "hostIp": "127.0.0.1", + "hostPort": "27017" + }, + "environments": [ + { + "chip": null, + "description": "Parent VDDD Voltage [V]", + "key": "vddd_voltage", + "num": 0, + "path": "/home/YARR/data/006233_std_digitalscan/vddd_voltage_0.dat", + "status": "enabled" + } ], - "hostIp": "127.0.0.1", - "hostPort": "27017" - }, - "environments": [ - { - "chip": null, - "description": "Parent VDDD Voltage [V]", - "key": "vddd_voltage", - "num": 0, - "path": "/home/YARR/data/006233_std_digitalscan/vddd_voltage_0.dat", - "status": "enabled" + "siteCfg": { + "code": "TITECH", + "institution": "Tokyo Institute of Technology" + }, + "startTime": 1598518435, + "timestamp": "2020-08-27_17:53:55", + "userCfg": { + "description": "viewer", + "institution": "CERN", + "userName": "Test User", + "viewerUser": "testuser" } - ], - "siteCfg": { - "code": "TITECH", - "institution": "Tokyo Institute of Technology" - }, - "startTime": 1598518435, - "timestamp": "2020-08-27_17:53:55", - "userCfg": { - "description": "viewer", - "institution": "CERN", - "userName": "Test User", - "viewerUser": "testuser" - } } ``` @@ -60,20 +60,20 @@ The log file (usually named "dbDcsLog.json") use the JSON format: yourself.
But if you want to change the log, you must rewrite it properly, being careful of mistakes and data loss. -- `timestamp`
_Type_ : string
Timestamp written in the format - "yyyy-MM-dd_HH:mm:ss" when the scan was executed. +- `timestamp`
_Type_ : string
Timestamp written in the format + "yyyy-MM-dd_HH:mm:ss" when the scan was executed. -- `startTime`
_Type_ : int
Timestamp written in the Unixtime when the - scan started. +- `startTime`
_Type_ : int
Timestamp written in the Unixtime when the + scan started. -- `dbCfg`
_Type_ : dictionary
The contents of the - [database config file](database.md). +- `dbCfg`
_Type_ : dictionary
The contents of the + [database config file](database.md). -- `userCfg`
_Type_ : dictionary
The contents of the - [user config file](user.md). +- `userCfg`
_Type_ : dictionary
The contents of the + [user config file](user.md). -- `siteCfg`
_Type_ : dictionary
The contents of the - [site config file](site.md). +- `siteCfg`
_Type_ : dictionary
The contents of the + [site config file](site.md). -- `environments`
_Type_ : list
The contents of the - [DCS config file](dcs.md). +- `environments`
_Type_ : list
The contents of the + [DCS config file](dcs.md). diff --git a/docs/v1.6.x/config/dcs.md b/docs/v1.6.x/config/dcs.md index d9c2d0cfd..9c1654b10 100644 --- a/docs/v1.6.x/config/dcs.md +++ b/docs/v1.6.x/config/dcs.md @@ -11,22 +11,22 @@ The DCS configuration file uses the JSON format: ```json { - "environments": [ - { - "description": "VDDD Voltage [V]", - "key": "vddd_voltage", - "num": 0, - "path": "dcs.dat", - "status": "enabled" - }, - { - "description": "VDDD Current [A]", - "key": "vddd_current", - "num": 0, - "path": "dcs.dat", - "status": "disabled" - } - ] + "environments": [ + { + "description": "VDDD Voltage [V]", + "key": "vddd_voltage", + "num": 0, + "path": "dcs.dat", + "status": "enabled" + }, + { + "description": "VDDD Current [A]", + "key": "vddd_current", + "num": 0, + "path": "dcs.dat", + "status": "disabled" + } + ] } ``` @@ -34,38 +34,39 @@ The DCS configuration file uses the JSON format: ##### Core Options -- `status`
_Type_ : string
Set enabled/disabled to upload the DCS data. +- `status`
_Type_ : string
Set enabled/disabled to upload the DCS + data. -- `key`
_Type_ : string
Specifies a DCS keyword to upload.
The - keyword must be written in the - ["environment" list in database config file](database.md), and the list can be - changed under the responsibility of the user. +- `key`
_Type_ : string
Specifies a DCS keyword to upload.
The + keyword must be written in the + ["environment" list in database config file](database.md), and the list can + be changed under the responsibility of the user. -- `num`
_Type_ : int
Specifies a DCS data number.
This number must - be unique among data with the same DCS keyword.
The combination of the DCS - keyword and this number are used to specify the DCS data in the provided - [DCS data file](#dcs-data-file). +- `num`
_Type_ : int
Specifies a DCS data number.
This number must + be unique among data with the same DCS keyword.
The combination of the + DCS keyword and this number are used to specify the DCS data in the provided + [DCS data file](#dcs-data-file). -- `description`
_Type_ : string
Adds a description of the DCS data.
- This description will be displayed on the viewer application and help us - undeerstand what this data is. +- `description`
_Type_ : string
Adds a description of the DCS + data.
This description will be displayed on the viewer application and + help us undeerstand what this data is. -- `path`
_Type_ : string
Specifies a path to - [DCS data file](#dcs-data-file). +- `path`
_Type_ : string
Specifies a path to + [DCS data file](#dcs-data-file). ##### Additional Options -- `value`
_Type_ : float
Specifies a single DCS value instead of - providing the DCS data file. +- `value`
_Type_ : float
Specifies a single DCS value instead of + providing the DCS data file. -- `mode`
_Type_ : string
Adds a description about a mode of DCS setting. - (e.g. CV) +- `mode`
_Type_ : string
Adds a description about a mode of DCS + setting. (e.g. CV) -- `setting`
_Type_ : float, string
Adds a DCS setting parameter. +- `setting`
_Type_ : float, string
Adds a DCS setting parameter. -- `chip`
_Type_ : string
Specifies the chip name related with DCS data - to link the data to the chip itself and upload it.
If not specified, DCS - data is uploaded associated with all chips tested in the scan. +- `chip`
_Type_ : string
Specifies the chip name related with DCS data + to link the data to the chip itself and upload it.
If not specified, DCS + data is uploaded associated with all chips tested in the scan. ### influxDB Config File @@ -75,23 +76,23 @@ The DCS configuration file for influxDB uses the JSON format: ```json { - "environments": [ - { - "measurement": "qaqcTest", - "dcsList": [ - { - "key": "vddd_voltage", - "data_name": "vdddVoltage", - "description": "the voltage" - }, + "environments": [ { - "key": "vddd_current", - "data_name": "vdddCurrent", - "description": "the current" + "measurement": "qaqcTest", + "dcsList": [ + { + "key": "vddd_voltage", + "data_name": "vdddVoltage", + "description": "the voltage" + }, + { + "key": "vddd_current", + "data_name": "vdddCurrent", + "description": "the current" + } + ] } - ] - } - ] + ] } ``` @@ -99,20 +100,20 @@ The DCS configuration file for influxDB uses the JSON format: ##### Core Options -- `measurement`
_Type_ : string
Set the measurement where the data is - stored in InfluxDB. +- `measurement`
_Type_ : string
Set the measurement where the data is + stored in InfluxDB. -- `key`
_Type_ : string
Specifies a DCS keyword to upload.
The - keyword must be written in the - ["environment" list in database config file](database.md), and the list can be - changed under the responsibility of the user. +- `key`
_Type_ : string
Specifies a DCS keyword to upload.
The + keyword must be written in the + ["environment" list in database config file](database.md), and the list can + be changed under the responsibility of the user. -- `data_name`
_Type_ : string
Specifies the title of the influxDB column - where to take the data from. +- `data_name`
_Type_ : string
Specifies the title of the influxDB + column where to take the data from. -- `description`
_Type_ : string
Adds a description of the DCS data.
- This description will be displayed on the viewer application and help us - undeerstand what this data is. +- `description`
_Type_ : string
Adds a description of the DCS + data.
This description will be displayed on the viewer application and + help us undeerstand what this data is. ### DCS Data File @@ -148,15 +149,15 @@ num,null,0,0,0,0, Separate each word with a space for DAT files and a comma for CSV files. -- the 1st line
_Value_ : DCS keyword
_DAT_ : - `key unixtime ...`
_CSV_ : - `key,unixtime,,,,...` +- the 1st line
_Value_ : DCS keyword
_DAT_ : + `key unixtime ...`
_CSV_ : + `key,unixtime,,,,...` -- the 2nd line
_Value_ : DCS number
_DAT_ : - `num null ...` _CSV_ : - `num,null,,,,...` +- the 2nd line
_Value_ : DCS number
_DAT_ : + `num null ...` _CSV_ : + `num,null,,,,...` -- After the 3rd line
_Value_ : datetime and DCS data (data value must be the - number of the value or "null" if no data)
_DAT_ : - `datetime unixtime ...`
_CSV_ : - `datetime,unixtime,,,,...` +- After the 3rd line
_Value_ : datetime and DCS data (data value must be + the number of the value or "null" if no data)
_DAT_ : + `datetime unixtime ...`
_CSV_ : + `datetime,unixtime,,,,...` diff --git a/docs/v1.6.x/config/sample.md b/docs/v1.6.x/config/sample.md index b7a7b2f20..4dc5256de 100644 --- a/docs/v1.6.x/config/sample.md +++ b/docs/v1.6.x/config/sample.md @@ -4,4 +4,4 @@ #### Options -- `option`
_Type_ :
_Default_ :
+- `option`
_Type_ :
_Default_ :
diff --git a/docs/v1.6.x/config/scan-log.md b/docs/v1.6.x/config/scan-log.md index 7c5b6065a..68e12df52 100644 --- a/docs/v1.6.x/config/scan-log.md +++ b/docs/v1.6.x/config/scan-log.md @@ -10,51 +10,51 @@ The log file (usually named "scanLog.json") use the JSON format: ```json { - "connectivity": [ - { - "chipType": "RD53A", - "chips": [ + "connectivity": [ { - "config": "configs/rd53a_test.json", - "enable": 1, - "locked": 0, - "rx": 0, - "tx": 0 + "chipType": "RD53A", + "chips": [ + { + "config": "configs/rd53a_test.json", + "enable": 1, + "locked": 0, + "rx": 0, + "tx": 0 + } + ] } - ] - } - ], - "ctrlCfg": { + ], "ctrlCfg": { - "cfg": { - "feCfg": "configs/emulator/emu_fe0_rd53a.json", - "rx": { - "id": 1338, - "size": 256 - }, - "tx": { - "id": 1337, - "size": 256 - }, - "type": "rd53a" - }, - "type": "emu_Rd53a" - } - }, - "exec": "-c configs/connectivity/example_rd53a_setup.json -s configs/scans/rd53a/std_digitalscan.json -r configs/controller/emuCfg_rd53a.json -W ", - "timestamp": "2020-08-24_10:46:37", - "startTime": 1598233597, - "finishTime": 1598233618, - "runNumber": 6189, - "stopwatch": { - "analysis": 644, - "config": 97, - "processing": 1, - "scan": 18401 - }, - "targetCharge": -1, - "targetTot": -1, - "testType": "std_digitalscan" + "ctrlCfg": { + "cfg": { + "feCfg": "configs/emulator/emu_fe0_rd53a.json", + "rx": { + "id": 1338, + "size": 256 + }, + "tx": { + "id": 1337, + "size": 256 + }, + "type": "rd53a" + }, + "type": "emu_Rd53a" + } + }, + "exec": "-c configs/connectivity/example_rd53a_setup.json -s configs/scans/rd53a/std_digitalscan.json -r configs/controller/emuCfg_rd53a.json -W ", + "timestamp": "2020-08-24_10:46:37", + "startTime": 1598233597, + "finishTime": 1598233618, + "runNumber": 6189, + "stopwatch": { + "analysis": 644, + "config": 97, + "processing": 1, + "scan": 18401 + }, + "targetCharge": -1, + "targetTot": -1, + "testType": "std_digitalscan" } ``` @@ -62,77 +62,77 @@ The log file (usually named "scanLog.json") use the JSON format: ```json { - "connectivity": [ - { - "chipType": "RD53A", - "chips": [ + "connectivity": [ { - "config": "configs/rd53a_test.json", - "enable": 1, - "locked": 0, - "rx": 0, - "tx": 0 + "chipType": "RD53A", + "chips": [ + { + "config": "configs/rd53a_test.json", + "enable": 1, + "locked": 0, + "rx": 0, + "tx": 0 + } + ] } - ] - } - ], - "ctrlCfg": { + ], "ctrlCfg": { - "cfg": { - "feCfg": "configs/emulator/emu_fe0_rd53a.json", - "rx": { - "id": 1338, - "size": 256 - }, - "tx": { - "id": 1337, - "size": 256 - }, - "type": "rd53a" - }, - "type": "emu_Rd53a" + "ctrlCfg": { + "cfg": { + "feCfg": "configs/emulator/emu_fe0_rd53a.json", + "rx": { + "id": 1338, + "size": 256 + }, + "tx": { + "id": 1337, + "size": 256 + }, + "type": "rd53a" + }, + "type": "emu_Rd53a" + } + }, + "exec": "-c configs/connectivity/example_rd53a_setup.json -s configs/scans/rd53a/std_digitalscan.json -r configs/controller/emuCfg_rd53a.json -W ", + "timestamp": "2020-08-24_10:46:37", + "startTime": 1598233597, + "finishTime": 1598233618, + "runNumber": 6189, + "stopwatch": { + "analysis": 644, + "config": 97, + "processing": 1, + "scan": 18401 + }, + "targetCharge": -1, + "targetTot": -1, + "testType": "std_digitalscan", + "dbCfg": { + "hostIp": "127.0.0.1", + "hostPort": "27017", + "dbName": "localdb", + "auth": "default", + "QC": false, + "environment": [ + "vddd_voltage", + "vddd_current", + "vdda_voltage", + "vdda_current", + "vddcom_voltage", + "vddcom_current", + "hv_voltage", + "hv_current", + "temperature" + ] + }, + "userCfg": { + "userName": "John Doe", + "institution": "ABC Laboratory", + "description": "default" + }, + "siteCfg": { + "institution": "ABC Laboratory" } - }, - "exec": "-c configs/connectivity/example_rd53a_setup.json -s configs/scans/rd53a/std_digitalscan.json -r configs/controller/emuCfg_rd53a.json -W ", - "timestamp": "2020-08-24_10:46:37", - "startTime": 1598233597, - "finishTime": 1598233618, - "runNumber": 6189, - "stopwatch": { - "analysis": 644, - "config": 97, - "processing": 1, - "scan": 18401 - }, - "targetCharge": -1, - "targetTot": -1, - "testType": "std_digitalscan", - "dbCfg": { - "hostIp": "127.0.0.1", - "hostPort": "27017", - "dbName": "localdb", - "auth": "default", - "QC": false, - "environment": [ - "vddd_voltage", - "vddd_current", - "vdda_voltage", - "vdda_current", - "vddcom_voltage", - "vddcom_current", - "hv_voltage", - "hv_current", - "temperature" - ] - }, - "userCfg": { - "userName": "John Doe", - "institution": "ABC Laboratory", - "description": "default" - }, - "siteCfg": { - "institution": "ABC Laboratory" - } } ``` @@ -145,42 +145,43 @@ The log file (usually named "scanLog.json") use the JSON format: rewrite it yourself.
But if you want to change the log, you must rewrite it properly, being careful of mistakes and data loss. -- `connectivity`
_Type_ : dictionary
The contents of the - [connectivity config file](connectivity.md) loaded during the scan. +- `connectivity`
_Type_ : dictionary
The contents of the + [connectivity config file](connectivity.md) loaded during the scan. -- `ctrlCfg`
_Type_ : dictionary
The contents of the controller config - file loaded during the scan. +- `ctrlCfg`
_Type_ : dictionary
The contents of the controller config + file loaded during the scan. -- `exec`
_Type_ : string
The command entered when the scan was executed. +- `exec`
_Type_ : string
The command entered when the scan was + executed. -- `timestamp`
_Type_ : string
Timestamp written in the format - "yyyy-MM-dd_HH:mm:ss" when the scan was executed. +- `timestamp`
_Type_ : string
Timestamp written in the format + "yyyy-MM-dd_HH:mm:ss" when the scan was executed. -- `startTime`
_Type_ : int
Timestamp written in the Unixtime when the - scan started. +- `startTime`
_Type_ : int
Timestamp written in the Unixtime when the + scan started. -- `finishtTime`
_Type_ : int
Timestamp written in the Unixtime when the - scan finished. +- `finishtTime`
_Type_ : int
Timestamp written in the Unixtime when + the scan finished. -- `runNumber`
_Type_ : int
The local run number. +- `runNumber`
_Type_ : int
The local run number. -- `stopwatch`
_Type_ : dictionary
Statistics of the process time during - the scan. +- `stopwatch`
_Type_ : dictionary
Statistics of the process time + during the scan. -- `targetCharge`
_Type_ : int
Target charge for tuning scan. +- `targetCharge`
_Type_ : int
Target charge for tuning scan. -- `targetTot`
_Type_ : int
Target charge for tuning scan. +- `targetTot`
_Type_ : int
Target charge for tuning scan. -- `testType`
_Type_ : string
The name of the scan executed. +- `testType`
_Type_ : string
The name of the scan executed. -- `dbCfg`
_Type_ : dictionary
The contents of the - [database config file](database.md) loaded during the scan with the option - -W.
If -W is not specified in the scan, this field should be empty. +- `dbCfg`
_Type_ : dictionary
The contents of the + [database config file](database.md) loaded during the scan with the option + -W.
If -W is not specified in the scan, this field should be empty. -- `userCfg`
_Type_ : dictionary
The contents of the - [user config file](user.md) loaded during the scan with the option -W.
If - -W is not specified in the scan, this field should be empty. +- `userCfg`
_Type_ : dictionary
The contents of the + [user config file](user.md) loaded during the scan with the option -W.
+ If -W is not specified in the scan, this field should be empty. -- `siteCfg`
_Type_ : dictionary
The contents of the - [site config file](site.md) loaded during the scan with the option -W.
If - -W is not specified in the scan, this field should be empty. +- `siteCfg`
_Type_ : dictionary
The contents of the + [site config file](site.md) loaded during the scan with the option -W.
+ If -W is not specified in the scan, this field should be empty. diff --git a/docs/v1.6.x/config/site.md b/docs/v1.6.x/config/site.md index c56b3e916..d26183e5a 100644 --- a/docs/v1.6.x/config/site.md +++ b/docs/v1.6.x/config/site.md @@ -9,7 +9,7 @@ Site configuration file uses the JSON format: ```json { - "institution": "PRODUCTION SITE" + "institution": "PRODUCTION SITE" } ``` @@ -18,15 +18,15 @@ using "code": ```json { - "code": "INSTITUTION CODE" + "code": "INSTITUTION CODE" } ``` #### Options -- `institution`
_Type_ : string
_Default_ : HOSTNAME (an environmental - variable on UNIX system specifying the hostname)
Specifies the name of the - production site or institution. (e.g. "ABC Laboratory") +- `institution`
_Type_ : string
_Default_ : HOSTNAME (an environmental + variable on UNIX system specifying the hostname)
Specifies the name of + the production site or institution. (e.g. "ABC Laboratory") -- `code`
_Type_ : string
Specifies the institution code defined in ITk - PD. +- `code`
_Type_ : string
Specifies the institution code defined in ITk + PD. diff --git a/docs/v1.6.x/config/sync.md b/docs/v1.6.x/config/sync.md index 1d11cc080..589d765b4 100644 --- a/docs/v1.6.x/config/sync.md +++ b/docs/v1.6.x/config/sync.md @@ -9,15 +9,15 @@ Sync Tool configuration file uses the YAML format: ```yml local: - host: 127.0.0.1 - port: 27017 - #username: username - #password: ihatepassword + host: 127.0.0.1 + port: 27017 + #username: username + #password: ihatepassword master: - host: master-host - port: 27017 - #username: username - #password: ihatepassword + host: master-host + port: 27017 + #username: username + #password: ihatepassword #logfile: logs/production.log ``` @@ -27,34 +27,34 @@ master: ```yml local: - host: 127.0.0.1 - port: 27017 - #username: username - #password: ihatepassword + host: 127.0.0.1 + port: 27017 + #username: username + #password: ihatepassword ``` Specifies the configuration of the local MongoDB server. -- `local.host`
_Default_ : 127.0.0.1
Specifies IP address of the host - machine where MongoDB is running. +- `local.host`
_Default_ : 127.0.0.1
Specifies IP address of the host + machine where MongoDB is running. -- `local.port`
_Default_ : 27017
Specifies the port number where the - MongoDB is listhening. +- `local.port`
_Default_ : 27017
Specifies the port number where the + MongoDB is listhening. -- `local.username`
Specifies username of user account in MongoDB if the user - authentication is required. +- `local.username`
Specifies username of user account in MongoDB if the + user authentication is required. -- `local.password`
Specifies password of user account in MongoDB if the user - authentication is required. +- `local.password`
Specifies password of user account in MongoDB if the + user authentication is required. ##### master Options ```yml master: - host: master-host - port: 27017 - #username: username - #password: ihatepassword + host: master-host + port: 27017 + #username: username + #password: ihatepassword ``` Specifies the configuration of the master MongoDB server.
Please ask to the @@ -63,4 +63,4 @@ MongoDB. ##### log Option -- `logfile`
_Default_ : ./log
Specifies path to log output file. +- `logfile`
_Default_ : ./log
Specifies path to log output file. diff --git a/docs/v1.6.x/config/user.md b/docs/v1.6.x/config/user.md index 0403bd86c..c80b51d6d 100644 --- a/docs/v1.6.x/config/user.md +++ b/docs/v1.6.x/config/user.md @@ -9,9 +9,9 @@ User configuration file uses the JSON format: ```json { - "userName": "FIRSTNAME LASTNAME", - "institution": "YOUR INSTITUTION", - "description": "default" + "userName": "FIRSTNAME LASTNAME", + "institution": "YOUR INSTITUTION", + "description": "default" } ``` @@ -20,23 +20,24 @@ using "viewerUser": ```json { - "viewerUser": "username" + "viewerUser": "username" } ``` #### Options -- `userName`
_Type_ : string
_Default_ : USER (an environmental variable - on UNIX system specifying your user account)
Specifies your name (e.g. - "John Doe"). +- `userName`
_Type_ : string
_Default_ : USER (an environmental + variable on UNIX system specifying your user account)
Specifies your + name (e.g. "John Doe"). -- `institution`
_Type_ : string
_Default_ : HOSTNAME (an environmental - variable on UNIX system specifying the hostname)
Specifies the name of the - institution you belong to. (e.g. "ABC Laboratory") +- `institution`
_Type_ : string
_Default_ : HOSTNAME (an environmental + variable on UNIX system specifying the hostname)
Specifies the name of + the institution you belong to. (e.g. "ABC Laboratory") -- `description`
_Type_ : string
_Default_ : "default"
Add - descriptions for the user account (e.g. "account for testbeam")
If this is - not specified, specifies "default", or "viewer" if "viewerUser" is specified. +- `description`
_Type_ : string
_Default_ : "default"
Add + descriptions for the user account (e.g. "account for testbeam")
If this + is not specified, specifies "default", or "viewer" if "viewerUser" is + specified. -- `viewerUser`
_Type_ : string
Specifies the name of your user account - in Local DB Viewer. +- `viewerUser`
_Type_ : string
Specifies the name of your user account + in Local DB Viewer. diff --git a/docs/v1.6.x/config/viewer.md b/docs/v1.6.x/config/viewer.md index 43f69d3f0..d862f8ab9 100644 --- a/docs/v1.6.x/config/viewer.md +++ b/docs/v1.6.x/config/viewer.md @@ -11,29 +11,29 @@ Viewer configuration file uses the YAML format: ```yml mongoDB: - host: 127.0.0.1 # IP address running mongoDB - port: 27017 # port number running mongoDB - db: localdb # local database name + host: 127.0.0.1 # IP address running mongoDB + port: 27017 # port number running mongoDB + db: localdb # local database name userDB: - db: localdbtools + db: localdbtools flask: - host: 127.0.0.1 # IP address running app.py - port: 5000 # port number running app.py + host: 127.0.0.1 # IP address running app.py + port: 5000 # port number running app.py ``` ##### Admin File Format ```yml mongoDB: - host: 127.0.0.1 # IP address running mongoDB - port: 27017 # port number running mongoDB - db: localdb # local database name - KeyFile: path/to/user/key/file + host: 127.0.0.1 # IP address running mongoDB + port: 27017 # port number running mongoDB + db: localdb # local database name + KeyFile: path/to/user/key/file userDB: - db: localdbtools + db: localdbtools flask: - host: 127.0.0.1 # IP address running app.py - port: 5000 # port number running app.py + host: 127.0.0.1 # IP address running app.py + port: 5000 # port number running app.py ``` #### Options @@ -42,96 +42,96 @@ flask: ```yml mongoDB: - host: 127.0.0.1 - port: 27017 - db: localdb - username: username - password: password - KeyFile: path/to/user/key/file - auth: SCRAM - ssl: - enabled: False - CAFile: path/to/CA/file - PEMKeyFile: path/to/certificate/file - tls: - enabled: False - CAFile: path/to/CA/file - CertificateFile: path/to/certificate/file + host: 127.0.0.1 + port: 27017 + db: localdb + username: username + password: password + KeyFile: path/to/user/key/file + auth: SCRAM + ssl: + enabled: False + CAFile: path/to/CA/file + PEMKeyFile: path/to/certificate/file + tls: + enabled: False + CAFile: path/to/CA/file + CertificateFile: path/to/certificate/file ``` Specifies the configuration of Local DB server in the mongoDB option. -- `mongoDB.host`
_Default_ : localhost
Specifies IP address of the host - machine where the Local DB is running. +- `mongoDB.host`
_Default_ : localhost
Specifies IP address of the + host machine where the Local DB is running. -- `mongoDB.port`
_Default_ : 27017
Specifies the port number where the - Local DB is listening. +- `mongoDB.port`
_Default_ : 27017
Specifies the port number where the + Local DB is listening. -- `mongoDB.db`
_Default_ : localdb Specifies the name of the database - registered as Local DB in MongoDB to connect to. +- `mongoDB.db`
_Default_ : localdb Specifies the name of the database + registered as Local DB in MongoDB to connect to. -- `mongoDB.username`
Specifies the username of the user account registered - in Local DB by - [localdb-tools/setting/create_admin.sh](../script/create_admin.md) if the user - authentication is required. +- `mongoDB.username`
Specifies the username of the user account registered + in Local DB by + [localdb-tools/setting/create_admin.sh](../script/create_admin.md) if the + user authentication is required. -- `mongoDB.password`
Specifies the password of the user account registered - in Local DB by - [localdb-tools/setting/create_admin.sh](../script/create_admin.md) if the user - authentication is required. +- `mongoDB.password`
Specifies the password of the user account registered + in Local DB by + [localdb-tools/setting/create_admin.sh](../script/create_admin.md) if the + user authentication is required. -- `mongoDB.KeyFile`
Specifies the path to the key file which has username - and password information of the user account created by - [localdb-tools/setting/create_admin.sh](../script/create_admin.md).
The - key file can be generated by running - [localdb-tools/viewer/setup_viewer.sh](../script/setup-viewer.md) and enabling - admin functions. +- `mongoDB.KeyFile`
Specifies the path to the key file which has username + and password information of the user account created by + [localdb-tools/setting/create_admin.sh](../script/create_admin.md).
The + key file can be generated by running + [localdb-tools/viewer/setup_viewer.sh](../script/setup-viewer.md) and + enabling admin functions. -- `mongoDB.auth`
Specifies the authentication mechanism configured in Local - DB.
+- `mongoDB.auth`
Specifies the authentication mechanism configured in + Local DB.
-- `mongoDB.ssl.enabled` `mongoDB.ssl.CAFile` `mongoDB.ssl.PEMKeyFile`
If - Local DB server uses SSL connection, specifies the SSL certificate file to - present to Local DB server and the SSL CA file to verify the certificate - presented by Local DB server. +- `mongoDB.ssl.enabled` `mongoDB.ssl.CAFile` `mongoDB.ssl.PEMKeyFile`
If + Local DB server uses SSL connection, specifies the SSL certificate file to + present to Local DB server and the SSL CA file to verify the certificate + presented by Local DB server. -- `mongoDB.tls.enabled` `mongoDB.tls.CAFile` `mongoDB.tls.PEMKeyFile`
If - Local DB server uses TLS connection, specifies the TLS certificate file to - present to Local DB server and the TLS CA file to verify the certificate - presented by Local DB server. +- `mongoDB.tls.enabled` `mongoDB.tls.CAFile` `mongoDB.tls.PEMKeyFile`
If + Local DB server uses TLS connection, specifies the TLS certificate file to + present to Local DB server and the TLS CA file to verify the certificate + presented by Local DB server. ##### User DB Options ```yml userDB: - db: localdbtools + db: localdbtools ``` Specifies the configuration of Local User DB server in the userDB option. -- `userDB.db`
_Default_ : localdbtoolso Specifies the name of the database - registered as Local User DB in MongoDB to connect to. +- `userDB.db`
_Default_ : localdbtoolso Specifies the name of the database + registered as Local User DB in MongoDB to connect to. ##### Flask Options ```yml flask: - host: 127.0.0.1 - port: 5000 - cert: path/to/cert.pem - key: path/to/key.pem + host: 127.0.0.1 + port: 5000 + cert: path/to/cert.pem + key: path/to/key.pem ``` Specifies the configuration of the web viewer server in the flask option. -- `flask.host`
_Default_ : localhost
Specifies IP address of the host - machine to run the viewer application. +- `flask.host`
_Default_ : localhost
Specifies IP address of the host + machine to run the viewer application. -- `flask.port`
_Default_ : 5000 Specifies the port number where the viewer - application listens. +- `flask.port`
_Default_ : 5000 Specifies the port number where the viewer + application listens. -- `flask.cert`
Specifies the certificate file for enabling HTTPS in the - viewer application. +- `flask.cert`
Specifies the certificate file for enabling HTTPS in the + viewer application. -- `flask.pem`
Specifies the private key file for enabling HTTPS in the - viewer application. +- `flask.pem`
Specifies the private key file for enabling HTTPS in the + viewer application. diff --git a/docs/v1.6.x/dev/Automatic-Installetion.md b/docs/v1.6.x/dev/Automatic-Installetion.md index ddea97907..114e58bd7 100644 --- a/docs/v1.6.x/dev/Automatic-Installetion.md +++ b/docs/v1.6.x/dev/Automatic-Installetion.md @@ -4,117 +4,117 @@ automatically using the installation. ## Contents -- [Pre Requirements](#Pre-Requirements) -- [Libraries Installation](#Libraries-Installation) - - [For DB Server](#For-DB-Server) - - [For DAQ Server](#For-DAQ-Server) +- [Pre Requirements](#Pre-Requirements) +- [Libraries Installation](#Libraries-Installation) + - [For DB Server](#For-DB-Server) + - [For DAQ Server](#For-DAQ-Server) # Pre Requirements -- centOS7 -- sudo user account (for installation) -- git +- centOS7 +- sudo user account (for installation) +- git - ```bash - $ sudo yum install git - ``` + ```bash + $ sudo yum install git + ``` # Libraries Installation ## For DB Server -- Installer: `localDB-tools/setting/db_server_install.sh` - - **requirement: sudo user account** - - **This installer should be run once for setting the - machine.**
**After the second run, the - missing one will be installed with avoiding duplicate - installation.**
**But Local DB will be - initialized.** - - - Install libraries - - Open firewall port (http, 27017/tcp) - - Start Apache service - - Initialize Local DB - - Start MongoDB service - - ```bash - $ git clone https://github.com/jlab-hep/localDB-tools.git - $ git checkout devel - $ cd localDB-tools/setting - $ ./db_server_install.sh - [LDB] This script performs ... - - [LDB] - Install yum packages: '~/localDB-tools/setting/requirements-yum.txt' - [LDB] $ sudo yum install $(cat ~/localDB-tools/setting/requirements-yum.txt) - [LDB] - Install pip modules: '~/localDB-tools/setting/requirements-pip.txt' - [LDB] $ sudo pip3 install $(cat ~/localDB-tools/setting/requirements-pip.txt) - [LDB] - Start Apache Service: - [LDB] $ sudo /usr/sbin/setsebool -P httpd_can_network_connect 1 - [LDB] $ sudo firewall-cmd --add-service=http --permanent - [LDB] $ sudo firewall-cmd --reload - [LDB] $ sudo systemctl start httpd - [LDB] - Initialize Local DB Server: - [LDB] IP address: XXX.XXX.XX.XX - [LDB] port : 27017 - [LDB] Backup data in Local DB ('/var/lib/mongo') into '/var/lib/mongo-190726.tar.gz' - [LDB] Reset data in Local DB - [LDB] - Start MongoDB Service: - [LDB] $ sudo firewall-cmd --zone=public --add-port=27017/tcp --permanent - [LDB] $ sudo firewall-cmd --reload - [LDB] $ sudo systemctl start mongod - [LDB] $ sudo systemctl enable mongod - - [LDB] Continue? [y/n] - > y - # answer here after confirmation - - [sudo] password: - [LDB] OK! - - [2019-07-26 07:05:37] [LDB] Done. - ``` - - Logfile: `localDB-tools/setting/instlog/${datetime}` README: - `localDB-tools/setting/README +- Installer: `localDB-tools/setting/db_server_install.sh` + + **requirement: sudo user account** + + **This installer should be run once for setting the + machine.**
**After the second run, the + missing one will be installed with avoiding duplicate + installation.**
**But Local DB will be + initialized.** + + - Install libraries + - Open firewall port (http, 27017/tcp) + - Start Apache service + - Initialize Local DB + - Start MongoDB service + + ```bash + $ git clone https://github.com/jlab-hep/localDB-tools.git + $ git checkout devel + $ cd localDB-tools/setting + $ ./db_server_install.sh + [LDB] This script performs ... + + [LDB] - Install yum packages: '~/localDB-tools/setting/requirements-yum.txt' + [LDB] $ sudo yum install $(cat ~/localDB-tools/setting/requirements-yum.txt) + [LDB] - Install pip modules: '~/localDB-tools/setting/requirements-pip.txt' + [LDB] $ sudo pip3 install $(cat ~/localDB-tools/setting/requirements-pip.txt) + [LDB] - Start Apache Service: + [LDB] $ sudo /usr/sbin/setsebool -P httpd_can_network_connect 1 + [LDB] $ sudo firewall-cmd --add-service=http --permanent + [LDB] $ sudo firewall-cmd --reload + [LDB] $ sudo systemctl start httpd + [LDB] - Initialize Local DB Server: + [LDB] IP address: XXX.XXX.XX.XX + [LDB] port : 27017 + [LDB] Backup data in Local DB ('/var/lib/mongo') into '/var/lib/mongo-190726.tar.gz' + [LDB] Reset data in Local DB + [LDB] - Start MongoDB Service: + [LDB] $ sudo firewall-cmd --zone=public --add-port=27017/tcp --permanent + [LDB] $ sudo firewall-cmd --reload + [LDB] $ sudo systemctl start mongod + [LDB] $ sudo systemctl enable mongod + + [LDB] Continue? [y/n] + > y + # answer here after confirmation + + [sudo] password: + [LDB] OK! + + [2019-07-26 07:05:37] [LDB] Done. + ``` + + Logfile: `localDB-tools/setting/instlog/${datetime}` README: + `localDB-tools/setting/README Next step: [Setup Viewer Application](https://github.com/jlab-hep/Yarr/wiki/Setup-Viewer-Application) ## For DAQ Server -- Installer: `YARR/localdb/db_yarr_install.sh` +- Installer: `YARR/localdb/db_yarr_install.sh` - **requirement: sudo user account** + **requirement: sudo user account** - **This installer should be run once for setting the - machine.**
**After the second run, the - missing one is installed with avoiding duplicate installation.** + **This installer should be run once for setting the + machine.**
**After the second run, the + missing one is installed with avoiding duplicate installation.** - - install libraries + - install libraries - ```bash - $ git clone https://gitlab.cern.ch/YARR/YARR.git - $ cd YARR - $ git checkout devel - $ cd localdb - $ ./db_yarr_install.sh - [LDB] This script performs ... + ```bash + $ git clone https://gitlab.cern.ch/YARR/YARR.git + $ cd YARR + $ git checkout devel + $ cd localdb + $ ./db_yarr_install.sh + [LDB] This script performs ... - [LDB] - Install yum packages: '~/YARR/localdb/setting/requirements-yum.txt' - [LDB] $ sudo yum install $(cat ~/YARR/localdb/setting/requirements-yum.txt) - [LDB] - Install pip modules: '~/YARR/localdb/setting/requirements-pip.txt' - [LDB] $ sudo pip3 install $(cat ~/YARR/localdb/setting/requirements-pip.txt) - [LDB] Continue? [y/n] - > y + [LDB] - Install yum packages: '~/YARR/localdb/setting/requirements-yum.txt' + [LDB] $ sudo yum install $(cat ~/YARR/localdb/setting/requirements-yum.txt) + [LDB] - Install pip modules: '~/YARR/localdb/setting/requirements-pip.txt' + [LDB] $ sudo pip3 install $(cat ~/YARR/localdb/setting/requirements-pip.txt) + [LDB] Continue? [y/n] + > y - [sudo] password: - [LDB] OK! - ``` + [sudo] password: + [LDB] OK! + ``` - Logfile: `YARR/localdb/setting/instlog/${datetime}` README: - `YARR/localdb/setting/README + Logfile: `YARR/localdb/setting/instlog/${datetime}` README: + `YARR/localdb/setting/README Next step: [Setup DAQ Server](https://github.com/jlab-hep/Yarr/wiki/Setup-DAQ-Server) diff --git a/docs/v1.6.x/dev/Build-a-Master-Server.md b/docs/v1.6.x/dev/Build-a-Master-Server.md index 3a127eb90..3084c2c9b 100644 --- a/docs/v1.6.x/dev/Build-a-Master-Server.md +++ b/docs/v1.6.x/dev/Build-a-Master-Server.md @@ -46,7 +46,7 @@ db.createUser( ### Create a normal user -- Read and Write privilege +- Read and Write privilege ``` use localdb @@ -59,7 +59,7 @@ db.createUser( ) ``` -- Read only privilege +- Read only privilege ``` use localdb @@ -283,6 +283,6 @@ mongo \ References. -- [Secure your MongoDB connections - SSL/TLS](https://medium.com/@rajanmaharjan/secure-your-mongodb-connections-ssl-tls-92e2addb3c89) -- [Using Encryption and Authentication to Secure MongoDB](https://www.codeproject.com/Articles/1227164/Using-Encryption-and-Authentication-to-Secure-Mong) -- [Use x.509 Certificates to Authenticate Clients](https://docs.mongodb.com/manual/tutorial/configure-x509-client-authentication/) +- [Secure your MongoDB connections - SSL/TLS](https://medium.com/@rajanmaharjan/secure-your-mongodb-connections-ssl-tls-92e2addb3c89) +- [Using Encryption and Authentication to Secure MongoDB](https://www.codeproject.com/Articles/1227164/Using-Encryption-and-Authentication-to-Secure-Mong) +- [Use x.509 Certificates to Authenticate Clients](https://docs.mongodb.com/manual/tutorial/configure-x509-client-authentication/) diff --git a/docs/v1.6.x/dev/FAQ.md b/docs/v1.6.x/dev/FAQ.md index 6f228709e..fac78dbcb 100644 --- a/docs/v1.6.x/dev/FAQ.md +++ b/docs/v1.6.x/dev/FAQ.md @@ -4,51 +4,51 @@ 1. Check if PyROOT is available - ```bash - $ for ii in 1 2 3 4; \ - do if pydoc3 modules | \ - cut -d " " -f ${ii} | \ - grep -x ROOT > /dev/null; \ - then echo "PyROOT is available"; \ - fi; \ - done - - PyROOT is available # Available - "No message" # Not available - ``` + ```bash + $ for ii in 1 2 3 4; \ + do if pydoc3 modules | \ + cut -d " " -f ${ii} | \ + grep -x ROOT > /dev/null; \ + then echo "PyROOT is available"; \ + fi; \ + done + + PyROOT is available # Available + "No message" # Not available + ``` 2. Install ROOT software which can use PyROOT by Python3 - ```bash - $ root_install_dir=`pwd` - $ wget https://root.cern.ch/download/root_v6.16.00.source.tar.gz - $ tar zxf root_v6.16.00.source.tar.gz - $ rm -f root_v6.16.00.source.tar.gz - $ mv root-6.16.00 6.16.00 - $ mkdir 6.16.00-build - $ cd 6.16.00-build - $ cmake \ - -DCMAKE_INSTALL_PREFIX=${root_install_dir}/6.16.00-install \ - -DPYTHON_EXECUTABLE=/usr/bin/python36 \ - ../6.16.00 - $ cmake --build . -- -j4 - $ make install - ``` + ```bash + $ root_install_dir=`pwd` + $ wget https://root.cern.ch/download/root_v6.16.00.source.tar.gz + $ tar zxf root_v6.16.00.source.tar.gz + $ rm -f root_v6.16.00.source.tar.gz + $ mv root-6.16.00 6.16.00 + $ mkdir 6.16.00-build + $ cd 6.16.00-build + $ cmake \ + -DCMAKE_INSTALL_PREFIX=${root_install_dir}/6.16.00-install \ + -DPYTHON_EXECUTABLE=/usr/bin/python36 \ + ../6.16.00 + $ cmake --build . -- -j4 + $ make install + ``` 3. Confirm if the installation was successful - ```bash - $ source ${root_install_dir}/6.16.00-build/bin/thisroot.sh - $ for ii in 1 2 3 4; \ - do if pydoc3 modules | \ - cut -d " " -f${ii} | \ - grep -x ROOT > /dev/null; \ - then echo "PyROOT is available"; \ - fi; \ - done + ```bash + $ source ${root_install_dir}/6.16.00-build/bin/thisroot.sh + $ for ii in 1 2 3 4; \ + do if pydoc3 modules | \ + cut -d " " -f${ii} | \ + grep -x ROOT > /dev/null; \ + then echo "PyROOT is available"; \ + fi; \ + done - PyROOT is available - ``` + PyROOT is available + ``` @@ -58,41 +58,41 @@ 1. Confirm config file - Add bindIp (default: '127.0.0.1') in MongoDB config file `/etc/mongod.conf`: + Add bindIp (default: '127.0.0.1') in MongoDB config file `/etc/mongod.conf`: - ```yaml - # mongod.conf - # network interfaces - net: - bindIp: 127.0.0.1 # " or " - # Listen to local interface only, comment to listen on all interfaces. - port: 27017 - ``` + ```yaml + # mongod.conf + # network interfaces + net: + bindIp: 127.0.0.1 # " or " + # Listen to local interface only, comment to listen on all interfaces. + port: 27017 + ``` - And start MongoDB service and confirm it works. + And start MongoDB service and confirm it works. - ```bash - $ sudo systemctl restart mongod.service - ``` + ```bash + $ sudo systemctl restart mongod.service + ``` 2. Open port - ```bash - $ sudo firewall-cmd --zone=public --add-port=27017/tcp --permanent - $ sudo firewall-cmd --reload - ``` + ```bash + $ sudo firewall-cmd --zone=public --add-port=27017/tcp --permanent + $ sudo firewall-cmd --reload + ``` 3. Confirm if the setting was successful - Access `$ mongo --host "HOST IP ADDRESS"` from another machine. + Access `$ mongo --host "HOST IP ADDRESS"` from another machine. - ```bash - $ mongo -host "HOST IP ADDRESS" - MongoDB shell version v3.6.8 - connecting to: mongodb://"HOST IP ADDRESS":27017 - MongoDB server version: 3.6.8 - Server has startup warnings: - ``` + ```bash + $ mongo -host "HOST IP ADDRESS" + MongoDB shell version v3.6.8 + connecting to: mongodb://"HOST IP ADDRESS":27017 + MongoDB server version: 3.6.8 + Server has startup warnings: + ``` @@ -102,35 +102,35 @@ 1. Install libraries - ```bash - $ sudo yum install -y httpd.x86_64 - ``` + ```bash + $ sudo yum install -y httpd.x86_64 + ``` 2. Setup http protocol - ```bash - $ sudo /usr/sbin/setsebool -P httpd_can_network_connect 1 - $ cp ${db_tools_dir}/scripts/apache/config.conf /etc/httpd/conf.d/localDB-tools.conf - ``` + ```bash + $ sudo /usr/sbin/setsebool -P httpd_can_network_connect 1 + $ cp ${db_tools_dir}/scripts/apache/config.conf /etc/httpd/conf.d/localDB-tools.conf + ``` 3. Open port - ```bash - $ sudo firewall-cmd --add-service=http --permanent - $ sudo firewall-cmd --reload - ``` + ```bash + $ sudo firewall-cmd --add-service=http --permanent + $ sudo firewall-cmd --reload + ``` 4. Start service - ```bash - $ sudo systemctl start httpd - $ sudo systemctl enable httpd - ``` + ```bash + $ sudo systemctl start httpd + $ sudo systemctl enable httpd + ``` 5. Confirm if the setting was successful - Access "http://:5000/" and Local DB Viewer page should be - displayed on browser from another machine. + Access "http://:5000/" and Local DB Viewer page should be + displayed on browser from another machine. @@ -140,82 +140,82 @@ 1. Uncompleted the setup of Local DB Server - You can check is as following: + You can check is as following: - ```bash - $ mongo - # i. MongoDB not installed - bash: mongo: command not found + ```bash + $ mongo + # i. MongoDB not installed + bash: mongo: command not found - # ii. MongoDB not started - - exception: connect failed - ``` + # ii. MongoDB not started + + exception: connect failed + ``` - 1. MongoDB not installed + 1. MongoDB not installed - You can setup Local DB Server automatically by the script: + You can setup Local DB Server automatically by the script: - ```bash - $ git clone https://github.com/jlab-hep/localDB-tools.git - $ cd localDB-tools/setting - $ sudo ./db_server_install.sh - ``` + ```bash + $ git clone https://github.com/jlab-hep/localDB-tools.git + $ cd localDB-tools/setting + $ sudo ./db_server_install.sh + ``` - Check [Setup Local DB Server](#Setup-Local-DB-Server) for more detail. + Check [Setup Local DB Server](#Setup-Local-DB-Server) for more detail. - 2. MongoDB not started + 2. MongoDB not started - You can start/restart/enable Mongo DB by systemctl (centOS7): + You can start/restart/enable Mongo DB by systemctl (centOS7): - ```bash - $ systemctl restart mongod.service - $ systemctl enable mongod.service - ``` + ```bash + $ systemctl restart mongod.service + $ systemctl enable mongod.service + ``` 2. Mistake Local DB Server Information - Confirm the database config file and set it properly. - - ```json - { - "hostIp": "127.0.0.1", - "hostPort": "27000", - "dbName": "localdb", - "stage": [ - "Bare Module", - "Wire Bonded", - "Potted", - "Final Electrical", - "Complete", - "Loaded", - "Parylene", - "Initial Electrical", - "Thermal Cycling", - "Flex + Bare Module Attachment", - "Testing" - ], - "environment": [ - "vddd_voltage", - "vddd_current", - "vdda_voltage", - "vdda_current", - "hv_voltage", - "hv_current", - "temperature" - ], - "component": [ - "Front-end Chip", - "Front-end Chips Wafer", - "Hybrid", - "Module", - "Sensor Tile", - "Sensor Wafer" - ] - } - ``` - - You might have to change 'hostIp' and 'hostPort' following your Local DB - settings. + Confirm the database config file and set it properly. + + ```json + { + "hostIp": "127.0.0.1", + "hostPort": "27000", + "dbName": "localdb", + "stage": [ + "Bare Module", + "Wire Bonded", + "Potted", + "Final Electrical", + "Complete", + "Loaded", + "Parylene", + "Initial Electrical", + "Thermal Cycling", + "Flex + Bare Module Attachment", + "Testing" + ], + "environment": [ + "vddd_voltage", + "vddd_current", + "vdda_voltage", + "vdda_current", + "hv_voltage", + "hv_current", + "temperature" + ], + "component": [ + "Front-end Chip", + "Front-end Chips Wafer", + "Hybrid", + "Module", + "Sensor Tile", + "Sensor Wafer" + ] + } + ``` + + You might have to change 'hostIp' and 'hostPort' following your Local DB + settings. diff --git a/docs/v1.6.x/dev/Libraries.md b/docs/v1.6.x/dev/Libraries.md index f7ad64007..1cccb6d2c 100644 --- a/docs/v1.6.x/dev/Libraries.md +++ b/docs/v1.6.x/dev/Libraries.md @@ -2,105 +2,105 @@ This page describes about libraries required for Local DB ### OS supported by the Wiki -- centOS7 +- centOS7 ## For DAQ Server -- [YARR](https://gitlab.cern.ch/YARR/YARR) - -- Libraries (MongoDB (v3.6.3), OpenSSL) -
yum packages
- - ``` - $ sudo yum install \ - epel-release.noarch \ - centos-release-scl.noarch \ - bc.x86_64 \ - mongodb-org.x86_64 \ - devtoolset-7.x86_64 \ - gnuplot.x86_64 \ - openssl-devel \ - python.x86_64 \ - python36 \ - python36-devel \ - python36-pip \ - python36-tkinter - ``` - -
- -
pip modules
- - ``` - $ sudo pip3 install \ - arguments \ - coloredlogs \ - Flask \ - Flask-PyMongo \ - Flask-HTTPAuth \ - pdf2image \ - Pillow \ - prettytable \ - pymongo \ - python-dateutil \ - PyYAML \ - pytz \ - matplotlib \ - numpy \ - plotly \ - requests \ - tzlocal - ``` - -
+- [YARR](https://gitlab.cern.ch/YARR/YARR) + +- Libraries (MongoDB (v3.6.3), OpenSSL) +
yum packages
+ + ``` + $ sudo yum install \ + epel-release.noarch \ + centos-release-scl.noarch \ + bc.x86_64 \ + mongodb-org.x86_64 \ + devtoolset-7.x86_64 \ + gnuplot.x86_64 \ + openssl-devel \ + python.x86_64 \ + python36 \ + python36-devel \ + python36-pip \ + python36-tkinter + ``` + +
+ +
pip modules
+ + ``` + $ sudo pip3 install \ + arguments \ + coloredlogs \ + Flask \ + Flask-PyMongo \ + Flask-HTTPAuth \ + pdf2image \ + Pillow \ + prettytable \ + pymongo \ + python-dateutil \ + PyYAML \ + pytz \ + matplotlib \ + numpy \ + plotly \ + requests \ + tzlocal + ``` + +
## For DB Server -- [Local DB Tools](https://github.com/jlab-hep/localDB-tools.git) -- Libraries (MongoDB (v3.6.3), Python3) -
yum packages
- - ``` - $ sudo yum install \ - epel-release.noarch \ - centos-release-scl.noarch \ - bc.x86_64 \ - mongodb-org.x86_64 \ - devtoolset-7.x86_64 \ - gnuplot.x86_64 \ - python.x86_64 \ - httpd.x86_64 \ - python36 \ - python36-devel \ - python36-pip \ - python36-tkinter - ``` - -
- -
pip modules
- - ``` - $ sudo pip3 install \ - arguments \ - coloredlogs \ - Flask \ - Flask-PyMongo \ - Flask-HTTPAuth \ - pdf2image \ - Pillow \ - prettytable \ - pymongo \ - python-dateutil \ - PyYAML \ - pytz \ - plotly \ - matplotlib \ - numpy \ - requests \ - tzlocal - ``` - -
- -- PyROOT for making plots by the Viewer +- [Local DB Tools](https://github.com/jlab-hep/localDB-tools.git) +- Libraries (MongoDB (v3.6.3), Python3) +
yum packages
+ + ``` + $ sudo yum install \ + epel-release.noarch \ + centos-release-scl.noarch \ + bc.x86_64 \ + mongodb-org.x86_64 \ + devtoolset-7.x86_64 \ + gnuplot.x86_64 \ + python.x86_64 \ + httpd.x86_64 \ + python36 \ + python36-devel \ + python36-pip \ + python36-tkinter + ``` + +
+ +
pip modules
+ + ``` + $ sudo pip3 install \ + arguments \ + coloredlogs \ + Flask \ + Flask-PyMongo \ + Flask-HTTPAuth \ + pdf2image \ + Pillow \ + prettytable \ + pymongo \ + python-dateutil \ + PyYAML \ + pytz \ + plotly \ + matplotlib \ + numpy \ + requests \ + tzlocal + ``` + +
+ +- PyROOT for making plots by the Viewer diff --git a/docs/v1.6.x/dev/Manual-Installation.md b/docs/v1.6.x/dev/Manual-Installation.md index a28601201..000fed974 100644 --- a/docs/v1.6.x/dev/Manual-Installation.md +++ b/docs/v1.6.x/dev/Manual-Installation.md @@ -4,16 +4,16 @@ manually. ## Contents -- [Pre Requirements](#Pre-Requirements) -- [Libraries Installation](#Libraries-Installation) - - [For DB Server](#For-DB-Server) - - [For DAQ Server](#For-DAQ-Server) +- [Pre Requirements](#Pre-Requirements) +- [Libraries Installation](#Libraries-Installation) + - [For DB Server](#For-DB-Server) + - [For DAQ Server](#For-DAQ-Server) # Pre Requirements -- centOS7 -- sudo user account (for installation) -- git +- centOS7 +- sudo user account (for installation) +- git ```bash $ sudo yum install git @@ -29,106 +29,106 @@ Please look at @Install MongoDB Community Edition on Linux](https://docs.mongodb.com/v3.6/administration/install-on-linux/) to install mongoDB server and client. -- version : v3.6 +- version : v3.6 -- yum installation for centOS7 +- yum installation for centOS7 - - Add yum repository + - Add yum repository - Create `/etc/yum.repos.d/mongodb-org-3.6.repo` as below: + Create `/etc/yum.repos.d/mongodb-org-3.6.repo` as below: - ```bash - [mongodb-org-3.6] - name=MongoDB Repository - baseurl=https://repo.mongodb.org/yum/redhat/7Server/mongodb-org/3.6/x86_64/ - gpgcheck=1 - enabled=1 - gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc + ```bash + [mongodb-org-3.6] + name=MongoDB Repository + baseurl=https://repo.mongodb.org/yum/redhat/7Server/mongodb-org/3.6/x86_64/ + gpgcheck=1 + enabled=1 + gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc + ``` + + - Install by yum + + ```bash + $ sudo yum install -y mongodb-org.x86_64 + ``` + +- Start and Confirmation + + Add bindIp (default: '127.0.0.1') in MongoDB config file `/etc/mongod.conf`: + + ```yaml + # mongod.conf + # network interfaces + net: + bindIp: 127.0.0.1 # "HOST IP ADDRESS" + # Listen to local interface only, comment to listen on all interfaces. + port: 27017 ``` - - Install by yum + And start MongoDB service and confirm it works. ```bash - $ sudo yum install -y mongodb-org.x86_64 + $ sudo systemctl start mongod.service + $ sudo systemctl enable mongod.service + $ mongo + MongoDB shell version v3.6.8 + connecting to: mongodb://localhost:27017 + MongoDB server version: 3.6.8 + Server has startup warnings: ``` -- Start and Confirmation +### 2) Python - Add bindIp (default: '127.0.0.1') in MongoDB config file `/etc/mongod.conf`: +- version : v3.6 - ```yaml - # mongod.conf - # network interfaces - net: - bindIp: 127.0.0.1 # "HOST IP ADDRESS" - # Listen to local interface only, comment to listen on all interfaces. - port: 27017 - ``` + Prepared Local DB tools are based on Python3. - And start MongoDB service and confirm it works. +- yum installation for centOS7 - ```bash - $ sudo systemctl start mongod.service - $ sudo systemctl enable mongod.service - $ mongo - MongoDB shell version v3.6.8 - connecting to: mongodb://localhost:27017 - MongoDB server version: 3.6.8 - Server has startup warnings: - ``` + ```bash + $ sudo yum install -y　\ + epel-release.noarch \ + centos-release-scl.noarch \ + devtoolset-7.x86_64 \ + bc.x86_64 \ + python.x86_64 \ + python36 \ + python36-devel \ + python36-pip \ + python36-tkinter \ + ``` -### 2) Python +- Confirmation -- version : v3.6 - - Prepared Local DB tools are based on Python3. - -- yum installation for centOS7 - - ```bash - $ sudo yum install -y　\ - epel-release.noarch \ - centos-release-scl.noarch \ - devtoolset-7.x86_64 \ - bc.x86_64 \ - python.x86_64 \ - python36 \ - python36-devel \ - python36-pip \ - python36-tkinter \ - ``` - -- Confirmation - - ```bash - $ python36 --version - Python 3.6.8 - ``` - -- Module Installation - - Local DB tools need some python modules. - - ```bash - $ sudo pip3 install \ - arguments \ - coloredlogs \ - Flask \ - Flask-PyMongo \ - Flask-HTTPAuth \ - pdf2image \ - Pillow \ - prettytable \ - pymongo \ - python-dateutil \ - PyYAML \ - pytz \ - madplotlib \ - numpy \ - plotly \ - requests \ - tzlocal - ``` + ```bash + $ python36 --version + Python 3.6.8 + ``` + +- Module Installation + + Local DB tools need some python modules. + + ```bash + $ sudo pip3 install \ + arguments \ + coloredlogs \ + Flask \ + Flask-PyMongo \ + Flask-HTTPAuth \ + pdf2image \ + Pillow \ + prettytable \ + pymongo \ + python-dateutil \ + PyYAML \ + pytz \ + madplotlib \ + numpy \ + plotly \ + requests \ + tzlocal + ``` Next step: [Setup Viewer Application](https://github.com/jlab-hep/Yarr/wiki/Setup-Viewer-Application) @@ -137,23 +137,23 @@ Next step: ### 1) yum install -- Install by yum - - ```bash - $ sudo yum install -y　\ - epel-release.noarch \ - centos-release-scl.noarch \ - openssl-devel - bc.x86_64 \ - wget.x86_64 \ - mongodb-org.x86_64 \ - gnuplot.x86_64 \ - python.x86_64 \ - python36 \ - python36-devel \ - python36-pip \ - python36-tkinter \ - ``` +- Install by yum + + ```bash + $ sudo yum install -y　\ + epel-release.noarch \ + centos-release-scl.noarch \ + openssl-devel + bc.x86_64 \ + wget.x86_64 \ + mongodb-org.x86_64 \ + gnuplot.x86_64 \ + python.x86_64 \ + python36 \ + python36-devel \ + python36-pip \ + python36-tkinter \ + ``` ### 2) Python Module install diff --git a/docs/v1.6.x/dev/MongoDB-Server.md b/docs/v1.6.x/dev/MongoDB-Server.md index 3c00ba122..7da2fbe12 100644 --- a/docs/v1.6.x/dev/MongoDB-Server.md +++ b/docs/v1.6.x/dev/MongoDB-Server.md @@ -11,59 +11,59 @@ to install mongoDB server and client. 1. Add yum repository - Create and open `/etc/yum.repos.d/mongodb-org-3.6.repo`, then insert below - and save. - - ``` - [mongodb-org-3.6] - name=MongoDB Repository - baseurl=https://repo.mongodb.org/yum/redhat/7Server/mongodb-org/3.6/x86_64/ - gpgcheck=1 - enabled=1 - gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc - ``` - - > About mongo DB version - > - > > Install **version 3.6 server** because the library is suitable for - > > version 3.6 server. + Create and open `/etc/yum.repos.d/mongodb-org-3.6.repo`, then insert below + and save. + + ``` + [mongodb-org-3.6] + name=MongoDB Repository + baseurl=https://repo.mongodb.org/yum/redhat/7Server/mongodb-org/3.6/x86_64/ + gpgcheck=1 + enabled=1 + gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc + ``` + + > About mongo DB version + > + > > Install **version 3.6 server** because the library is suitable for + > > version 3.6 server. 2. Install - ``` - $ sudo yum install mongodb-org - ``` + ``` + $ sudo yum install mongodb-org + ``` ### 2) Start a system server 1. Start - ``` - $ sudo systemctl start mongod.service - ``` + ``` + $ sudo systemctl start mongod.service + ``` 2. Check - Type `mongo` or `mongo --host localhost --port 27017`. The result will be - like below: + Type `mongo` or `mongo --host localhost --port 27017`. The result will be + like below: - ``` - $ mongo - MongoDB shell version v3.6.8 - connecting to: mongodb://localhost:27017 - MongoDB server version: 3.6.8 - Server has startup warnings: - ``` + ``` + $ mongo + MongoDB shell version v3.6.8 + connecting to: mongodb://localhost:27017 + MongoDB server version: 3.6.8 + Server has startup warnings: + ``` ### Others -- Ensure that MongoDB will start following a system reboot by - `sudo systemctl enable mongod.service` +- Ensure that MongoDB will start following a system reboot by + `sudo systemctl enable mongod.service` -- You can stop a server by typing`sudo systemctl stop mongod.service` +- You can stop a server by typing`sudo systemctl stop mongod.service` -- mongo db server config file is at `/etc/mongod.conf`
The default host is - '127.0.0.1' (localhost), and port is '27017'. You can change it by editing the - config file then `sudo systemctl restart mongod.service` +- mongo db server config file is at `/etc/mongod.conf`
The default host is + '127.0.0.1' (localhost), and port is '27017'. You can change it by editing + the config file then `sudo systemctl restart mongod.service` ## B. Use SCL (not recommended) @@ -139,23 +139,24 @@ $ source /opt/rh/rh-mongodb36/enable $ mongod --config mongod.conf & ``` -- Stop a server First type `mongo` to use mongo shell, then +- Stop a server First type `mongo` to use mongo shell, then - ``` - use admin - db.shutdownServer() - ``` + ``` + use admin + db.shutdownServer() + ``` - (To kill local user server, Find job number by typing `ps aux | grep mongod`. - Then `kill 5711`) + (To kill local user server, Find job number by typing + `ps aux | grep mongod`. Then `kill 5711`) ## If there is problem -- If SELinux is in enforcing mode, +- If SELinux is in enforcing mode, - enable access to the relevant ports that the MongoDB deployment will use (e.g. - 27017).
For default settings, this can be accomplished by running:
+ enable access to the relevant ports that the MongoDB deployment will use + (e.g. 27017).
For default settings, this can be accomplished by + running:
- ``` - $ semanage port -a -t mongod_port_t -p tcp 27017 - ``` + ``` + $ semanage port -a -t mongod_port_t -p tcp 27017 + ``` diff --git a/docs/v1.6.x/dev/Start-a-open-server.md b/docs/v1.6.x/dev/Start-a-open-server.md index 1d676c604..a969ff365 100644 --- a/docs/v1.6.x/dev/Start-a-open-server.md +++ b/docs/v1.6.x/dev/Start-a-open-server.md @@ -9,26 +9,26 @@ After install a mongo DB server. ## Contents -- `/etc/mongod.conf` : config file of mongodb +- `/etc/mongod.conf` : config file of mongodb - ``` - systemLog: - destination: file - logAppend: true - path: /var/log/mongod/mongod.log # where to write logging data + ``` + systemLog: + destination: file + logAppend: true + path: /var/log/mongod/mongod.log # where to write logging data - storage: - dbPath: /var/lib/mongo # where to store data - journal: - enabled: true - net: - bindIp: 127.0.0.1, XXX.X.X.X # the hostnames a/o IP addresses a/o full Unix domain socket paths on which mongos and mongod should listen for client connections - port: 27017 # The TCP port on which the MongoDB instance listens for client connections - ``` + storage: + dbPath: /var/lib/mongo # where to store data + journal: + enabled: true + net: + bindIp: 127.0.0.1, XXX.X.X.X # the hostnames a/o IP addresses a/o full Unix domain socket paths on which mongos and mongod should listen for client connections + port: 27017 # The TCP port on which the MongoDB instance listens for client connections + ``` -- `/var/log/mongod/mongod.log` : where to write logging data +- `/var/log/mongod/mongod.log` : where to write logging data -- `/var/lib/mongo` : where to store data +- `/var/lib/mongo` : where to store data ## Start mongod @@ -41,34 +41,34 @@ systemctl start mongod 1. stop mongod - ``` - $ sudo systemctl stop mongod.service - ``` + ``` + $ sudo systemctl stop mongod.service + ``` 2. Backup (or delete) original mongo directory - ``` - $ sudo tar zcvf /var/lib/mongo_backup.tar.gz /var/lib/mongo - ``` + ``` + $ sudo tar zcvf /var/lib/mongo_backup.tar.gz /var/lib/mongo + ``` 3. Download and copy data directory - ``` - $ tar zxvf mongo-181109-fixed.tar.gz - $ sudo mv var/lib/mongo /var/lib/. - ``` + ``` + $ tar zxvf mongo-181109-fixed.tar.gz + $ sudo mv var/lib/mongo /var/lib/. + ``` 4. Change permission, context - ``` - $ sudo chcon -R -u system_u -t mongod_var_lib_t /var/lib/mongo/ - $ sudo chown -R mongod:mongod /var/lib/mongo - ``` + ``` + $ sudo chcon -R -u system_u -t mongod_var_lib_t /var/lib/mongo/ + $ sudo chown -R mongod:mongod /var/lib/mongo + ``` 5. Restart mongo - ``` - $ sudo systemctl start mongod.service - ``` + ``` + $ sudo systemctl start mongod.service + ``` ## Backup mongoDB database diff --git a/docs/v1.6.x/dev/Upload.md b/docs/v1.6.x/dev/Upload.md index 2f165a029..22e160ca5 100644 --- a/docs/v1.6.x/dev/Upload.md +++ b/docs/v1.6.x/dev/Upload.md @@ -2,12 +2,12 @@ This page describes how to retrieve data from Local DB. ## Requirements -- DAQ Server with - [required libraries installed](https://github.com/jlab-hep/Yarr/wiki/Installation) -- DB Server with - [required libraries installed](https://github.com/jlab-hep/Yarr/wiki/Installation) -- Setup DAQ system: - [setup_db.sh](https://github.com/jlab-hep/Yarr/wiki/Setup-DAQ-Server) +- DAQ Server with + [required libraries installed](https://github.com/jlab-hep/Yarr/wiki/Installation) +- DB Server with + [required libraries installed](https://github.com/jlab-hep/Yarr/wiki/Installation) +- Setup DAQ system: + [setup_db.sh](https://github.com/jlab-hep/Yarr/wiki/Setup-DAQ-Server) ## Upload Tool @@ -21,8 +21,8 @@ $ localdbtool-upload init Additional options: -- **--database ``** : Set database config file (default: - `${HOME}/.yarr/localdb/database.json`). +- **--database ``** : Set database config file (default: + `${HOME}/.yarr/localdb/database.json`). ### Upload Scan @@ -44,20 +44,20 @@ e.g.) $ localdbtool-upload scan ./data/last_scan Additional options: -- **--database ``** : Set database config file (default: - `${HOME}/.yarr/localdb/database.json`). -- **--user ``** : Set user config file (default: - `${HOME}/.yarr/localdb/user.json`). -- **--site ``** : Set site config file (default: - `${HOME}/.yarr/localdb/site.json`). -- **--log** : Set logging mode (default 'False'). If set 'True', the output log - is written in `${HOME}/.yarr/localdb/log/day.log`. -- **--username ``** : Set username of the Local DB Server if the users - authenticated is needed. -- **--password ``** : Set password of the Local DB Server if the users - authenticated is needed. -- **--config ``** : Set config file which username and password are - written in if the users authenticated is needed. +- **--database ``** : Set database config file (default: + `${HOME}/.yarr/localdb/database.json`). +- **--user ``** : Set user config file (default: + `${HOME}/.yarr/localdb/user.json`). +- **--site ``** : Set site config file (default: + `${HOME}/.yarr/localdb/site.json`). +- **--log** : Set logging mode (default 'False'). If set 'True', the output + log is written in `${HOME}/.yarr/localdb/log/day.log`. +- **--username ``** : Set username of the Local DB Server if the + users authenticated is needed. +- **--password ``** : Set password of the Local DB Server if the + users authenticated is needed. +- **--config ``** : Set config file which username and password + are written in if the users authenticated is needed. ### Upload Cache diff --git a/docs/v1.6.x/dev/Viewer.md b/docs/v1.6.x/dev/Viewer.md index 8e4b1de45..49447a473 100644 --- a/docs/v1.6.x/dev/Viewer.md +++ b/docs/v1.6.x/dev/Viewer.md @@ -4,9 +4,9 @@ The Viewer is a beautiful and convenient web interface for LocalDB. We can: -- check data -- register module/chip (under construct) -- sync (not implemented yet) +- check data +- register module/chip (under construct) +- sync (not implemented yet) # 2. Getting start diff --git a/docs/v1.6.x/dev/Web-interface.md b/docs/v1.6.x/dev/Web-interface.md index 8edec5d99..4d1ec0a8a 100644 --- a/docs/v1.6.x/dev/Web-interface.md +++ b/docs/v1.6.x/dev/Web-interface.md @@ -5,11 +5,11 @@ Flask with PyMongo python module. > requirements > -> - centOS7 -> - Local Database is running -> - ROOT software enabled by `source path/to/bin/thisroot.sh` -> - python 2.X or 3.X which can use PyROOT enabled by -> `source path/to/thispython.sh` +> - centOS7 +> - Local Database is running +> - ROOT software enabled by `source path/to/bin/thisroot.sh` +> - python 2.X or 3.X which can use PyROOT enabled by +> `source path/to/thispython.sh` # Installation @@ -23,64 +23,64 @@ source /opt/rh/devtoolset-7/enable 1. Download localDB-tools - ``` - git clone https://github.com/jlab-hep/localDB-tools - cd localDB-tools/viewer - git checkout devel - ``` + ``` + git clone https://github.com/jlab-hep/localDB-tools + cd localDB-tools/viewer + git checkout devel + ``` 2. Install pip -
(click)
+
(click)
- - python2 + - python2 - ``` - $ sudo yum install epel-release - $ sudo yum install python python-pip poppler-utils - ``` + ``` + $ sudo yum install epel-release + $ sudo yum install python python-pip poppler-utils + ``` - - python3 + - python3 - ``` - sudo yum install epel-release - sudo yum install python36 python36-devel python36-setuptools - sudo easy_install-3.6 pip - ``` + ``` + sudo yum install epel-release + sudo yum install python36 python36-devel python36-setuptools + sudo easy_install-3.6 pip + ``` - - In case of none-sudo user, do below to install on local.(not recommended) - ``` - curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py - python get-pip.py --user - ``` + - In case of none-sudo user, do below to install on local.(not recommended) + ``` + curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py + python get-pip.py --user + ``` - *** + *** -
+
3. Install python modules - ``` - $ cd localDB-tools/scripts/install - $ sudo pip install -r requirements.txt - ``` - > required packages - > - > - Click==7.0 - > - Flask==1.0.2 - > - Flask-HTTPAuth>=3.2.4 - > - Flask-PyMongo>=2.1.0 - > - itsdangerous>=1.0.0 - > - Jinja2>=2.10 - > - MarkupSafe>=1.0 - > - pdf2image>=1.0.0 - > - Pillow>=5.3.0 - > - prettytable==0.7.2 - > - pymongo>=3.7.2 - > - python-dateutil>=2.7.5 - > - PyYAML>=3.13 - > - setuptools>=39.2.0 - > - six>=1.11.0 - > - Werkzeug>=0.14.1 + ``` + $ cd localDB-tools/scripts/install + $ sudo pip install -r requirements.txt + ``` + > required packages + > + > - Click==7.0 + > - Flask==1.0.2 + > - Flask-HTTPAuth>=3.2.4 + > - Flask-PyMongo>=2.1.0 + > - itsdangerous>=1.0.0 + > - Jinja2>=2.10 + > - MarkupSafe>=1.0 + > - pdf2image>=1.0.0 + > - Pillow>=5.3.0 + > - prettytable==0.7.2 + > - pymongo>=3.7.2 + > - python-dateutil>=2.7.5 + > - PyYAML>=3.13 + > - setuptools>=39.2.0 + > - six>=1.11.0 + > - Werkzeug>=0.14.1 ## 2) Create configuration file diff --git a/docs/v1.6.x/dev/convert-scheme.md b/docs/v1.6.x/dev/convert-scheme.md index fb73a084b..d5fd7d19a 100644 --- a/docs/v1.6.x/dev/convert-scheme.md +++ b/docs/v1.6.x/dev/convert-scheme.md @@ -14,10 +14,10 @@ $ sudo systemctl restart mongod.service There are three steps: -- update the structure of "localdb" Database to the latest one -- convert the structure of "yarrdb" Database to the latest one and merge it into - "localdb" Database -- verify the structure of "localdb" Database +- update the structure of "localdb" Database to the latest one +- convert the structure of "yarrdb" Database to the latest one and merge it + into "localdb" Database +- verify the structure of "localdb" Database ``` $ git clone https://github.com/jlab-hep/localDB-tools.git diff --git a/docs/v1.6.x/dev/ssltls.md b/docs/v1.6.x/dev/ssltls.md index 8228ac8d1..5b4327881 100644 --- a/docs/v1.6.x/dev/ssltls.md +++ b/docs/v1.6.x/dev/ssltls.md @@ -39,12 +39,12 @@ $ sudo vim /etc/mongod.conf ```yaml # network interfaces net: - port: 27017 - bindIp: 127.0.0.1,"DB SERVER HOSTNAME" - ssl: - mode: requireSSL - PEMKeyFile: /etc/ssl/localdb_cert.pem ### Server Certificate - CAFile: /etc/ssl/localdb_ca.pem ### CA PEM File + port: 27017 + bindIp: 127.0.0.1,"DB SERVER HOSTNAME" + ssl: + mode: requireSSL + PEMKeyFile: /etc/ssl/localdb_cert.pem ### Server Certificate + CAFile: /etc/ssl/localdb_ca.pem ### CA PEM File ``` ###### 4.2 Set TLS mode (For MongoDB version 4.2 and greater) @@ -52,12 +52,12 @@ net: ```yaml # network interfaces net: - port: 27017 - bindIp: 127.0.0.1, "DB SERVER HOSTNAME" - tls: - mode: requireTLS - certificateKeyFile: /etc/ssl/localdb_cert.pem ### Server Certificate - CAFile: /etc/ssl/localdb_ca.pem ### CA PEM File + port: 27017 + bindIp: 127.0.0.1, "DB SERVER HOSTNAME" + tls: + mode: requireTLS + certificateKeyFile: /etc/ssl/localdb_cert.pem ### Server Certificate + CAFile: /etc/ssl/localdb_ca.pem ### CA PEM File ``` ###### 5. Start MongoDB diff --git a/docs/v1.6.x/error/accessor.md b/docs/v1.6.x/error/accessor.md index ffa7d5f55..f9e2497dd 100644 --- a/docs/v1.6.x/error/accessor.md +++ b/docs/v1.6.x/error/accessor.md @@ -2,16 +2,16 @@ ### Table of Contents -- [Not found xxx (File)](#not-found-xxx-file) - - [Not found database config](#not-found-database-config) - - [Not found scanLog.json](#not-found-scanlogjson) -- [Not found xxx (Data)](#not-found-xxx-data) - - [Not found user data](#not-found-user-data) - - [Not found site data](#not-found-site-data) - - [Not found component data](#not-found-component-data) - - [Not found specified relational test run data](#not-found-specified-relational-test-run-data) -- [Found an empty field](#found-an-empty-field) -- [Could not parse xxx](#could-not-parse-xxx) +- [Not found xxx (File)](#not-found-xxx-file) + - [Not found database config](#not-found-database-config) + - [Not found scanLog.json](#not-found-scanlogjson) +- [Not found xxx (Data)](#not-found-xxx-data) + - [Not found user data](#not-found-user-data) + - [Not found site data](#not-found-site-data) + - [Not found component data](#not-found-component-data) + - [Not found specified relational test run data](#not-found-specified-relational-test-run-data) +- [Found an empty field](#found-an-empty-field) +- [Could not parse xxx](#could-not-parse-xxx) --- @@ -37,11 +37,11 @@ find the existence of the file in the specified path. **solution** -- Make sure the [database config file](../config/database.md) exists at the - specified path. -- Not specify the option -d and use default - [database config file](../config/database.md) under - `HOME/.yarr/localdb/HOSTNAME_database.json`. +- Make sure the [database config file](../config/database.md) exists at the + specified path. +- Not specify the option -d and use default + [database config file](../config/database.md) under + `HOME/.yarr/localdb/HOSTNAME_database.json`. #### Not found scanLog.json diff --git a/docs/v1.6.x/error/common.md b/docs/v1.6.x/error/common.md index 6478b2d6c..c1cfda0ee 100644 --- a/docs/v1.6.x/error/common.md +++ b/docs/v1.6.x/error/common.md @@ -2,8 +2,8 @@ ### Table of Contents -- [Missing PIP Modules](#missing-pip-modules) -- [Local DB Connection Refused](#local-db-connection-refused) +- [Missing PIP Modules](#missing-pip-modules) +- [Local DB Connection Refused](#local-db-connection-refused) --- diff --git a/docs/v1.6.x/faq.md b/docs/v1.6.x/faq.md index 5d6bd3374..3f1b0c3a9 100644 --- a/docs/v1.6.x/faq.md +++ b/docs/v1.6.x/faq.md @@ -4,12 +4,12 @@ This page describes frequently asked questions. ### - [MongoDB Related](faq/mongo.md) -- Installation for Local DB Server -- mongo shell -- SSL/TLS Connection -- SSH Tunnel -- Access Control +- Installation for Local DB Server +- mongo shell +- SSL/TLS Connection +- SSH Tunnel +- Access Control ### - [Viewer Application Related](faq/viewer.md) -- Apache Configuration +- Apache Configuration diff --git a/docs/v1.6.x/faq/mongo.md b/docs/v1.6.x/faq/mongo.md index 155a6bcc5..936b0635f 100644 --- a/docs/v1.6.x/faq/mongo.md +++ b/docs/v1.6.x/faq/mongo.md @@ -4,11 +4,11 @@ See the [MongoDB docs](https://docs.mongodb.com/manual/) to get more detail.
### Table of Contents -- [Installation for Local DB Server](#installation) -- [mongo shell](#mongo-shell) -- [SSL/TLS Connection](#ssltls-connection) -- [SSH Tunnel](#ssh-tunnel) -- [Access Control](#access-control) +- [Installation for Local DB Server](#installation) +- [mongo shell](#mongo-shell) +- [SSL/TLS Connection](#ssltls-connection) +- [SSH Tunnel](#ssh-tunnel) +- [Access Control](#access-control) --- @@ -39,11 +39,11 @@ $ sudo yum install -y mongodb-org.x86_64 ###### 3. Directories (default) -- shell command: `/bin/mongo` -- process command: `/bin/mongod` -- config file: `/etc/mongod.conf` -- data directory: `/var/lib/mongo` -- log directory: `/var/log/mongodb` +- shell command: `/bin/mongo` +- process command: `/bin/mongod` +- config file: `/etc/mongod.conf` +- data directory: `/var/lib/mongo` +- log directory: `/var/log/mongodb` ###### 4. Start MongoDB @@ -78,11 +78,11 @@ $ brew install mongodb-community@4.2 ###### 4. Directories (default) -- shell command: `/usr/local/opt/mongodb-community\@4.2/bin/mongo` -- process command: `/usr/local/opt/mongodb-community\@4.2/bin/mongod` -- config file: `/usr/local/etc/mongod.conf` -- data directory: `/usr/local/var/lib/mongo` -- log directory: `/usr/local/var/log/mongodb` +- shell command: `/usr/local/opt/mongodb-community\@4.2/bin/mongo` +- process command: `/usr/local/opt/mongodb-community\@4.2/bin/mongod` +- config file: `/usr/local/etc/mongod.conf` +- data directory: `/usr/local/var/lib/mongo` +- log directory: `/usr/local/var/log/mongodb` ###### 5. Start MongoDB @@ -197,8 +197,8 @@ $ sudo vim /etc/mongod.conf ```yaml # network interfaces net: - port: 27017 - bindIp: 127.0.0.1,"DB SERVER HOSTNAME" # e.g. 127.0.0.1,192.168.1.50 + port: 27017 + bindIp: 127.0.0.1,"DB SERVER HOSTNAME" # e.g. 127.0.0.1,192.168.1.50 ``` ###### 3. Start MongoDB @@ -248,7 +248,7 @@ Disable or comment out security.authorization in /etc/mongod.conf: ```yml --- security: - authorization: disabled + authorization: disabled ``` Start MongoDB instance: @@ -309,7 +309,7 @@ Enable or uncomment out security.authorization in /etc/mongod.conf: ```yml --- security: - authorization: enabled + authorization: enabled ``` Start MongoDB instance: diff --git a/docs/v1.6.x/faq/viewer.md b/docs/v1.6.x/faq/viewer.md index d6b84b2ae..adbf8b098 100644 --- a/docs/v1.6.x/faq/viewer.md +++ b/docs/v1.6.x/faq/viewer.md @@ -2,7 +2,7 @@ ### Table of Contents -- [How to Set Apache](#how-to-set-apache) +- [How to Set Apache](#how-to-set-apache) --- @@ -76,9 +76,9 @@ $ sudo setsebool -P httpd_execmem on There are three types of apache configurations supported by the Local DB system: -- apache w/o SSL authentication certificate -- apache w/ SSL authentication certificate -- proxy server (w/o WSGI) +- apache w/o SSL authentication certificate +- apache w/ SSL authentication certificate +- proxy server (w/o WSGI) ###### 4-a. w/o SSL authentication certificate diff --git a/docs/v1.6.x/installation.md b/docs/v1.6.x/installation.md index 4f2b65e4c..6dff976a8 100644 --- a/docs/v1.6.x/installation.md +++ b/docs/v1.6.x/installation.md @@ -18,13 +18,13 @@ Please change to devel branch if want to use. ## Installation for centOS7 -- [Manual Installation (**RECOMMENDED**)](installation/manual-centos.md) -- [Automatic Installation](installation/automatic-centos.md) +- [Manual Installation (**RECOMMENDED**)](installation/manual-centos.md) +- [Automatic Installation](installation/automatic-centos.md) ## Installation for macOS -- [Manual Installation (**RECOMMENDED**)](installation/manual-macos.md) -- [Automatic Installation](installation/automatic-macos.md) +- [Manual Installation (**RECOMMENDED**)](installation/manual-macos.md) +- [Automatic Installation](installation/automatic-macos.md) Once installed the required packages, you can try it out following the [tutorial page](tutorial.md).
See the [manual page for each tool](tool.md) diff --git a/docs/v1.6.x/installation/automatic-centos.md b/docs/v1.6.x/installation/automatic-centos.md index f243522d1..30017cb1a 100644 --- a/docs/v1.6.x/installation/automatic-centos.md +++ b/docs/v1.6.x/installation/automatic-centos.md @@ -3,10 +3,10 @@ You can install the [requirements for the system](requirements-list.md) on centOS7 automatically by `db_server_install.sh`.
The script can -- Check missing packages -- Install requirements for DAQ/DB Machine -- Enable MongoDB -- Confirme the installation status & Show quick tutorial +- Check missing packages +- Install requirements for DAQ/DB Machine +- Enable MongoDB +- Confirme the installation status & Show quick tutorial If you want to install manually, see the [manual installation guide for centOS7](manual-centos.md).
If you want to @@ -15,8 +15,8 @@ install on other platform see the ## script -- Location: **localdb-tools/setting/db_server_install.sh** -- Syntax +- Location: **localdb-tools/setting/db_server_install.sh** +- Syntax ```bash $ cd localdb-tools/setting diff --git a/docs/v1.6.x/installation/automatic-macos.md b/docs/v1.6.x/installation/automatic-macos.md index 8c12c833b..f798859db 100644 --- a/docs/v1.6.x/installation/automatic-macos.md +++ b/docs/v1.6.x/installation/automatic-macos.md @@ -3,10 +3,10 @@ You can install the [requirements for the system](requirements-list.md) on macOS automatically by `installer_macos.sh`.
The script can -- Check missing packages -- Install requirements for DAQ/DB Machine -- Enable MongoDB -- Confirme the installation status & Show quick tutorial +- Check missing packages +- Install requirements for DAQ/DB Machine +- Enable MongoDB +- Confirme the installation status & Show quick tutorial If you want to install manually, see the [manual installation guide for macOS](manual-macos.md).
If you want to @@ -15,8 +15,8 @@ install on other platform see the ## script -- Location: **localdb-tools/setting/macos/installer_macos.sh** -- Syntax +- Location: **localdb-tools/setting/macos/installer_macos.sh** +- Syntax ```bash $ cd localdb-tools/setting/macos diff --git a/docs/v1.6.x/installation/manual-centos.md b/docs/v1.6.x/installation/manual-centos.md index e873ae7e1..239e3de6a 100644 --- a/docs/v1.6.x/installation/manual-centos.md +++ b/docs/v1.6.x/installation/manual-centos.md @@ -6,28 +6,28 @@ the [manual installation guide for macOS](manual-macos.md). ### Table of Contents -- [Installation for DAQ machine](#installation-for-daq-machine) - - [yum packages](#yum-packages-daq) - - g++ - - cmake3 - - Other dependencies - - [python packages](#python-packages-daq) - - python3 - - pip modules - - [YARR SW Compilation](#yarr-sw-compilation) -- [Installation for DB machine](#installation-for-db-machine) - - [yum packages](#yum-packages-db) - - g++ - - cmake3 - - Other dependencies - - [python packages](#python-packages-db) - - python3 - - pip modules - - [Local DB tools Compilation](#localdb-tools-compilation) - - [MongoDB](#mongodb) - - [influxDB](#influxdb) - - [Grafana](#grafana) - - [ROOT](#root) +- [Installation for DAQ machine](#installation-for-daq-machine) + - [yum packages](#yum-packages-daq) + - g++ + - cmake3 + - Other dependencies + - [python packages](#python-packages-daq) + - python3 + - pip modules + - [YARR SW Compilation](#yarr-sw-compilation) +- [Installation for DB machine](#installation-for-db-machine) + - [yum packages](#yum-packages-db) + - g++ + - cmake3 + - Other dependencies + - [python packages](#python-packages-db) + - python3 + - pip modules + - [Local DB tools Compilation](#localdb-tools-compilation) + - [MongoDB](#mongodb) + - [influxDB](#influxdb) + - [Grafana](#grafana) + - [ROOT](#root) --- diff --git a/docs/v1.6.x/installation/manual-macos.md b/docs/v1.6.x/installation/manual-macos.md index 8cbab97c6..ea9df7e95 100644 --- a/docs/v1.6.x/installation/manual-macos.md +++ b/docs/v1.6.x/installation/manual-macos.md @@ -6,30 +6,30 @@ manually following this page.
If you want to install on centOS7, see the ### Table of Contents -- [Installation for DAQ machine](#installation-for-daq-machine) - - [brew packages](#brew-packages-daq) - - brew command - - g++ - - cmake3 - - other dependencies - - [python packages](#python-packages-daq) - - python3 - - pip modules - - [YARR SW Compilation](#yarr-sw-compilation) -- [Installation for DB machine](#installation-for-db-machine) - - [brew packages](#brew-packages-db) - - brew command - - g++ - - cmake3 - - other dependencies - - [python packages](#python-packages-db) - - python3 - - pip modules - - [Local DB tools Compilation](#localdb-tools-compilation) - - [MongoDB](#mongodb) - - [influxDB](#influxdb) - - [Grafana](#grafana) - - [ROOT](#root) +- [Installation for DAQ machine](#installation-for-daq-machine) + - [brew packages](#brew-packages-daq) + - brew command + - g++ + - cmake3 + - other dependencies + - [python packages](#python-packages-daq) + - python3 + - pip modules + - [YARR SW Compilation](#yarr-sw-compilation) +- [Installation for DB machine](#installation-for-db-machine) + - [brew packages](#brew-packages-db) + - brew command + - g++ + - cmake3 + - other dependencies + - [python packages](#python-packages-db) + - python3 + - pip modules + - [Local DB tools Compilation](#localdb-tools-compilation) + - [MongoDB](#mongodb) + - [influxDB](#influxdb) + - [Grafana](#grafana) + - [ROOT](#root) --- diff --git a/docs/v1.6.x/installation/requirements-list.md b/docs/v1.6.x/installation/requirements-list.md index 27e295c33..29cd8af14 100644 --- a/docs/v1.6.x/installation/requirements-list.md +++ b/docs/v1.6.x/installation/requirements-list.md @@ -2,42 +2,42 @@ ## Supported OS -- centOS7 -- macOS greater than 10.14 +- centOS7 +- macOS greater than 10.14 ## Required Packages #### For YARR SW -- g++ version 7.0 or higher -- cmake3 -- gnuplot -- epstopdf (TeXLive) -- Ghostscript +- g++ version 7.0 or higher +- cmake3 +- gnuplot +- epstopdf (TeXLive) +- Ghostscript #### For Local DB System -- MongoDB -- python3 version 3.6 or higher -- python modules - - arguments - - coloredlogs - - Flask - - Flask-PyMongo - - Flask-HTTPAuth - - Flask-Mail - - pdf2image - - Pillow - - prettytable - - pymongo - - python-dateutil - - PyYAML - - pytz - - plotly - - matplotlib - - numpy - - requests - - tzlocal - - itkdb - - influxdb - - pandas +- MongoDB +- python3 version 3.6 or higher +- python modules + - arguments + - coloredlogs + - Flask + - Flask-PyMongo + - Flask-HTTPAuth + - Flask-Mail + - pdf2image + - Pillow + - prettytable + - pymongo + - python-dateutil + - PyYAML + - pytz + - plotly + - matplotlib + - numpy + - requests + - tzlocal + - itkdb + - influxdb + - pandas diff --git a/docs/v1.6.x/qcflow/flow.md b/docs/v1.6.x/qcflow/flow.md index 521a2adc0..b94b7a20a 100644 --- a/docs/v1.6.x/qcflow/flow.md +++ b/docs/v1.6.x/qcflow/flow.md @@ -5,11 +5,11 @@ dummy module. ## Pre-requisites -- In order to go through this page, it is assumed that all installation - procedure in the [Installation Guide](../install.md) is complete. -- On top of that, you will need to have an account on ITk production database - (two passcodes authentication). You will generate a virtual serial number for - a virtual module. +- In order to go through this page, it is assumed that all installation + procedure in the [Installation Guide](../install.md) is complete. +- On top of that, you will need to have an account on ITk production database + (two passcodes authentication). You will generate a virtual serial number + for a virtual module. !!! attention If you don't have an account for the production DB. Please sign up following the link below:
@@ -24,11 +24,11 @@ authentication. Please get familiar with this sign-in method. Through this course, you will be able to gain experience on: -- Learn how to register a new component to ITk production DB -- (Virtually) assemble a bare module -- (Virtually) assemble a module -- Carry out a virtual QC of the "BareToPCB" stage -- Sign-off the +- Learn how to register a new component to ITk production DB +- (Virtually) assemble a bare module +- (Virtually) assemble a module +- Carry out a virtual QC of the "BareToPCB" stage +- Sign-off the ## Download institutions and module types info from ITkPD @@ -61,10 +61,10 @@ Please input your name in any blank row of [this spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing). You will use the corresponding serial numbers of: -- a PCB -- a carrier -- a FE chip (we will assemble a dummy single-chip module) -- sensor manufacturer +- a PCB +- a carrier +- a FE chip (we will assemble a dummy single-chip module) +- sensor manufacturer ## Register new components to ITkPD @@ -78,25 +78,25 @@ component from `My Components`: You will need to repeat the above steps for all four items: -- a PCB - - FE chip version: `ITkpix_v1.1` - - Other fields can be left empty. - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a carrier - - Type: `0` - - Usgae countdown: `1` - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a FE chip (we will assemble a dummy single-chip module) - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- a sensor tile - - Main vendor: `0` - - Sensor Type or Test Structure: `0` - - Version of component: `prototype` - - ATLAS SN: follow - [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a PCB + - FE chip version: `ITkpix_v1.1` + - Other fields can be left empty. + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a carrier + - Type: `0` + - Usgae countdown: `1` + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a FE chip (we will assemble a dummy single-chip module) + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- a sensor tile + - Main vendor: `0` + - Sensor Type or Test Structure: `0` + - Version of component: `prototype` + - ATLAS SN: follow + [the spreadsheet table](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) !!! Warning You will need to have an appropriate privilege of managing components at your institute in the ITk production DB. If you encounter problems @@ -140,9 +140,9 @@ press "Next". Then, input bare module information. In the first panel, you fill: -- Bare Module Type: Tutorial bare module -- FE chip version: ITkPix_v1.1 -- FE chip thickness: +- Bare Module Type: Tutorial bare module +- FE chip version: ITkPix_v1.1 +- FE chip thickness: ![input bare info](../images/qc-flow/register_bare_2.png) @@ -185,10 +185,10 @@ support operations.
If you check the detail for QC-helper, please check it: ### Bare to PCB -- Visual Inspection -- Metrology (Old format) -- Mass -- Glue Flex Attach information +- Visual Inspection +- Metrology (Old format) +- Mass +- Glue Flex Attach information !!! warning Stages and test items are not current version. We are improving the SW to match newest version of QC flow.
@@ -304,18 +304,18 @@ left conner.
### 5. Upload QC-test results for Wirebonding -- [Upload QC-test results for Wirebonding](nonelectricalwire.md) -- [Upload Scan results to LocalDB](scanconsole.md) -- [Select Scans test results](upload_resultwire.md) +- [Upload QC-test results for Wirebonding](nonelectricalwire.md) +- [Upload Scan results to LocalDB](scanconsole.md) +- [Select Scans test results](upload_resultwire.md) ### 6. Sign-off each stage and push results to ITkPD -- [Sign-off each stage](signoffwire.md) -- [Push the list of signed off results](upload_itkpdwire.md) +- [Sign-off each stage](signoffwire.md) +- [Push the list of signed off results](upload_itkpdwire.md) ### 6. Change a stage after Wirebonding -- [Change a stage after Wirebonding](change_stage.md) +- [Change a stage after Wirebonding](change_stage.md)
@@ -336,6 +336,6 @@ left conner.
## Contact -- Please send questions or comments to: kinoshita at hep.phys.titech.ac.jp -- Also a dedicated mattermost - channel:[https://mattermost.web.cern.ch/yarr/channels/qc-demonstration](https://mattermost.web.cern.ch/yarr/channels/qc-demonstration) +- Please send questions or comments to: kinoshita at hep.phys.titech.ac.jp +- Also a dedicated mattermost + channel:[https://mattermost.web.cern.ch/yarr/channels/qc-demonstration](https://mattermost.web.cern.ch/yarr/channels/qc-demonstration) diff --git a/docs/v1.6.x/qcflow/install_daq_machine.md b/docs/v1.6.x/qcflow/install_daq_machine.md index 9c35b79b1..d842d69a3 100644 --- a/docs/v1.6.x/qcflow/install_daq_machine.md +++ b/docs/v1.6.x/qcflow/install_daq_machine.md @@ -18,14 +18,14 @@ Please follow the link below to install Yarr-SW.
### Python packages -- python3 version 3.6 or higher +- python3 version 3.6 or higher ```bash $ python3 --version Python 3.6.8 ``` -- python pip packages +- python pip packages ```bash $ sudo python3 -m pip install arguments coloredlogs pdf2image Pillow pymongo python-dateutil PyYAML pytz matplotlib numpy requests tzlocal influxdb pandas diff --git a/docs/v1.6.x/qcflow/install_db_machine.md b/docs/v1.6.x/qcflow/install_db_machine.md index d6ff03abc..a79ca5094 100644 --- a/docs/v1.6.x/qcflow/install_db_machine.md +++ b/docs/v1.6.x/qcflow/install_db_machine.md @@ -18,7 +18,7 @@ Last login: ... 2020 from monkeyisland.dyndns.cern.ch ### yum packages -- g++ version 7.0 or higher
+- g++ version 7.0 or higher
```bash sudo yum install -y centos-release-scl @@ -26,7 +26,7 @@ sudo yum install -y devtoolset-7 source /opt/rh/devtoolset-7/enable ``` -- cmake3 +- cmake3 ```bash sudo yum install -y epel-release @@ -35,14 +35,14 @@ sudo yum install -y cmake3 ### Python packages -- python3 version 3.6 or higher +- python3 version 3.6 or higher ```bash $ python3 --version Python 3.6.8 ``` -- python pip packages +- python pip packages ```bash sudo python3 -m pip install arguments coloredlogs Flask Flask-PyMongo Flask-HTTPAuth Flask-Mail pdf2image Pillow prettytable pymongo python-dateutil PyYAML pytz plotly matplotlib numpy requests tzlocal itkdb influxdb pandas diff --git a/docs/v1.6.x/qcflow/nonelectricalbare.md b/docs/v1.6.x/qcflow/nonelectricalbare.md index 3198216a4..c8beac8af 100644 --- a/docs/v1.6.x/qcflow/nonelectricalbare.md +++ b/docs/v1.6.x/qcflow/nonelectricalbare.md @@ -14,10 +14,10 @@ support operations.
If you check the detail for QC-helper, please check it: ### Bare to PCB -- Visual Inspection -- Metrology (Old format) -- Mass -- Glue Flex Attach information +- Visual Inspection +- Metrology (Old format) +- Mass +- Glue Flex Attach information !!! Warning Stages and test items are not current version. We are improving the SW to match newest version of QC flow.
diff --git a/docs/v1.6.x/qcflow/nonelectricalwire.md b/docs/v1.6.x/qcflow/nonelectricalwire.md index d6e3d4245..2092e09b0 100644 --- a/docs/v1.6.x/qcflow/nonelectricalwire.md +++ b/docs/v1.6.x/qcflow/nonelectricalwire.md @@ -15,18 +15,18 @@ QC-helper. ### Wirebonding -- Visual Inspection -- Wirebond info -- Wirebond pull test -- Sensor IV -- SLDO VI -- Pixel Failure Test (Full Electrical Test) +- Visual Inspection +- Wirebond info +- Wirebond pull test +- Sensor IV +- SLDO VI +- Pixel Failure Test (Full Electrical Test) ### Module Properties -- RD53A pull-up register -- IrefTrim for each FE -- PCB-Bare Orientation +- RD53A pull-up register +- IrefTrim for each FE +- PCB-Bare Orientation ## QC-helper diff --git a/docs/v1.6.x/qcflow/register_children.md b/docs/v1.6.x/qcflow/register_children.md index d609c16a5..d30e2b532 100644 --- a/docs/v1.6.x/qcflow/register_children.md +++ b/docs/v1.6.x/qcflow/register_children.md @@ -23,30 +23,30 @@ component from `My Components`: ### Module PCB -- FE chip version: `RD53A` -- Thickness: `Thin` -- ATLAS SN: Check - [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- FE chip version: `RD53A` +- Thickness: `Thin` +- ATLAS SN: Check + [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) ### Module carrier -- Module Carrier Type: 0 -- Usage countdown: 1 -- ATLAS SN: Check - [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- Module Carrier Type: 0 +- Usage countdown: 1 +- ATLAS SN: Check + [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) ### Front-end Chip -- ATLAS SN: Check - [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- ATLAS SN: Check + [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) ### Sensor Tile -- Main vendor: 0 -- Sensor Type or Test Structure: 0 -- Manufacturer serial number: Check - [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) -- Version of component: prototype +- Main vendor: 0 +- Sensor Type or Test Structure: 0 +- Manufacturer serial number: Check + [Spreadsheet](https://docs.google.com/spreadsheets/d/1OqOUhGu_tBYJXXhzD7B5GtiS1nLSQiVCOWlQe9BCIIM/edit?usp=sharing) +- Version of component: prototype !!! Warning If you can not find component type, you need to add component type as one of the components handled by your institute. Please go to your institute diff --git a/docs/v1.6.x/qcflow/scanconsole.md b/docs/v1.6.x/qcflow/scanconsole.md index 8da5c7e20..911510b8c 100644 --- a/docs/v1.6.x/qcflow/scanconsole.md +++ b/docs/v1.6.x/qcflow/scanconsole.md @@ -117,21 +117,21 @@ You can see scan config files in `/Yarr/db-data`: ```json { - "stage": "MODULEWIREBONDING", - "chips": [ - { - "name": "20UPGXF0000000", - "config": "./db-data/20UPGXF0000000.json", - "chipId": 1, - "tx": 0, - "rx": 0 - } - ], - "module": { - "serialNumber": "20UPGXM0100000", - "componentType": "module" - }, - "chipType": "RD53A" + "stage": "MODULEWIREBONDING", + "chips": [ + { + "name": "20UPGXF0000000", + "config": "./db-data/20UPGXF0000000.json", + "chipId": 1, + "tx": 0, + "rx": 0 + } + ], + "module": { + "serialNumber": "20UPGXM0100000", + "componentType": "module" + }, + "chipType": "RD53A" } ``` @@ -148,12 +148,12 @@ $ ./bin/scanConsole -r configs/controller/emuCfg_rd53a.json -c db-data/connectiv Scan items required for Full Electrical Test(Pixel Failure Test) are below: -- std_analogscan -- std_digitalscan -- std_thresholdscan -- std_totscan -- std_noisescan -- std_crosstalkscan +- std_analogscan +- std_digitalscan +- std_thresholdscan +- std_totscan +- std_noisescan +- std_crosstalkscan On the `real module` QC, we need to do a tuning routine: [Electrical testing doc.](https://cds.cern.ch/record/2723333/files/ATL-COM-ITK-2020-020.pdf) diff --git a/docs/v1.6.x/qcflow/setup_for_scan.md b/docs/v1.6.x/qcflow/setup_for_scan.md index 98662442e..584308009 100644 --- a/docs/v1.6.x/qcflow/setup_for_scan.md +++ b/docs/v1.6.x/qcflow/setup_for_scan.md @@ -91,19 +91,19 @@ name to "WIREBONDING". ```json { - "stage": "WIREBONDING", - "chips": [ - { - "config": "./db-data/20UPGRA00000XX.json", - "tx": 0, - "rx": 0 - } - ], - "module": { - "serialNumber": "20UPGRS00000XX", - "componentType": "module" - }, - "chipType": "RD53A" + "stage": "WIREBONDING", + "chips": [ + { + "config": "./db-data/20UPGRA00000XX.json", + "tx": 0, + "rx": 0 + } + ], + "module": { + "serialNumber": "20UPGRS00000XX", + "componentType": "module" + }, + "chipType": "RD53A" } ``` @@ -114,46 +114,46 @@ To include DCS data to the scan result, edit the DCS uploader config file ```json { - "environments": [ - { - "measurement": "Temperature", - "dcsList": [ - { - "key": "temperature", - "data_name": "temp1", - "data_unit": "temp1_unit", - "description": "Room Temperature [C]", - "setting": 28 - }, - { - "key": "temperature", - "data_name": "temp2", - "data_unit": "temp2_unit", - "description": "Board Temperature [C]", - "setting": 28 - } - ] - }, - { - "measurement": "LV", - "dcsList": [ + "environments": [ { - "key": "vddd_voltage", - "data_name": "LV_Voltage", - "data_unit": "LV_Voltage_unit", - "description": "VDDD Voltage [V]", - "setting": 1.75 + "measurement": "Temperature", + "dcsList": [ + { + "key": "temperature", + "data_name": "temp1", + "data_unit": "temp1_unit", + "description": "Room Temperature [C]", + "setting": 28 + }, + { + "key": "temperature", + "data_name": "temp2", + "data_unit": "temp2_unit", + "description": "Board Temperature [C]", + "setting": 28 + } + ] }, { - "key": "vddd_current", - "data_name": "LV_Current", - "data_unit": "LV_Current_unit", - "description": "VDDD Current [A]", - "setting": 1.1 + "measurement": "LV", + "dcsList": [ + { + "key": "vddd_voltage", + "data_name": "LV_Voltage", + "data_unit": "LV_Voltage_unit", + "description": "VDDD Voltage [V]", + "setting": 1.75 + }, + { + "key": "vddd_current", + "data_name": "LV_Current", + "data_unit": "LV_Current_unit", + "description": "VDDD Current [A]", + "setting": 1.1 + } + ] } - ] - } - ] + ] } ``` diff --git a/docs/v1.6.x/qcflow/signoff.md b/docs/v1.6.x/qcflow/signoff.md index 5462ed0ec..493dce688 100644 --- a/docs/v1.6.x/qcflow/signoff.md +++ b/docs/v1.6.x/qcflow/signoff.md @@ -6,19 +6,19 @@ Need to select scans and register those as QC results for an electrical test of this stage. We are currently supporting the following test types and need to select the scans for each item: -- PIXEL_FAILURE_TEST - - std_digitalscan - - std_analogscan - - std_thresholdscan - - std_totscan - - std_noisescan - - std_crosstalk_scan -- READOUT_IN_BASIC_ELECTRICAL_TEST - - std_digitalscan - - std_analogscan - - std_thresholdscan - - std_totscan - - std_discbumpscan.json +- PIXEL_FAILURE_TEST + - std_digitalscan + - std_analogscan + - std_thresholdscan + - std_totscan + - std_noisescan + - std_crosstalk_scan +- READOUT_IN_BASIC_ELECTRICAL_TEST + - std_digitalscan + - std_analogscan + - std_thresholdscan + - std_totscan + - std_discbumpscan.json ### 1-1. Select and Register scans for QC results of electrical tests for this stage diff --git a/docs/v1.6.x/qcflow/upload_itkpdwire.md b/docs/v1.6.x/qcflow/upload_itkpdwire.md index e670acadf..ff46b04d4 100644 --- a/docs/v1.6.x/qcflow/upload_itkpdwire.md +++ b/docs/v1.6.x/qcflow/upload_itkpdwire.md @@ -23,7 +23,7 @@ Tests). So LocalDB will attach scan config files to a module: ### Config Zip: `BestCfg__degree_.zip` -- Chip config files (json file) +- Chip config files (json file) We developed a tool to download `BestCfg__degree_.zip` from ITkPD: [Git](https://gitlab.cern.ch/hirose/ModuleConfigDownloader)
Using diff --git a/docs/v1.6.x/qcflow/upload_resultwire.md b/docs/v1.6.x/qcflow/upload_resultwire.md index 5358e6301..57f8edfde 100644 --- a/docs/v1.6.x/qcflow/upload_resultwire.md +++ b/docs/v1.6.x/qcflow/upload_resultwire.md @@ -10,12 +10,12 @@ select the scans for each item: ### PIXEL_FAILURE_TEST -- std_digitalscan -- std_analogscan -- std_thresholdscan -- std_totscan -- std_noisescan -- std_crosstalk_scan +- std_digitalscan +- std_analogscan +- std_thresholdscan +- std_totscan +- std_noisescan +- std_crosstalk_scan ### 1. Select and Register scans for QC results of electrical tests for this stage diff --git a/docs/v1.6.x/qcflow/viewer.md b/docs/v1.6.x/qcflow/viewer.md index cb94b932a..86995ecaf 100644 --- a/docs/v1.6.x/qcflow/viewer.md +++ b/docs/v1.6.x/qcflow/viewer.md @@ -38,7 +38,7 @@ Cloning into '/root/work/localdb-tools/viewer/plotting-tool'... submodules, we need to clone other ways and compile them. Please input following commands: -- analysis-tool +- analysis-tool ```bash $ cd ~/localdb-tools/viewer @@ -47,7 +47,7 @@ $ cd analysis-tool $ make ``` -- plotting-tool +- plotting-tool ```bash $ cd ~/localdb-tools/viewer @@ -56,7 +56,7 @@ $ cd plotting-tool $ make ``` -- localdb-interface +- localdb-interface ```bash $ cd ~/localdb-tools/viewer/itkpd-interface diff --git a/docs/v1.6.x/script.md b/docs/v1.6.x/script.md index a655c6701..a86978325 100644 --- a/docs/v1.6.x/script.md +++ b/docs/v1.6.x/script.md @@ -4,44 +4,44 @@ ### setup_db.sh -- Description: To set the configuration of Local DB to access in YARR. -- Page: [About setup_db.sh](script/setup-db.md) -- Location: `YARR/localdb/setup_db.sh` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: To set the configuration of Local DB to access in YARR. +- Page: [About setup_db.sh](script/setup-db.md) +- Location: `YARR/localdb/setup_db.sh` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### setup_viewer.sh -- Description: To set the configuration of the viewer application to run. -- Page: [About setup_viewer.sh](script/setup-viewer.md) -- Location: `localdb-tools/viewer/setup_viewer.sh` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: To set the configuration of the viewer application to run. +- Page: [About setup_viewer.sh](script/setup-viewer.md) +- Location: `localdb-tools/viewer/setup_viewer.sh` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ### setup_sync_tool.sh -- Description: To set the configuration of the sync tool to run. -- Page: [About setup_synctool.sh](script/setup_sync_tool.md) -- Location: `localdb-tools/sync-tool/setup_sync_tool.sh` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: To set the configuration of the sync tool to run. +- Page: [About setup_synctool.sh](script/setup_sync_tool.md) +- Location: `localdb-tools/sync-tool/setup_sync_tool.sh` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ### setup_archive_tool.sh -- Description: To set the configuration of the archive tool to run. -- Page: [About setup_archive_tool.sh](script/setup_archive_tool.md) -- Location: `localdb-tools/archive-tool/setup_archive_tool.sh` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: To set the configuration of the archive tool to run. +- Page: [About setup_archive_tool.sh](script/setup_archive_tool.md) +- Location: `localdb-tools/archive-tool/setup_archive_tool.sh` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ## Administrator Scripts ### create_admin.sh -- Description: To create an administrator account in Local DB. -- Page: [About create_admin.sh](script/create_admin.md) -- Location: `localdb-tools/setting/create_admin.sh` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: To create an administrator account in Local DB. +- Page: [About create_admin.sh](script/create_admin.md) +- Location: `localdb-tools/setting/create_admin.sh` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ### upgrade_mongoDB_centos.sh -- Description: _in edit_ -- Page: [About upgrade_mongoDB_centos.sh](script/upgrade_mongodb_centos.md) -- Location: `localdb-tools/scripts/shell/create_admin.sh` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: _in edit_ +- Page: [About upgrade_mongoDB_centos.sh](script/upgrade_mongodb_centos.md) +- Location: `localdb-tools/scripts/shell/create_admin.sh` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) diff --git a/docs/v1.6.x/script/create_admin.md b/docs/v1.6.x/script/create_admin.md index 2c6bf472b..82be60b2f 100644 --- a/docs/v1.6.x/script/create_admin.md +++ b/docs/v1.6.x/script/create_admin.md @@ -6,8 +6,8 @@ account and enable admin functions in the viewer application.
See the [admin functions in the viewer](../tool/viewer.md) to get more about what you can do. -- Location: `localdb-tools/setting/create_admin.sh` -- Syntax: +- Location: `localdb-tools/setting/create_admin.sh` +- Syntax: ```bash $ cd localdb-tools/setting @@ -20,8 +20,8 @@ $ ./create_admin.sh [-i address] 1. Check the configuration of Local DB server 2. Create system user account in MongoDB of Local DB - - Provide username - - Provide password + - Provide username + - Provide password ### Usage diff --git a/docs/v1.6.x/script/setup-db.md b/docs/v1.6.x/script/setup-db.md index 7a7448983..eac778058 100644 --- a/docs/v1.6.x/script/setup-db.md +++ b/docs/v1.6.x/script/setup-db.md @@ -3,8 +3,8 @@ This is a script for setting the configuration of Local DB and checking functions to handle Local DB. -- Location: **YARR/localdb/setup_db.sh** -- Syntax: +- Location: **YARR/localdb/setup_db.sh** +- Syntax: ```bash $ cd YARR @@ -17,11 +17,11 @@ $ ./localdb/setup_db.sh [-i address] 1. Check the [required packages](../installation/requirements-list.md) 2. Check the database config file - - Create `HOME/.yarr/localdb/HOSTNAME_database.json` if not exist + - Create `HOME/.yarr/localdb/HOSTNAME_database.json` if not exist 3. Check the user config file - - Create `HOME/.yarr/localdb/user.json` if not exist + - Create `HOME/.yarr/localdb/user.json` if not exist 4. Check the site config file - - Create `HOME/.yarr/localdb/HOSTNAME_site.json` if not exist + - Create `HOME/.yarr/localdb/HOSTNAME_site.json` if not exist 5. Check the command 6. Check the DB connection diff --git a/docs/v1.6.x/script/setup-viewer.md b/docs/v1.6.x/script/setup-viewer.md index 8f30fddb1..9383916f6 100644 --- a/docs/v1.6.x/script/setup-viewer.md +++ b/docs/v1.6.x/script/setup-viewer.md @@ -6,8 +6,8 @@ plots on web browser.
This script creates the [viewer config file](../config/viewer.md), and you can start the viewer application with it. -- Location: `localdb-tools/viewer/setup_viewer.sh` -- Syntax: +- Location: `localdb-tools/viewer/setup_viewer.sh` +- Syntax: ```bash $ cd localdb-tools/viewer @@ -20,11 +20,11 @@ $ ./setup_viewer.sh [-i address] 1. Check the [required packages](../installation/requirements-list.md) 2. Check the configuration of Local DB server - - Display the configuration - - Prompt for confirmatio (Proceed if y or exit if n) + - Display the configuration + - Prompt for confirmatio (Proceed if y or exit if n) 3. Check whether to enable admin function - - Prompt for confirmation (Proceed if y or skip if n) - - User authorization (Proceed on success, or exit on failure) + - Prompt for confirmation (Proceed if y or skip if n) + - User authorization (Proceed on success, or exit on failure) 4. Create config file (admin_conf.yml if the admin function is enabled, or user_conf.yml if not disabled) 5. Install and compile the diff --git a/docs/v1.6.x/script/setup_archive_tool.md b/docs/v1.6.x/script/setup_archive_tool.md index edb8584c7..ecd7a970e 100644 --- a/docs/v1.6.x/script/setup_archive_tool.md +++ b/docs/v1.6.x/script/setup_archive_tool.md @@ -5,8 +5,8 @@ This is a script for setting the configuration of the [archive tool config file](../config/archive.md), and you can run the [archive tool](../tool/archive.md) with it. -- Location: `localdb-tools/archive-tool/setup_archive_tool.sh` -- Syntax: +- Location: `localdb-tools/archive-tool/setup_archive_tool.sh` +- Syntax: ```bash $ cd localdb-tools/archive-tool diff --git a/docs/v1.6.x/script/setup_sync_tool.md b/docs/v1.6.x/script/setup_sync_tool.md index 7c75de293..5d860516a 100644 --- a/docs/v1.6.x/script/setup_sync_tool.md +++ b/docs/v1.6.x/script/setup_sync_tool.md @@ -5,8 +5,8 @@ This is a script for setting the configuration of the [synchronization tool config file](../config/sync.md), and you can run the [synchronization tool](../tool/sync.md) with it. -- Location: `localdb-tools/sync-tool/setup_sync_tool.sh` -- Syntax: +- Location: `localdb-tools/sync-tool/setup_sync_tool.sh` +- Syntax: ```bash $ cd localdb-tools/sync-tool diff --git a/docs/v1.6.x/structure.md b/docs/v1.6.x/structure.md index e52c4bb88..562fcfcfd 100644 --- a/docs/v1.6.x/structure.md +++ b/docs/v1.6.x/structure.md @@ -1,9 +1,9 @@ ## Database name list -- **localdb**
Main database for YARR DB +- **localdb**
Main database for YARR DB -- **localdbtools**
Database for using in localDB tools e.g.) - _synchronization DB_ function +- **localdbtools**
Database for using in localDB tools e.g.) + _synchronization DB_ function ## Data Structure @@ -13,28 +13,28 @@ ### **localdb** -- [**chip**](structure/chip.md)
Tested chip information +- [**chip**](structure/chip.md)
Tested chip information -- [**component**](structure/component.md)
Registered component - (chips/modules) information +- [**component**](structure/component.md)
Registered component + (chips/modules) information -- [**childParentRelation**](structure/childParentRelation.md)
Relationship - between chips and modules +- [**childParentRelation**](structure/childParentRelation.md)
+ Relationship between chips and modules -- [**testRun**](structure/testRun.md)
Test information +- [**testRun**](structure/testRun.md)
Test information -- [**componentTestRun**](structure/componentTestRun.md)
Relationship - between chip/component and testRun +- [**componentTestRun**](structure/componentTestRun.md)
Relationship + between chip/component and testRun -- [**config**](structure/config.md)
Config information +- [**config**](structure/config.md)
Config information -- [**user**](structure/user.md)
User information +- [**user**](structure/user.md)
User information -- [**institution**](structure/institution.md)
Site information +- [**institution**](structure/institution.md)
Site information -- [**environment**](structure/environment.md)
DCS information +- [**environment**](structure/environment.md)
DCS information -- [**fs.files**](structure/GridFS.md) (GridFS)
Binary (text) File - information +- [**fs.files**](structure/GridFS.md) (GridFS)
Binary (text) File + information -- [**fs.chunks**](structure/GridFS.md) (GridFS)
Binary (text) File chunks +- [**fs.chunks**](structure/GridFS.md) (GridFS)
Binary (text) File chunks diff --git a/docs/v1.6.x/structure/GridFS.md b/docs/v1.6.x/structure/GridFS.md index eb1018685..3e591fc4e 100644 --- a/docs/v1.6.x/structure/GridFS.md +++ b/docs/v1.6.x/structure/GridFS.md @@ -4,23 +4,23 @@ e.g,) ```json { - "_id": "5cb6db928b6de04a4a3217a5", - "length": 287, - "chunkSize": 261120, - "uploadDate": "2019-04-17T07:53:56.142Z", - "filename": "controller.json", - "dbVersion": 0.9, - "hash": "34d1f52eab9b1f754d9594b698992a782b865499" + "_id": "5cb6db928b6de04a4a3217a5", + "length": 287, + "chunkSize": 261120, + "uploadDate": "2019-04-17T07:53:56.142Z", + "filename": "controller.json", + "dbVersion": 0.9, + "hash": "34d1f52eab9b1f754d9594b698992a782b865499" } ``` -- `_id` : document id -- `length` -- `chunkSize` -- `uploadDate` -- `filename` -- `dbVersion` : the version of Database -- `hash` : hash value of this data (written in only config files) +- `_id` : document id +- `length` +- `chunkSize` +- `uploadDate` +- `filename` +- `dbVersion` : the version of Database +- `hash` : hash value of this data (written in only config files) ### fs.chunks @@ -28,17 +28,17 @@ e.g.) ```json { - "_id": "5c13532f8591295c0062b80b", - "files_id": "5cb6db928b6de04a4a3217a5", - "n": 0, - "data": "iVBORw0KGgoAAAANSUhEUgAABQAAAAQACAMAAACJTQRxAAADAFB" + "_id": "5c13532f8591295c0062b80b", + "files_id": "5cb6db928b6de04a4a3217a5", + "n": 0, + "data": "iVBORw0KGgoAAAANSUhEUgAABQAAAAQACAMAAACJTQRxAAADAFB" } ``` -- `_id` : document id -- `files_id` : file id (document id in fs.files) -- `n` -- `data` -- `dbVersion` : the version of Database +- `_id` : document id +- `files_id` : file id (document id in fs.files) +- `n` +- `data` +- `dbVersion` : the version of Database About mongoDB GridFS https://docs.mongodb.com/manual/core/gridfs/ diff --git a/docs/v1.6.x/structure/childParentRelation.md b/docs/v1.6.x/structure/childParentRelation.md index 2c20ebe2a..e3edc7c55 100644 --- a/docs/v1.6.x/structure/childParentRelation.md +++ b/docs/v1.6.x/structure/childParentRelation.md @@ -2,30 +2,30 @@ e.g.) ```json { - "_id": "5cb6db418b6de04719047504", - "sys": { - "rev": 0, - "cts": "2019-04-17T07:52:34.099Z", - "mts": "2019-04-17T07:52:34.099Z" - }, - "parent": "5cb6db408b6de04719047502", - "child": "5cb6db418b6de04719047503", - "chipId": 0, - "status": "active", - "dbVersion": 1.0 + "_id": "5cb6db418b6de04719047504", + "sys": { + "rev": 0, + "cts": "2019-04-17T07:52:34.099Z", + "mts": "2019-04-17T07:52:34.099Z" + }, + "parent": "5cb6db408b6de04719047502", + "child": "5cb6db418b6de04719047503", + "chipId": 0, + "status": "active", + "dbVersion": 1.0 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `parent` : document id of the parent module -- `child` : document id of one of the children chips -- `chipId` : chip ID (only written in the document relating "Module" and - "Front-end Chip") -- `status` : whether active or dead relationship -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `parent` : document id of the parent module +- `child` : document id of one of the children chips +- `chipId` : chip ID (only written in the document relating "Module" and + "Front-end Chip") +- `status` : whether active or dead relationship +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/chip.md b/docs/v1.6.x/structure/chip.md index 05e439c3b..013cd7c05 100644 --- a/docs/v1.6.x/structure/chip.md +++ b/docs/v1.6.x/structure/chip.md @@ -1,28 +1,28 @@ ```json { - "_id": "5d434398aa1d05a330d6b851", - "sys": { - "cts": "2019-08-01T19:55:04.087Z", - "mts": "2019-08-01T19:55:04.087Z", - "rev": 0 - }, - "name": "FEI4B-001_chip1", - "chipId": 1, - "chipType": "FE-I4B", - "componentType": "front-end_chip", - "dbVersion": 1 + "_id": "5d434398aa1d05a330d6b851", + "sys": { + "cts": "2019-08-01T19:55:04.087Z", + "mts": "2019-08-01T19:55:04.087Z", + "rev": 0 + }, + "name": "FEI4B-001_chip1", + "chipId": 1, + "chipType": "FE-I4B", + "componentType": "front-end_chip", + "dbVersion": 1 } ``` --- -- `_id` : document id (unique value created by MongoDB system) -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `name` : the name of this chip (should be serial number) -- `chipId` : chip ID -- `chipType` : the asic type of the chip -- `componentType` : the type of component ("front-end_chip") -- `dbVersion` : the version of Database +- `_id` : document id (unique value created by MongoDB system) +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `name` : the name of this chip (should be serial number) +- `chipId` : chip ID +- `chipType` : the asic type of the chip +- `componentType` : the type of component ("front-end_chip") +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/component.md b/docs/v1.6.x/structure/component.md index 213b11655..404b62494 100644 --- a/docs/v1.6.x/structure/component.md +++ b/docs/v1.6.x/structure/component.md @@ -2,22 +2,22 @@ e.g.) chip component ```json { - "_id": "5d434f6d28a4fe3456f0c6bc", - "sys": { - "cts": "2019-08-01T20:45:33.135Z", - "mts": "2019-08-01T20:45:33.135Z", - "rev": 0 - }, - "serialNumber": "RD53A-001_chip1", - "componentType": "front-end_chip", - "chipType": "RD53A", - "name": "RD53A-001_chip1", - "chipId": 0, - "address": "5d434270aeeeeffb7d96892d", - "user_id": "5d434270aeeeeffb7d96892e", - "children": -1, - "proDB": false, - "dbVersion": 1 + "_id": "5d434f6d28a4fe3456f0c6bc", + "sys": { + "cts": "2019-08-01T20:45:33.135Z", + "mts": "2019-08-01T20:45:33.135Z", + "rev": 0 + }, + "serialNumber": "RD53A-001_chip1", + "componentType": "front-end_chip", + "chipType": "RD53A", + "name": "RD53A-001_chip1", + "chipId": 0, + "address": "5d434270aeeeeffb7d96892d", + "user_id": "5d434270aeeeeffb7d96892e", + "children": -1, + "proDB": false, + "dbVersion": 1 } ``` @@ -25,40 +25,40 @@ e.g.) module component ```json { - "_id": "5d434f6d28a4fe3456f0c6bb", - "sys": { - "cts": "2019-08-01T20:45:33.134Z", - "mts": "2019-08-01T20:45:33.134Z", - "rev": 0 - }, - "serialNumber": "RD53A-001", - "componentType": "module", - "chipType": "RD53A", - "name": "RD53A-001", - "chipId": -1, - "address": "5d434270aeeeeffb7d96892d", - "user_id": "5d434270aeeeeffb7d96892e", - "children": 1, - "proDB": false, - "dbVersion": 1 + "_id": "5d434f6d28a4fe3456f0c6bb", + "sys": { + "cts": "2019-08-01T20:45:33.134Z", + "mts": "2019-08-01T20:45:33.134Z", + "rev": 0 + }, + "serialNumber": "RD53A-001", + "componentType": "module", + "chipType": "RD53A", + "name": "RD53A-001", + "chipId": -1, + "address": "5d434270aeeeeffb7d96892d", + "user_id": "5d434270aeeeeffb7d96892e", + "children": 1, + "proDB": false, + "dbVersion": 1 } ``` --- -- `_id` : document id (unique value created by MongoDB system) -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `serialNumber` : the serial number of this component -- `chipType` : the asic type of the chip -- `componentType` : the type of component (e.g. "module", "front-end_chip") -- `chipId` : chip ID -- `children` : the number of children which this component has -- `address` : document id of the site where you register this component in - 'institution' collection -- `user_id` : document id of the user who registered this component in 'user' - collection -- `proDB` : boolean -- `dbVersion` : the version of Database +- `_id` : document id (unique value created by MongoDB system) +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `serialNumber` : the serial number of this component +- `chipType` : the asic type of the chip +- `componentType` : the type of component (e.g. "module", "front-end_chip") +- `chipId` : chip ID +- `children` : the number of children which this component has +- `address` : document id of the site where you register this component in + 'institution' collection +- `user_id` : document id of the user who registered this component in 'user' + collection +- `proDB` : boolean +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/componentTestRun.md b/docs/v1.6.x/structure/componentTestRun.md index 3bc5068cd..fd89336c5 100644 --- a/docs/v1.6.x/structure/componentTestRun.md +++ b/docs/v1.6.x/structure/componentTestRun.md @@ -2,79 +2,79 @@ e.g.) ```json { - "_id": "5d434270aeeeeffb7d968931", - "sys": { - "mts": "2019-08-01T19:51:46.917Z", - "rev": 1 - }, - "component": "...", - "testRun": "5d434270aeeeeffb7d968930", - "chip": "5d434270aeeeeffb7d96892f", - "name": "JohnDoe_1", - "config": "rd53a_test.json", - "enable": 1, - "locked": 0, - "rx": 0, - "tx": 0, - "geomId": 0, - "attachments": [ - { - "code": "5d4342d3aa3e9a2c43ec77a0", - "dateTime": "2019-08-01T19:51:47.095Z", - "title": "EnMask", - "description": "describe", - "contentType": "dat", - "filename": "EnMask.dat" + "_id": "5d434270aeeeeffb7d968931", + "sys": { + "mts": "2019-08-01T19:51:46.917Z", + "rev": 1 }, - { - "code": "5d4342d3aa3e9a2c43ec77a2", - "dateTime": "2019-08-01T19:51:47.099Z", - "title": "OccupancyMap", - "description": "describe", - "contentType": "dat", - "filename": "OccupancyMap.dat" - }, - { - "code": "5d4342d3aa3e9a2c43ec77a5", - "dateTime": "2019-08-01T19:51:47.102Z", - "title": "L1Dist", - "description": "describe", - "contentType": "dat", - "filename": "L1Dist.dat" - } - ], - "beforeCfg": "5d4342d2aa3e9a2c43ec779e", - "afterCfg": "5d4342d3aa3e9a2c43ec779f", - "dbVersion": 1 + "component": "...", + "testRun": "5d434270aeeeeffb7d968930", + "chip": "5d434270aeeeeffb7d96892f", + "name": "JohnDoe_1", + "config": "rd53a_test.json", + "enable": 1, + "locked": 0, + "rx": 0, + "tx": 0, + "geomId": 0, + "attachments": [ + { + "code": "5d4342d3aa3e9a2c43ec77a0", + "dateTime": "2019-08-01T19:51:47.095Z", + "title": "EnMask", + "description": "describe", + "contentType": "dat", + "filename": "EnMask.dat" + }, + { + "code": "5d4342d3aa3e9a2c43ec77a2", + "dateTime": "2019-08-01T19:51:47.099Z", + "title": "OccupancyMap", + "description": "describe", + "contentType": "dat", + "filename": "OccupancyMap.dat" + }, + { + "code": "5d4342d3aa3e9a2c43ec77a5", + "dateTime": "2019-08-01T19:51:47.102Z", + "title": "L1Dist", + "description": "describe", + "contentType": "dat", + "filename": "L1Dist.dat" + } + ], + "beforeCfg": "5d4342d2aa3e9a2c43ec779e", + "afterCfg": "5d4342d3aa3e9a2c43ec779f", + "dbVersion": 1 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `component` : document id of this chip in 'componentTestRun' collection -- `testRun` : document id of this test in 'testRun' collection -- `chip` : document id of this chip in 'chip' collection -- `name` : the name of this chip (should be serialNumber) -- `chipId` : chip ID -- `geomId` : geometorical ID (If not specified, the order written in the - connectivity) -- `tx` : tx channel of this component in this test -- `rx` : rx channel of this component in this test -- `config` : the name of the chip config file -- `attachments` : the output data of Yarr in this test - - `code` : data id (document id in fs.files) - - `dateTime` : uploaded date - - `title` : title of the plot - - `description` - - `contentType` : the format of this data - - `filename` : the name of this data -- `beforeCfg` : chip config (before the test) id (document id in 'config' - collection) -- `afterCfg` : chip config (after the test) id (document id in 'config' - collection) -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `component` : document id of this chip in 'componentTestRun' collection +- `testRun` : document id of this test in 'testRun' collection +- `chip` : document id of this chip in 'chip' collection +- `name` : the name of this chip (should be serialNumber) +- `chipId` : chip ID +- `geomId` : geometorical ID (If not specified, the order written in the + connectivity) +- `tx` : tx channel of this component in this test +- `rx` : rx channel of this component in this test +- `config` : the name of the chip config file +- `attachments` : the output data of Yarr in this test + - `code` : data id (document id in fs.files) + - `dateTime` : uploaded date + - `title` : title of the plot + - `description` + - `contentType` : the format of this data + - `filename` : the name of this data +- `beforeCfg` : chip config (before the test) id (document id in 'config' + collection) +- `afterCfg` : chip config (after the test) id (document id in 'config' + collection) +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/config.md b/docs/v1.6.x/structure/config.md index 83fd2856a..17230be78 100644 --- a/docs/v1.6.x/structure/config.md +++ b/docs/v1.6.x/structure/config.md @@ -2,31 +2,31 @@ e.g.) ```json { - "_id": "5cb6dedb8b6de0667e48d5ae", - "sys": { - "rev": 0, - "cts": "2019-04-17T08:07:55.710Z", - "mts": "2019-04-17T08:07:55.710Z" - }, - "filename": "afterCfg.json", - "chipType": "RD53A", - "title": "chipCfg", - "format": "fs.files", - "data_id": "5cb6dedb8b6de0667e48d5aa", - "dbVersion": 1 + "_id": "5cb6dedb8b6de0667e48d5ae", + "sys": { + "rev": 0, + "cts": "2019-04-17T08:07:55.710Z", + "mts": "2019-04-17T08:07:55.710Z" + }, + "filename": "afterCfg.json", + "chipType": "RD53A", + "title": "chipCfg", + "format": "fs.files", + "data_id": "5cb6dedb8b6de0667e48d5aa", + "dbVersion": 1 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `filename` : the name of this config file -- `chipType` : the asic type of the chip -- `title` : the title of this config file -- `format` : upload format (collection name) -- `data_id` : data id (document id in collection written at `format`) -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `filename` : the name of this config file +- `chipType` : the asic type of the chip +- `title` : the title of this config file +- `format` : upload format (collection name) +- `data_id` : data id (document id in collection written at `format`) +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/environment.md b/docs/v1.6.x/structure/environment.md index 7b39bbac7..126503f17 100644 --- a/docs/v1.6.x/structure/environment.md +++ b/docs/v1.6.x/structure/environment.md @@ -2,55 +2,55 @@ e.g.) ```json { - "_id": "5d3a4dfec4110ac3a1ef2bcf", - "dbVersion": 1, - "sys": { - "cts": "2019-07-26T00:49:02.506Z", - "mts": "2019-07-26T00:49:02.506Z", - "rev": 0 - }, - "vddd_voltage": [ - { - "data": [ + "_id": "5d3a4dfec4110ac3a1ef2bcf", + "dbVersion": 1, + "sys": { + "cts": "2019-07-26T00:49:02.506Z", + "mts": "2019-07-26T00:49:02.506Z", + "rev": 0 + }, + "vddd_voltage": [ { - "date": "2019-06-24T11:49:13Z", - "value": 10 - }, - { - "date": "2019-06-24T11:49:23Z", - "value": 11 - }, - { - "date": "2019-06-24T11:49:33Z", - "value": 12 - }, - { - "date": "2019-06-24T11:49:43Z", - "value": 13 + "data": [ + { + "date": "2019-06-24T11:49:13Z", + "value": 10 + }, + { + "date": "2019-06-24T11:49:23Z", + "value": 11 + }, + { + "date": "2019-06-24T11:49:33Z", + "value": 12 + }, + { + "date": "2019-06-24T11:49:43Z", + "value": 13 + } + ], + "description": "VDDD Voltage [V]", + "mode": "null", + "setting": "10", + "num": 0 } - ], - "description": "VDDD Voltage [V]", - "mode": "null", - "setting": "10", - "num": 0 - } - ] + ] } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `"DCS KEY"` : DCS keyword written in database config file - - `data` : sets of `date` and `value` - - `date` : datetime - - `value` : DCS data value - - `description` : description of DCS data - - `mode` : DCS setting mode - - `setting` : DCS setting value - - `num` : DCS key number (the combination of "key" and "num" specifies which - data in the DCS data file) +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `"DCS KEY"` : DCS keyword written in database config file + - `data` : sets of `date` and `value` + - `date` : datetime + - `value` : DCS data value + - `description` : description of DCS data + - `mode` : DCS setting mode + - `setting` : DCS setting value + - `num` : DCS key number (the combination of "key" and "num" specifies + which data in the DCS data file) diff --git a/docs/v1.6.x/structure/institution.md b/docs/v1.6.x/structure/institution.md index 80e7ef6cf..99e08bd90 100644 --- a/docs/v1.6.x/structure/institution.md +++ b/docs/v1.6.x/structure/institution.md @@ -2,27 +2,27 @@ e.g.) ```json { - "_id": "5d3a3d8dcf401b22f5d9b6c6", - "sys": { - "cts": "2019-07-25T23:38:53.612Z", - "mts": "2019-07-25T23:38:53.612Z", - "rev": 0 - }, - "address": "XX:XX:XX:XX:XX:XX", - "institution": "Tokyo_Institute_of_Technology", - "hostname": "lazulite", - "dbVersion": 1 + "_id": "5d3a3d8dcf401b22f5d9b6c6", + "sys": { + "cts": "2019-07-25T23:38:53.612Z", + "mts": "2019-07-25T23:38:53.612Z", + "rev": 0 + }, + "address": "XX:XX:XX:XX:XX:XX", + "institution": "Tokyo_Institute_of_Technology", + "hostname": "lazulite", + "dbVersion": 1 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `address` : MAC address of the machine -- `institution` : the name of institution -- `hostname` : hostname/name of the machine -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `address` : MAC address of the machine +- `institution` : the name of institution +- `hostname` : hostname/name of the machine +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/testRun.md b/docs/v1.6.x/structure/testRun.md index 32081c6fe..4b49af557 100644 --- a/docs/v1.6.x/structure/testRun.md +++ b/docs/v1.6.x/structure/testRun.md @@ -4,75 +4,75 @@ e.g.) ```json { - "_id": "5d4343d3a223442acd80b209", - "sys": { - "cts": "2019-08-01T19:56:03.819Z", - "mts": "2019-08-01T19:56:03.819Z", - "rev": 0 - }, - "exec": "-c configs/connectivity/example_rd53a_setup.json -r configs/controller/specCfg.json -s configs/scans/rd53a/std_digitalscan.json -W ", - "runNumber": 163, - "testType": "std_digitalscan", - "timestamp": "2019-07-30_14:19:08", - "startTime": "2019-07-30T21:19:08Z", - "finishTime": "2019-07-30T21:19:12Z", - "address": "5d434270aeeeeffb7d96892d", - "user_id": "5d434270aeeeeffb7d96892e", - "targetCharge": -1, - "targetTot": -1, - "stage": "...", - "chipType": "RD53A", - "passed": true, - "qcTest": false, - "qaTest": false, - "summary": false, - "stopwatch": { - "analysis": 594, - "config": 36, - "processing": 3, - "scan": 2832 - }, - "environment": "...", - "plots": ["OccupancyMap", "EnMask", "L1Dist"], - "ctrlCfg": "5d4343d3a223442acd80b20c", - "scanCfg": "5d4343d3a223442acd80b212", - "dbCfg": "5d4343d3a223442acd80b20f", - "siteCfg": "5d4343d3a223442acd80b210", - "userCfg": "5d4343d3a223442acd80b211", - "dbVersion": 1 + "_id": "5d4343d3a223442acd80b209", + "sys": { + "cts": "2019-08-01T19:56:03.819Z", + "mts": "2019-08-01T19:56:03.819Z", + "rev": 0 + }, + "exec": "-c configs/connectivity/example_rd53a_setup.json -r configs/controller/specCfg.json -s configs/scans/rd53a/std_digitalscan.json -W ", + "runNumber": 163, + "testType": "std_digitalscan", + "timestamp": "2019-07-30_14:19:08", + "startTime": "2019-07-30T21:19:08Z", + "finishTime": "2019-07-30T21:19:12Z", + "address": "5d434270aeeeeffb7d96892d", + "user_id": "5d434270aeeeeffb7d96892e", + "targetCharge": -1, + "targetTot": -1, + "stage": "...", + "chipType": "RD53A", + "passed": true, + "qcTest": false, + "qaTest": false, + "summary": false, + "stopwatch": { + "analysis": 594, + "config": 36, + "processing": 3, + "scan": 2832 + }, + "environment": "...", + "plots": ["OccupancyMap", "EnMask", "L1Dist"], + "ctrlCfg": "5d4343d3a223442acd80b20c", + "scanCfg": "5d4343d3a223442acd80b212", + "dbCfg": "5d4343d3a223442acd80b20f", + "siteCfg": "5d4343d3a223442acd80b210", + "userCfg": "5d4343d3a223442acd80b211", + "dbVersion": 1 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `exec` : command line -- `runNumber` : the run number of this test -- `testType` : the name of this test -- `timestamp` : timestamp -- `startTime` : start time of the test -- `finishTime` : finish time of the test -- `address` : document id of the production site in 'institution' collection -- `user_id` : document id of the user in 'user' collection -- `targetCharge` : the target of the charge in tuning -- `targetTot` : the target of the ToT in tuning -- `stage` : the process stage -- `chipType` : asic type -- `passed` : boolean -- `qcTest` : boolean -- `qaTest` : boolean -- `summary` : boolean -- `stopwatch` : -- `environment` : document id of the environment data in 'environment' - collection -- `plots` : names of output plots after scan -- `ctrlCfg` : controller config id (document id in 'config' collection) -- `scanCfg`: scan config id (document id in 'config' collection) -- `dbCfg` : database config id (document id in 'config' collection) -- `siteCfg` : site config id (document id in 'config' collection) -- `userCfg` : user config id (document id in 'config' collection) -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `exec` : command line +- `runNumber` : the run number of this test +- `testType` : the name of this test +- `timestamp` : timestamp +- `startTime` : start time of the test +- `finishTime` : finish time of the test +- `address` : document id of the production site in 'institution' collection +- `user_id` : document id of the user in 'user' collection +- `targetCharge` : the target of the charge in tuning +- `targetTot` : the target of the ToT in tuning +- `stage` : the process stage +- `chipType` : asic type +- `passed` : boolean +- `qcTest` : boolean +- `qaTest` : boolean +- `summary` : boolean +- `stopwatch` : +- `environment` : document id of the environment data in 'environment' + collection +- `plots` : names of output plots after scan +- `ctrlCfg` : controller config id (document id in 'config' collection) +- `scanCfg`: scan config id (document id in 'config' collection) +- `dbCfg` : database config id (document id in 'config' collection) +- `siteCfg` : site config id (document id in 'config' collection) +- `userCfg` : user config id (document id in 'config' collection) +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/structure/user.md b/docs/v1.6.x/structure/user.md index 74a21013d..5b6cea753 100644 --- a/docs/v1.6.x/structure/user.md +++ b/docs/v1.6.x/structure/user.md @@ -2,33 +2,33 @@ e.g.) ```json { - "_id": "5cb6dace8b6de042ef053b72", - "sys": { - "rev": 0, - "cts": "2019-04-17T07:50:39.122Z", - "mts": "2019-04-17T07:50:39.122Z" - }, - "userName": "arisa_kubota", - "institution": "tokyo_institute_of_technology", - "description": "default", - "USER": "akubata", - "HOSTNAME": "lazulite", - "userType": "readWrite", - "dbVersion": 1.0 + "_id": "5cb6dace8b6de042ef053b72", + "sys": { + "rev": 0, + "cts": "2019-04-17T07:50:39.122Z", + "mts": "2019-04-17T07:50:39.122Z" + }, + "userName": "arisa_kubota", + "institution": "tokyo_institute_of_technology", + "description": "default", + "USER": "akubata", + "HOSTNAME": "lazulite", + "userType": "readWrite", + "dbVersion": 1.0 } ``` --- -- `_id` : document id -- `sys` : system information of this document - - `rev` : the number of revision - - `cts` : created date - - `mts` : modified date -- `userName` : the name of this user (\_) -- `institution` : the name of institution where user belongs -- `description` : specific description of this user -- `USER` : the user account name of the machine -- `HOSTNAME` : the hostname of the machine -- `userType` : the authority of this user -- `dbVersion` : the version of Database +- `_id` : document id +- `sys` : system information of this document + - `rev` : the number of revision + - `cts` : created date + - `mts` : modified date +- `userName` : the name of this user (\_) +- `institution` : the name of institution where user belongs +- `description` : specific description of this user +- `USER` : the user account name of the machine +- `HOSTNAME` : the hostname of the machine +- `userType` : the authority of this user +- `dbVersion` : the version of Database diff --git a/docs/v1.6.x/tool.md b/docs/v1.6.x/tool.md index 70eb7145d..236d252d2 100644 --- a/docs/v1.6.x/tool.md +++ b/docs/v1.6.x/tool.md @@ -4,55 +4,55 @@ ### scanConsole -- Description: To test the performance for a/some chip(s). -- Page: [About scanConsole](tool/scanconsole.md) -- Location: `YARR/bin/scanConsole` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: To test the performance for a/some chip(s). +- Page: [About scanConsole](tool/scanconsole.md) +- Location: `YARR/bin/scanConsole` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### DB Accessor -- Description: To handle (upload/retrieve) data in Local DB. -- Page: [About DB Accessor](tool/accessor.md) -- Location: `YARR/bin/dbAccessor` -- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) +- Description: To handle (upload/retrieve) data in Local DB. +- Page: [About DB Accessor](tool/accessor.md) +- Location: `YARR/bin/dbAccessor` +- Git Repository: [YARR](https://gitlab.cern.ch/YARR/YARR) ### Viewer Application -- Description: To check/edit data in Local DB on browser. -- Page: [About Viewer Application](tool/viewer.md) -- Location: `localdb-tools/viewer` -- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) +- Description: To check/edit data in Local DB on browser. +- Page: [About Viewer Application](tool/viewer.md) +- Location: `localdb-tools/viewer` +- Git Repository: [localdb-tools](https://gitlab.cern.ch/YARR/localdb-tools) ## Advanced Functions ### Synchronization Tool -- Description: To push/pull/share data with the other Local DB or Master Server - (Centralize Local DB). -- Page: [About Synchronization Tool](tool/sync.md) -- Location: `localdb-tools/sync-tool` +- Description: To push/pull/share data with the other Local DB or Master + Server (Centralize Local DB). +- Page: [About Synchronization Tool](tool/sync.md) +- Location: `localdb-tools/sync-tool` ### Archive Tool -- Description: To create archive tar.gz file for Local DB back-up. -- Page: [About Archive Tool](tool/archive.md) -- Location: `localdb-tools/archive-tool` +- Description: To create archive tar.gz file for Local DB back-up. +- Page: [About Archive Tool](tool/archive.md) +- Location: `localdb-tools/archive-tool` ### Uploader -- Description: To upload data (test data, chip data, user data, site data ...) - into Local DB. -- Page: [About Upload Tool](tool/upload.md) -- Location: `YARR/localdb` +- Description: To upload data (test data, chip data, user data, site data ...) + into Local DB. +- Page: [About Upload Tool](tool/upload.md) +- Location: `YARR/localdb` ### Retriever -- Description: To retrieve data (data log, data files) from Local DB. -- Page: [About Retrieve Tool](tool/retrieve.md) -- Location: `YARR/localdb` +- Description: To retrieve data (data log, data files) from Local DB. +- Page: [About Retrieve Tool](tool/retrieve.md) +- Location: `YARR/localdb` ### ITkPD Interface -- Description: To communicate with ITkPD. -- Page: [About ITkPD Interface](tool/itkpd-interface.md) -- Location: `localdb-tools/itkpd-interface` +- Description: To communicate with ITkPD. +- Page: [About ITkPD Interface](tool/itkpd-interface.md) +- Location: `localdb-tools/itkpd-interface` diff --git a/docs/v1.6.x/tool/accessor.md b/docs/v1.6.x/tool/accessor.md index d2f2a0ee2..491357e4c 100644 --- a/docs/v1.6.x/tool/accessor.md +++ b/docs/v1.6.x/tool/accessor.md @@ -12,26 +12,28 @@ Local DB or download data locally from Local DB easily by using this command. ## 1. Command -- Location: **YARR/bin/dbAccessor** -- Syntax: +- Location: **YARR/bin/dbAccessor** +- Syntax: ```bash $ cd YARR $ ./bin/dbAccessor <-command> [-option] ``` -- Commands: - - [dbAccessor -N](accessor/n.md): Check the connection to Local DB - - [dbAccessor -S](accessor/s.md): Upload scan data from scan result directory - into Local DB - - [dbAccessor -E](accessor/e.md): Upload DCS data from data files into Local - DB - - [dbAccessor -F](accessor/f.md): Upload DCS data from influxDB into Local DB - - [dbAccessor -R](accessor/r.md): Upload scan/DCS data recorded in cache into - Local DB - - [dbAccessor -D](accessor/d.md): Retrieve scan data from Local DB - - [dbAccessor -C](accessor/c.md): Register non-QC componnet data into Local DB - - [dbAccessor -L](accessor/l.md): Display log of the scan data in Local DB +- Commands: + - [dbAccessor -N](accessor/n.md): Check the connection to Local DB + - [dbAccessor -S](accessor/s.md): Upload scan data from scan result + directory into Local DB + - [dbAccessor -E](accessor/e.md): Upload DCS data from data files into + Local DB + - [dbAccessor -F](accessor/f.md): Upload DCS data from influxDB into Local + DB + - [dbAccessor -R](accessor/r.md): Upload scan/DCS data recorded in cache + into Local DB + - [dbAccessor -D](accessor/d.md): Retrieve scan data from Local DB + - [dbAccessor -C](accessor/c.md): Register non-QC componnet data into + Local DB + - [dbAccessor -L](accessor/l.md): Display log of the scan data in Local DB ## 2. Getting start diff --git a/docs/v1.6.x/tool/accessor/c.md b/docs/v1.6.x/tool/accessor/c.md index 527032c52..5103bcfa7 100644 --- a/docs/v1.6.x/tool/accessor/c.md +++ b/docs/v1.6.x/tool/accessor/c.md @@ -30,27 +30,27 @@ $ ./bin/dbAccessor -C **Command Line Arguments** -- **`-C`**
Sets command to download scan data. -- **`-c `**
Specifies the path to - [component config file](../../config/component.md) to register.
The - [component config](../../config/component.md) is similar as the - [connectivity config](../../config/connectivity.md) but need to fill - "serialNumber" and "chipId" of the component. +- **`-C`**
Sets command to download scan data. +- **`-c `**
Specifies the path to + [component config file](../../config/component.md) to register.
The + [component config](../../config/component.md) is similar as the + [connectivity config](../../config/connectivity.md) but need to fill + "serialNumber" and "chipId" of the component. **Additional options** -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md). -- **`-u `**
Specifies the path to - [user config file](../../config/user.md)
If -u is not specified, - dbAccessor sets `HOME/.yarr/localdb/user.json` as - [user config file](../../config/user.md). -- **`-i `**
Specifies the path to - [site config file](../../config/site.md)
If -i is not specified, - dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_site.json` as - [site config file](../../config/site.md). +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md). +- **`-u `**
Specifies the path to + [user config file](../../config/user.md)
If -u is not specified, + dbAccessor sets `HOME/.yarr/localdb/user.json` as + [user config file](../../config/user.md). +- **`-i `**
Specifies the path to + [site config file](../../config/site.md)
If -i is not specified, + dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_site.json` as + [site config file](../../config/site.md). ## 4. Examples diff --git a/docs/v1.6.x/tool/accessor/d.md b/docs/v1.6.x/tool/accessor/d.md index 4ff8fdbef..95c90fbfb 100644 --- a/docs/v1.6.x/tool/accessor/d.md +++ b/docs/v1.6.x/tool/accessor/d.md @@ -32,23 +32,23 @@ $ ./bin/dbAccessor -D **Command Line Arguments** -- **`-D`**
Sets command to download scan data. +- **`-D`**
Sets command to download scan data. **Additional options** -- **`-n `**
Specifies the component name to link the DCS data. -- **`-p `**
Specifies the path to directory to output retrieved - data.
If -p is not specified, dbAccessor sets `./db-data` as directory to - output. -- **`-c `**
Specifies the path to - [component connectivity config file](../../config/connectivity.md).
You - can create chip config files with filling chip names and chip IDs
- according the specified connectivity config even if the chips are not - registered in Local DB. -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md). +- **`-n `**
Specifies the component name to link the DCS data. +- **`-p `**
Specifies the path to directory to output retrieved + data.
If -p is not specified, dbAccessor sets `./db-data` as directory + to output. +- **`-c `**
Specifies the path to + [component connectivity config file](../../config/connectivity.md).
You + can create chip config files with filling chip names and chip IDs
+ according the specified connectivity config even if the chips are not + registered in Local DB. +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md). ## 4. Examples diff --git a/docs/v1.6.x/tool/accessor/e.md b/docs/v1.6.x/tool/accessor/e.md index 6e0afd08b..6e578d15d 100644 --- a/docs/v1.6.x/tool/accessor/e.md +++ b/docs/v1.6.x/tool/accessor/e.md @@ -32,26 +32,26 @@ $ ./bin/dbAccessor -E ###### Command Line Arguments -- **`-E `**
Sets command to upload DCS data and specifies the path to - [DCS config file](../../config/dcs.md) to upload. -- **`-s `**
Specifies the path to - [scan log file](../../config/scan-log.md) of the scan result data to link the - DCS data. +- **`-E `**
Sets command to upload DCS data and specifies the path + to [DCS config file](../../config/dcs.md) to upload. +- **`-s `**
Specifies the path to + [scan log file](../../config/scan-log.md) of the scan result data to link + the DCS data. ###### Additional options -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets the path of "dbCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory, or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md) if no "dbCfg" written in - [scanLog.json](../../config/scan-log.md).
Make sure the specified - configuration is the same as when the scan data was registered.
-- **`-Q`**
Sets QC mode and add a step to check if the data to upload is - suitable for QC. -- **`-I`**
Sets interactive mode and add a step to ask the user to check the - data to upload interactively. +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets the path of "dbCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory, or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md) if no "dbCfg" written in + [scanLog.json](../../config/scan-log.md).
Make sure the specified + configuration is the same as when the scan data was registered.
+- **`-Q`**
Sets QC mode and add a step to check if the data to upload is + suitable for QC. +- **`-I`**
Sets interactive mode and add a step to ask the user to check + the data to upload interactively. ## 4. Examples @@ -82,15 +82,15 @@ voltage data as an example. ```json { - "environments": [ - { - "description": "Parent VDDD Voltage [V]", - "key": "vddd_voltage", - "num": 0, - "path": "dcs.dat", - "status": "enabled" - } - ] + "environments": [ + { + "description": "Parent VDDD Voltage [V]", + "key": "vddd_voltage", + "num": 0, + "path": "dcs.dat", + "status": "enabled" + } + ] } ``` @@ -121,9 +121,9 @@ unixtime, so in this case,
```json [ - { "Unixtime": 1561376953, "Value": 10 }, - { "Unixtime": 1561376963, "Value": 11 }, - { "Unixtime": 1561376973, "Value": 12 } + { "Unixtime": 1561376953, "Value": 10 }, + { "Unixtime": 1561376963, "Value": 11 }, + { "Unixtime": 1561376973, "Value": 12 } ] ``` diff --git a/docs/v1.6.x/tool/accessor/f.md b/docs/v1.6.x/tool/accessor/f.md index 57e915e54..350ad3b03 100644 --- a/docs/v1.6.x/tool/accessor/f.md +++ b/docs/v1.6.x/tool/accessor/f.md @@ -36,50 +36,50 @@ $ ./bin/dbAccessor -F **Command Line Arguments** -- **`-F `**
Sets command to upload DCS data from influxDB and - specifies the path to - [influxDB config file](../../config/dcs.md#influxdb-config-file) to upload. -- **`-n `** Specifies the component name to link the DCS data. -- **`-s `**
Specifies the path to - [scan log file](../../config/scan-log.md) of the scan result data to link the - DCS data. +- **`-F `**
Sets command to upload DCS data from influxDB and + specifies the path to + [influxDB config file](../../config/dcs.md#influxdb-config-file) to upload. +- **`-n `** Specifies the component name to link the DCS data. +- **`-s `**
Specifies the path to + [scan log file](../../config/scan-log.md) of the scan result data to link + the DCS data. **Additional options** -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets the path of "dbCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md) if no "dbCfg" written in - [scanLog.json](../../config/scan-log.md).
Make sure the specified - configuration is the same as when the scan data was registered.
(The one - written in [scanLog.json](../../config/scan-log.md) should be match, so no - need to specify anything usually.) -- **`-u `**
Specifies the path to - [user config file](../../config/user.md)
If -u is not specified, - dbAccessor sets the path of "userCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/user.json` as - [user config file](../../config/user.md) if no "userCfg" written in - [scanLog.json](../../config/scan-log.md).
Make sure the specified - configuration is the same as when the scan data was registered.
(The one - written in [scanLog.json](../../config/scan-log.md) should be match, so no - need to specify anything usually.) -- **`-i `**
Specifies the path to - [site config file](../../config/site.md)
If -i is not specified, - dbAccessor sets the path of "siteCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/HOSTNAME_site.json` as - [site config file](../../config/site.md) if no "siteCfg" written in - [scanLog.json](../../config/scan-log.md).
Make sure the specified - configuration is the same as when the scan data was registered.
(The one - written in [scanLog.json](../../config/scan-log.md) should be match, so no - need to specify anything usually.) -- **`-Q`**
Sets QC mode and add a step to check if the data to upload is - suitable for QC. -- **`-I`**
Sets interactive mode and add a step to ask the user to check the - data to upload interactively. +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets the path of "dbCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md) if no "dbCfg" written in + [scanLog.json](../../config/scan-log.md).
Make sure the specified + configuration is the same as when the scan data was registered.
(The one + written in [scanLog.json](../../config/scan-log.md) should be match, so no + need to specify anything usually.) +- **`-u `**
Specifies the path to + [user config file](../../config/user.md)
If -u is not specified, + dbAccessor sets the path of "userCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/user.json` as + [user config file](../../config/user.md) if no "userCfg" written in + [scanLog.json](../../config/scan-log.md).
Make sure the specified + configuration is the same as when the scan data was registered.
(The one + written in [scanLog.json](../../config/scan-log.md) should be match, so no + need to specify anything usually.) +- **`-i `**
Specifies the path to + [site config file](../../config/site.md)
If -i is not specified, + dbAccessor sets the path of "siteCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/HOSTNAME_site.json` as + [site config file](../../config/site.md) if no "siteCfg" written in + [scanLog.json](../../config/scan-log.md).
Make sure the specified + configuration is the same as when the scan data was registered.
(The one + written in [scanLog.json](../../config/scan-log.md) should be match, so no + need to specify anything usually.) +- **`-Q`**
Sets QC mode and add a step to check if the data to upload is + suitable for QC. +- **`-I`**
Sets interactive mode and add a step to ask the user to check + the data to upload interactively. ### 4. Examples diff --git a/docs/v1.6.x/tool/accessor/l.md b/docs/v1.6.x/tool/accessor/l.md index 6f3cce488..6c5d32973 100644 --- a/docs/v1.6.x/tool/accessor/l.md +++ b/docs/v1.6.x/tool/accessor/l.md @@ -31,20 +31,20 @@ $ ./bin/dbAccessor -L ###### Command Line Arguments -- **`-L`**
Sets command to display test data +- **`-L`**
Sets command to display test data ###### Additional options -- **`-n `**
Specifies the component name to query. +- **`-n `**
Specifies the component name to query. -- **`-u `**
Specifies the user name to query. +- **`-u `**
Specifies the user name to query. -- **`-i `**
Specifies the site name to query. +- **`-i `**
Specifies the site name to query. -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md). +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md). ## 4. Examples diff --git a/docs/v1.6.x/tool/accessor/n.md b/docs/v1.6.x/tool/accessor/n.md index 461ab8f16..2d445d90b 100644 --- a/docs/v1.6.x/tool/accessor/n.md +++ b/docs/v1.6.x/tool/accessor/n.md @@ -29,14 +29,14 @@ $ ./bin/dbAccessor -N ###### Command Line Arguments -- **`-N`**
Sets command to check the connection to Local DB. +- **`-N`**
Sets command to check the connection to Local DB. ###### Additional options -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md). +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md). ## 4. Examples diff --git a/docs/v1.6.x/tool/accessor/r.md b/docs/v1.6.x/tool/accessor/r.md index 5123ab2be..61ee4127a 100644 --- a/docs/v1.6.x/tool/accessor/r.md +++ b/docs/v1.6.x/tool/accessor/r.md @@ -40,35 +40,35 @@ $ ./bin/dbAccessor -R **Command Line Arguments** -- **`-R`**
Sets command to upload cache data +- **`-R`**
Sets command to upload cache data **Additional options** -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets the path of "dbCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md) if no "dbCfg" written in - [scanLog.json](../../config/scan-log.md). -- **`-u `**
Specifies the path to - [user config file](../../config/user.md)
If -u is not specified, - dbAccessor sets the path of "userCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/user.json` as - [user config file](../../config/user.md) if no "userCfg" written in - [scanLog.json](../../config/scan-log.md). -- **`-i `**
Specifies the path to - [site config file](../../config/site.md)
If -i is not specified, - dbAccessor sets the path of "siteCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory,
or sets `HOME/.yarr/localdb/HOSTNAME_site.json` as - [site config file](../../config/site.md) if no "siteCfg" written in - [scanLog.json](../../config/scan-log.md). -- **`-Q`**
Sets QC mode and add a step to check if the data to upload is - suitable for QC. -- **`-I`**
Sets interactive mode and add a step to ask the user to check the - data to upload interactively. +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets the path of "dbCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md) if no "dbCfg" written in + [scanLog.json](../../config/scan-log.md). +- **`-u `**
Specifies the path to + [user config file](../../config/user.md)
If -u is not specified, + dbAccessor sets the path of "userCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/user.json` as + [user config file](../../config/user.md) if no "userCfg" written in + [scanLog.json](../../config/scan-log.md). +- **`-i `**
Specifies the path to + [site config file](../../config/site.md)
If -i is not specified, + dbAccessor sets the path of "siteCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory,
or sets `HOME/.yarr/localdb/HOSTNAME_site.json` as + [site config file](../../config/site.md) if no "siteCfg" written in + [scanLog.json](../../config/scan-log.md). +- **`-Q`**
Sets QC mode and add a step to check if the data to upload is + suitable for QC. +- **`-I`**
Sets interactive mode and add a step to ask the user to check + the data to upload interactively. ## 4. Examples diff --git a/docs/v1.6.x/tool/accessor/s.md b/docs/v1.6.x/tool/accessor/s.md index 3e069b138..407d6c9bb 100644 --- a/docs/v1.6.x/tool/accessor/s.md +++ b/docs/v1.6.x/tool/accessor/s.md @@ -30,23 +30,23 @@ $ ./bin/dbAccessor -S ###### Command Line Arguments -- **`-S `**
Sets command to upload scan data and specifies the path to - scan result directory to upload.
Make sure the - [scanLog.json](../../config/scan-log.md) exists in the specified directory. +- **`-S `**
Sets command to upload scan data and specifies the path + to scan result directory to upload.
Make sure the + [scanLog.json](../../config/scan-log.md) exists in the specified directory. ###### Additional options -- **`-d `**
Specifies the path to - [database config file](../../config/database.md).
If -d is not specified, - dbAccessor sets the path of "dbCfg" written in - [scanLog.json](../../config/scan-log.md) located in the specified scan result - directory, or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as - [database config file](../../config/database.md) if no "dbCfg" written in - [scanLog.json](../../config/scan-log.md). -- **`-Q`**
Sets QC mode and add a step to check if the data to upload is - suitable for QC. -- **`-I`**
Sets interactive mode and add a step to ask the user to check the - data to upload interactively. +- **`-d `**
Specifies the path to + [database config file](../../config/database.md).
If -d is not + specified, dbAccessor sets the path of "dbCfg" written in + [scanLog.json](../../config/scan-log.md) located in the specified scan + result directory, or sets `HOME/.yarr/localdb/HOSTNAME_database.json` as + [database config file](../../config/database.md) if no "dbCfg" written in + [scanLog.json](../../config/scan-log.md). +- **`-Q`**
Sets QC mode and add a step to check if the data to upload is + suitable for QC. +- **`-I`**
Sets interactive mode and add a step to ask the user to check + the data to upload interactively. ## 4. Examples diff --git a/docs/v1.6.x/tool/archive.md b/docs/v1.6.x/tool/archive.md index a1360486a..f6c722f07 100644 --- a/docs/v1.6.x/tool/archive.md +++ b/docs/v1.6.x/tool/archive.md @@ -13,8 +13,8 @@ The **Archive Tool** creates a/some archive tar.gz files to back-up Local DB. ## 1. Command -- Location: **localdb-tools/archive-tool/bin/localdbtool-archive.sh** -- Syntax: +- Location: **localdb-tools/archive-tool/bin/localdbtool-archive.sh** +- Syntax: ```bash $ cd localdb-tools/archivee-tool @@ -49,21 +49,21 @@ $ ./bin/localdbtool-archive.sh -f my_archive_configure.yml ###### Command Line Arguments -- **`-f|--config `**
Specifies path to - [configure file](../config/archive.md) +- **`-f|--config `**
Specifies path to + [configure file](../config/archive.md) -* **`-p|--db-port `**
Specifies Local DB server port (default: - \*\*27017) +* **`-p|--db-port `**
Specifies Local DB server port (default: + \*\*27017) -* **`-d|--db-name `**
Specifies Local DB name (default: localdb) +* **`-d|--db-name `**
Specifies Local DB name (default: localdb) -- **`-a|--archive-path `**
Specifies directory path to archives will be - put (default: ./archive-mongo-data) +- **`-a|--archive-path `**
Specifies directory path to archives will + be put (default: ./archive-mongo-data) -- **`-l|--log `**
Specifies directory path to log files will be put - (default: ./log) +- **`-l|--log `**
Specifies directory path to log files will be put + (default: ./log) -- **`-n|--n-archives `**
Specifies # of archives to keep (default: 2) +- **`-n|--n-archives `**
Specifies # of archives to keep (default: 2) #### b. Restore DB from .tar.gz file diff --git a/docs/v1.6.x/tool/retrieve.md b/docs/v1.6.x/tool/retrieve.md index d2d6abcd8..76c36de65 100644 --- a/docs/v1.6.x/tool/retrieve.md +++ b/docs/v1.6.x/tool/retrieve.md @@ -13,8 +13,8 @@ The **Retrieve Tool** is to retrieve data from Local DB. # 1. Command -- Location: **YARR/localdb/bin/localdb-retrieve** -- Syntax: +- Location: **YARR/localdb/bin/localdb-retrieve** +- Syntax: ```bash ./localdb/bin/localdbtool-retrieve