Skip to content

Commit 6623a2c

Browse files
committed
Update readme
1 parent 3d94def commit 6623a2c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# AliDip2BK
1+
# BKP-LHC Client
22

33
Initial Repository based on work from @iclegrand in repository: https://github.com/iclegrand/AliDip2BK
44

5-
Collect selected Info from the CERN DIP system (LHC & ALICE -DCS) and publish them into the Bookkeeping/InfoLogger systems
5+
The BKP-LHC Client is a java based application which uses the CERN DIP `jar` dependency to consume events from desired tracks. These events are then either:
6+
- published on O2 Kafka Topics to be consumed further by O2 applications (e.g. ECS)
7+
- updates the O2 Bookkeeping application via their HTTP endpoints.
68

79
A detailed description for this project is provided by Roberto in this document:
810
https://codimd.web.cern.ch/G0TSXqA1R8iPqWw2w2wuew
911

10-
11-
This program requires java 11 on a 64 bit system
12-
(this is a constrain from the DIP library)
13-
14-
To test the java version run
12+
### Requirements
13+
- java 11 on a 64 bit system (this is a constrain from the DIP library)
14+
- to test the java version run
15+
```
1516
java -version
17+
```
1618

17-
The run configuration is defined in the AliDip2BK.properties file.
18-
19-
To run the program :
20-
21-
sh runAliDip2BK.sh
19+
### Configuration
20+
The run configuration is defined in the `AliDip2BK.properties` file.
2221

23-
When the the program is stopped, it enters into the shutdown mode and it will
24-
unsubscribe to the DIP data providers will wait to process the DipData queue
25-
and saves the state of the fills and runs.
22+
### Published Events
23+
Currently the BKP-LHC-Client publishes on Kafka (topic: "dip.lhc.beam_mode") events for the start and end of stable beams in the format of `Ev_BeamModeEvent`. The proto file's source of truth is within the [Control Repository](https://github.com/AliceO2Group/Control/blob/master/common/protos/events.proto)
2624

25+
### Bookkeeping Updates
26+
- TBC

0 commit comments

Comments
 (0)