diff --git a/README.md b/README.md index 16fe77ef23863a5233e6602fd2497a7320352df2..7a91634f7a848c6bb08069d937f0208eacabd679 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,6 @@ ESS Reference & Lookup Tables * 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). -* spreadsheets: examples for the supercycle usage. * tools: productivity enhancements. -* doc: documentation. +* doc: other documents and references. -# Documentation - -## Data buffer -* https://confluence.esss.lu.se/display/HAR/Data+Buffer - -## Beam Configuration -* https://confluence.esss.lu.se/display/ABC/Beam+Configuration diff --git a/spreadsheets/20191031_Supercycle_Example_EX1.xlsx b/doc/20191031_Supercycle_Example_EX1.xlsx similarity index 100% rename from spreadsheets/20191031_Supercycle_Example_EX1.xlsx rename to doc/20191031_Supercycle_Example_EX1.xlsx diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3ebfdbde26f7f6f59ca59c87e95b10ba9a8ea23d --- /dev/null +++ b/doc/README.md @@ -0,0 +1,15 @@ +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 diff --git a/init/README.md b/init/README.md index 4b18289ce35f109c4062907d7ff518dfacdf9ab2..48735e6ea739de9a145ca80989acddcf136491dc 100644 --- a/init/README.md +++ b/init/README.md @@ -7,7 +7,7 @@ init # Note * modes->id: will be hardcoded in the firmware by * the machine protection group - * PLC group + * PLC group * EVT_14HZ is always ON. The cycle fiducial mark and the first event within the sequence. # Target Segment @@ -16,4 +16,4 @@ init # 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. \ No newline at end of file +* Constant base time shift for each event code. diff --git a/spreadsheets/.gitkeep b/spreadsheets/.gitkeep deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/supercycles/README.md b/supercycles/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4706dc640d4d0082ba467296a234c89cae4cd862 --- /dev/null +++ b/supercycles/README.md @@ -0,0 +1,12 @@ +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).