Commit 2e1ec1e7 authored by Thibaud Marie Eric Buffet's avatar Thibaud Marie Eric Buffet
Browse files

SIGMON-120: ack review comments

parent fdae6bd3
......@@ -4,7 +4,7 @@
To report issues and track their progress we use a [JIRA dashboard](https://its.cern.ch/jira/secure/RapidBoard.jspa?rapidView=7215&projectKey=SIGMON&view=detail).
- When a new issue is raised, one can report it by creating a new story on the JIRA board on the `Create` button.
- This new story/task should be assigned yourself as a `Reporter` and `Assignee` and put into the `BACKLOG` column.
- This new `story` (which could be broken down into `tasks`) should be assigned yourself as a `Reporter` and `Assignee` and put into the `BACKLOG` column.
- The issue must contain a complete and explicit description. Feel free to use images, screenshots or figures to illustrate the issue.
- It is now waiting for someone to check it out and start working on it.
......@@ -31,7 +31,7 @@ Note: issues can move back to their previous steps if needed.
### 3. Commit and push your changes to Gitlab:
- __IMPORTANT__ -> Before pushing all the notebooks must stay __CLEAN__ !! They should **NOT** contain any SWAN execution outputs.
- __IMPORTANT__ -> To avoid later confusion, before pushing all the notebooks must stay __CLEAN__ !! They should **NOT** contain any SWAN execution outputs.
To clean a notebook click on the tab `CELL` --> `All Output->Clear`
- __IMPORTANT__ -> Increment the version number in the `hwc_working/__init__.py` file.
......@@ -49,6 +49,7 @@ Note: issues can move back to their previous steps if needed.
### 5. Once the merge request has been reviewed and approved then click on the `Merge` button of the merge request page.
- The `DEV` [pipeline](https://gitlab.cern.ch/LHCData/lhc-sm-api/-/pipelines) is now triggered. Wait until the pipeline is completed and all steps are green.
If the pipeline turns red an issue have been introduced. You should fix it, or contact `lhc-signal-monitoring@cern.ch`.
- To load the `DEV` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks_dev.sh`
- On this `DEV` environment experts (you?) can validate that all the changes are correct.
##### On JIRA dashboard:
......@@ -58,6 +59,7 @@ Note: issues can move back to their previous steps if needed.
### RELEASE TO PRO
### 6. When changes are validated, you must __TAG__ the `master` branch with the previously given **_version_ _number_**: https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/tags/new
- The `PRO` [pipeline](https://gitlab.cern.ch/LHCData/lhc-sm-api/-/pipelines) is now triggered. Wait until the pipeline is completed and all steps are green.
If the pipeline turns red an issue have been introduced. You should fix it in the `dev` branch, or contact `lhc-signal-monitoring@cern.ch`.
- To load the `PRO` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks.sh`
##### On JIRA dashboard:
- The issue is fixed and can be moved to `DONE` column.
\ No newline at end of file
......@@ -31,7 +31,7 @@ Please follow a procedure below to request the NXCALS access.
- system: WinCCOA, CMW
- NXCALS environment: PRO
Optionally please can mention that the NXCALS database will be accessed through SWAN.
Optionally please mention that the NXCALS database will be accessed through SWAN.
Once the access is granted, you can use NXCALS with SWAN.
### 2. EOS lhcsm Access
......@@ -39,12 +39,12 @@ Once the access is granted, you can use NXCALS with SWAN.
EOS lhcsm access are granted via e-groups.
Allow for storage of reports.
- cernbox-project-mp3-writers
- cernbox-project-mp3-readers
- [cernbox-project-mp3-writers](https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10382587)
- [cernbox-project-mp3-readers](https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10382586)
To modify the package (env), scripts and notebooks.
- cernbox-project-lhcsm-writers
- cernbox-project-lhcsm-readers
- [cernbox-project-lhcsm-writers](https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10356104)
- [cernbox-project-lhcsm-readers](https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10356103)
**Note it could take some time for the changes to propagate.**
......@@ -108,7 +108,7 @@ This script uses the `hwc_working` folder in SWAN. If the folder already exists,
### 5. Running Notebook
#### 5.1. Open notebook
To do so simply open the folder and then select a circuit. Afterwards click name of a notebook to open a new page. The top of the notebook is presented in Figure below.
To do so simply open the folder created on the previous step and then select a circuit. Afterwards click name of a notebook to open a new page. The top of the notebook is presented in Figure below.
<img src="https://gitlab.cern.ch/LHCData/lhc-sm-hwc/raw/master/figures/swan-rb-fpa-analysis-intro.png" width=50%>
......@@ -146,7 +146,11 @@ A state of a cell is indicated by square brackets located on the left to a cell.
##### Analysis Workflow
An FPA analysis workflow consists of four steps: (i) finding an FGC Post Mortem timestamp; (ii) executing analysis cells on the cluster (iii); (iv) storing output files on EOS; see Figure below.
An FPA analysis workflow consists of four steps:
- finding an FGC Post Mortem timestamp;
- executing analysis cells on the cluster;
- plotting and validating the analysis results;
- storing output files on EOS; see Figure below.
<img src="https://gitlab.cern.ch/LHCData/lhc-sm-hwc/raw/master/figures/fpa-analysis-workflow.png" width=75%>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment