diff --git a/README.md b/README.md index f6df63c77d551397d8d97bcedc605adcab297f64..81d9ac23a39fbc23c8418d13a207a0accc99f0e0 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,46 @@ -ESS Reference & Lookup Tables --- +# ESS Reference & Lookup Tables -# Directory description +---- -* init: will be loaded during the initialization. The facility constant configuration. -* supercycles: will be loaded upon the selection (memorized PV with the supercycle table selection). The dynamic routines/cycles (runtime). -* tools: productivity enhancements. -* doc: other documents and references. +- [ Project Directory Structure ](#Directory) +- [ Tag Versioning ](#Tag) -# Supercycle manual -* https://confluence.esss.lu.se/display/HAR/Supecycle +---- -# References -* Description of Modes for ESS Accelerator Operation: ESS-0038258 - * $(ESS-0038258->Revision) == $ProtVer -* Beam Configuration: https://confluence.esss.lu.se/display/ABC/Beam+Configuration -* Master events according to: ESS-1837307: Time Structure of the Proton Beam Pulses in the LINAC. +## Project Directory Structure +<a name="Directory"></a> -# Tag versioning -* MAJOR = {ProtNum} -* MINOR = {ESS-0038258 revision, ProtVer} -* PATH = {supercycle adds, bug corrections} +### [init](init) -e.g. 1.5.0 contains ProtNum == 1, ESS-0038258 revision == 5 and ProtVer == 5 and it is compatible with all 1.5.x. \ No newline at end of file +It loads during the initialization and contains ESS constant variables and enumerations for: +- [databuffer-ess](init/databuffer-ess.json) proton beam modes, destination and state according to ESS-0038258 (_Description of Modes for ESS Accelerator Operation_) + +- [mevts-ess](init/mevts-ess.json) - master events according to: ESS-1837307 (_Time Structure of the Proton Beam Pulses in the LINAC_). + +See [Beam Configuration](https://confluence.esss.lu.se/display/ABC/Beam+Configuration) for additional details. + +### [supercycles](supercycles) + +It loads upon the selection by an ESS operator (see the [manual](https://confluence.esss.lu.se/display/HAR/Supecycle)). The dynamic routines/cycles (runtime). + +### [tools](tools) + +Productivity enhancements. + +### [doc](doc) + +Other documents, manuals, references and drafts. + +## Tag Versioning +<a name="Tag"></a> + +- MAJOR (1st digit) == {Backward compatibility mark} +- MINOR (2sd digit) == {ESS-0038258 Chess Revision, ProtNum} +- PATH (3rd digit) == {ESS-1837307 Chess Revision, ProtVer} +- BUILD (4th digit) == {supercycle adds, bug corrections} + +e.g. 1.5.1+1 means: +- all with 1 is compatible, +- ProtNum == 5, ESS-0038258 revision == 5, +- ProtVer == 1, ESS-1837307 revistion == 1, +- +1 - some files were introduced, e.g. supercycle tables. diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000000000000000000000000000000000000..421fbf7416299bbd0b48045e2475d023bed9ea81 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,3 @@ +## Complementary Documentation + +* [Timing Data Model Specification](https://confluence.esss.lu.se/display/HAR/Timing+Data+Model+Specification) \ No newline at end of file diff --git a/init/README.md b/init/README.md deleted file mode 100644 index 420be845607cfc7027d3bbbb4c94c67d26b16f45..0000000000000000000000000000000000000000 --- a/init/README.md +++ /dev/null @@ -1,11 +0,0 @@ -Init --- - -# databuffer-ess.json -* The databuffer enumeration - -# accelerator-operation-ess.json -* The accelerator operation enumeration (not included into the databuffer) - -# mevts-ess.json -* Master events according to: ESS-1837307: Time Structure of the Proton Beam Pulses in the LINAC. diff --git a/init/databuffer-ess.json b/init/databuffer-ess.json index 22b60015c312218ed0488ee83325c1a68cce3688..273a1b44b0463172125ecfdadc290e6d9a3a651a 100644 --- a/init/databuffer-ess.json +++ b/init/databuffer-ess.json @@ -1,7 +1,6 @@ { - "ProtNum": 1, - "ProtVer": 5, - "doc": "ESS-0038258", + "ProtNum": 5, + "ProtVer": 1, "PBState": { "None": { "id": 0,