The documentation moved to confluence: https://confluence.esss.lu.se/display/HAR/Supecycle

README.md

@@ -8,3 +8,10 @@ ESS Reference & Lookup Tables
 * tools: productivity enhancements.
 * doc: other documents and references.
 
+# Supercycle manual
+* https://confluence.esss.lu.se/display/HAR/Supecycle
+
+# References
+* Description of Modes for ESS Accelerator Operation: ESS-0038258
+* Beam Configuration: https://confluence.esss.lu.se/display/ABC/Beam+Configuration
+

doc/README.md

-Documentation
---
-
-# Data buffer
-
-* https://confluence.esss.lu.se/display/HAR/Data+Buffer
-
-# Beam Configuration
-
-* https://confluence.esss.lu.se/display/ABC/Beam+Configuration
-
-# Chess
-
-## Description of Modes for ESS Accelerator Operation
-* ESS-0038258

init/README.md

-init
---
-
-# Usage
-* Load this file upon the startup. The file contains the constant configuration of the machine.
-
-# Note
-* modes->id: will be hardcoded in the firmware by
-  * the machine protection group
-  * PLC group
-* EVT_14HZ is always ON. The cycle fiducial mark and the first event within the sequence.
-
-# Target Segment
-* pv: TgSeg-RB [uint] - the actuall target segment number.
-
-# TODO
-* Event mapping for each mode.
-* 1Hz beam operation means that which events always exist in the 1Hz beam? ION_ST/END?
-* Constant base time shift for each event code.

supercycles/README.md

-ESS Supercycle Tables
---
-
-# Specification
-* Operating frequency: one linac cycle (14 Hz).
-* Sequential row execution.
-
-# Design Guide
-* Place a supecycle table in this directory.
-* Use "libreoffice" or "Microsoft Excel" to create/edit .csv files (comma-separated values).
-* Each table should have a unique name {name}.csv.
-* Fist "row" defines keys for each dataset within its collumn (key).
-* The keywords are the same as Data Buffer PVs (PBDest, PBMod, ...) and Event Codes (BPULSE_ST, BPULSE_END, ...).
-* Each row requires a unique Id number (the reference purpose).