Commit 4f18c881 authored by Thibaud Marie Eric Buffet's avatar Thibaud Marie Eric Buffet
Browse files

SIGMON-120: improve README.md with DEV scripts

parent b03325f9
......@@ -45,12 +45,23 @@ The following steps should be followed in order to log-in to SWAN
### 3. Setting an Environment Script
In order to execute the HWC notebooks, one requires `lhc-sm-api` package and HWC notebooks. To this end, we created a dedicated environment script to prepare the SWAN project space.
The script sets a path to a virtual environment with the necessary packages (for more details, cf. https://lhc-sm-api.web.cern.ch/lhc-sm-api/user_install.html#preinstalled-packages) as well as makes a copy of HWC notebooks to `hwc` notebooks. **Note that in order to ensure compatibility between package and notebook versions, the `hwc` folder is deleted each time the script is executed.**
Firstly, contact the Signal Monitoring team (<a href="mailto:lhc-signal-monitoring@cern.ch">lhc-signal-monitoring@cern.ch</a>) in order to get read access to the EOS folder with pre-installed packages and HWC analysis notebooks.
Once the access is granted, at every log-in to SWAN, please provide the following environment script:
The script sets a path to a virtual environment with the necessary packages (for more details, cf. https://lhc-sm-api.web.cern.ch/lhc-sm-api/user_install.html#preinstalled-packages) as well as makes a copy of HWC notebooks.
The SWAN Notebooks can be loaded in 3 different environments:
- PRO
- DEV
- DEV CONTRIBUTOR
#### 3.1 PRO
This is the PRO and stable version of the notebooks, users and experts should use this script.
At every log-in to SWAN, please provide the following environment script:
`/eos/project/l/lhcsm/public/packages_notebooks.sh`
**Note that in order to ensure compatibility between package and notebook versions, the `hwc` folder is deleted each time the script is executed.**
**Note: Notebooks changes are not persisted when using this environment script.**
<img src="https://gitlab.cern.ch/LHCData/lhc-sm-hwc/raw/master/figures/swan_environment_script.png" width=25%>
Note the following settings while configuring environment:
......@@ -61,10 +72,29 @@ Note the following settings while configuring environment:
- Memory: `16 GB`
- Spark cluster: `BE NXCALS (NXCals)`
This script creates a new `hwc` folder in SWAN.
#### 3.2 DEV
This is the DEV version of the notebooks, this script is used for new feature validations and verification.
At every log-in to SWAN, please provide the following environment script:
`/eos/project/l/lhcsm/public/packages_notebooks_dev.sh`
This script creates a new `hwc_dev` folder in SWAN.
**Note: that in order to ensure compatibility between package and notebook versions, the `hwc_dev` folder is deleted each time the script is executed.**
**Note: Notebooks changes are not persisted when using this environment script.**
#### 3.3 DEV CONTRIBUTOR
This is a DEV version of the notebooks, this script is used to implement new features and new notebooks.
see [CONTRIBUTING.md](CONTRIBUTING.md)
This script uses the `hwc_working` folder in SWAN. If the folder already exists, then it just loads the DEV environment.
### 4. Running Notebook
#### 4.1. Open notebook
To do so simply open `hwc` 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 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%>
......
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