Skip to content
Snippets Groups Projects
Commit 355826e5 authored by Claudio Rosati's avatar Claudio Rosati
Browse files

README.md updated.

parent 71198e17
No related branches found
No related tags found
No related merge requests found
Pipeline #5160 passed
# ESS CS-Studio OPIs # ESS CS-Studio OPIs
This folder contains the validated and approved CS-Studio OPI files to be used This folder contains the validated and approved CS-Studio OPI files to be used
at ESS to control the facility. at ESS to control the facility.
## Structure ## Structure
...@@ -9,33 +9,33 @@ Here the structure of this folder: ...@@ -9,33 +9,33 @@ Here the structure of this folder:
``` ```
ess-opis/ ess-opis/
├── -common- ├── COMMON
│ ├── devices │ ├── DEVICES
│ └── utilities │ └── UTILITIES
├── control-room ├── CONTROL-ROOM
│ ├── -common-
│ ├── accelerator │ ├── accelerator
│ ├── central-services │ ├── central-services
│ ├── COMMON
│ ├── machine-protection-system │ ├── machine-protection-system
│ ├── neutron-instruments │ ├── neutron-instruments
│ ├── personnel-safety-systems │ ├── personnel-safety-systems
│ └── target-station │ └── target-station
└── engineering └── ENGINEERING
├── -common-
├── accelerator ├── accelerator
├── central-services ├── central-services
├── COMMON
├── machine-protection-system ├── machine-protection-system
├── neutron-instruments ├── neutron-instruments
├── personnel-safety-systems ├── personnel-safety-systems
└── target-station └── target-station
``` ```
Each -common- folder should be used to contain OPIs common to that level. Each COMMON folder should be used to contain OPIs common to that level.
The folder has the following structure: The folder has the following structure:
``` ```
-common-/ COMMON/
├── devices ├── DEVICES
│ ├── beam-magnets-and-deflector │ ├── beam-magnets-and-deflector
│ ├── control-system │ ├── control-system
│ ├── conventional-power │ ├── conventional-power
...@@ -59,7 +59,7 @@ The folder has the following structure: ...@@ -59,7 +59,7 @@ The folder has the following structure:
│ ├── timing-system │ ├── timing-system
│ ├── vacuum │ ├── vacuum
│ └── water-cooling │ └── water-cooling
└── utilities └── UTILITIES
``` ```
Here the structure for the remaining folders in control-room and engineering: Here the structure for the remaining folders in control-room and engineering:
...@@ -151,25 +151,27 @@ target-station/ ...@@ -151,25 +151,27 @@ target-station/
- File and folder names should be in accordance with the naming conventions as - File and folder names should be in accordance with the naming conventions as
much as possible. much as possible.
- Folder names must be all lowercase. - Folders named according to the naming conventions must have names in lowercase.
- No white spaces are allowed in file/folder names: use '-' instead. - Folders used to structure the repository must have names in UPPERCASE.
- No white spaces are allowed in file/folder names: use '-' instead or
CamelCase.
## Contributing the Repository ## Contributing the Repository
The repository can be cloned by everyone interested in. Changes can be performed The repository can be cloned by everyone interested in. Changes can be performed
only through Pull Requests. only through Pull Requests.
Currently only Claudio Rosati (claudio.rosati@esss.se) and Bejamin Bertrand (for Currently only Claudio Rosati (claudio.rosati@esss.se) and Bejamin Bertrand (for
safety, as Infrastructure Group member, benjamin.bertrand@esss.se) are allowed safety, as Infrastructure Group member, benjamin.bertrand@esss.se) are allowed
to approve the pull requests, and merge them into the repository. to approve the pull requests, and merge them into the repository.
As soon as someone else will be appointed to be in charge of this repository, As soon as someone else will be appointed to be in charge of this repository,
this readme file will be updated accordingly. this readme file will be updated accordingly.
## Deployment ## Deployment
The ess-opis repository is cloned and mounted in CS-Studio by the [Ansible role](https://gitlab.esss.lu.se/ics-ansible-galaxy/ics-ans-role-cs-studio) The ess-opis repository is cloned and mounted in CS-Studio by the [Ansible role](https://gitlab.esss.lu.se/ics-ansible-galaxy/ics-ans-role-cs-studio)
used to deploy CS-Studio. used to deploy CS-Studio.
Every time a push is done on the master branch, it triggers an Ansible job via Every time a push is done on the master branch, it triggers an Ansible job via
AWX API to update the git repository on the LCR workstations. Refer to the AWX API to update the git repository on the LCR workstations. Refer to the
`.gitlab-ci.yml` file for the implementation. `.gitlab-ci.yml` file for the implementation.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment