From 14d52910ca9701dd13c1ed4e14803dfba1174177 Mon Sep 17 00:00:00 2001
From: Jerzy Jamroz <jerzy.jamroz@esss.se>
Date: Wed, 22 Jan 2020 12:42:04 +0100
Subject: [PATCH] Update.
---
README.md | 10 +---------
.../20191031_Supercycle_Example_EX1.xlsx | Bin
doc/README.md | 15 +++++++++++++++
init/README.md | 4 ++--
spreadsheets/.gitkeep | 0
supercycles/README.md | 12 ++++++++++++
6 files changed, 30 insertions(+), 11 deletions(-)
rename {spreadsheets => doc}/20191031_Supercycle_Example_EX1.xlsx (100%)
create mode 100644 doc/README.md
delete mode 100644 spreadsheets/.gitkeep
create mode 100644 supercycles/README.md
diff --git a/README.md b/README.md
index 16fe77e..7a91634 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 0000000..3ebfdbd
--- /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 4b18289..48735e6 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 e69de29..0000000
diff --git a/supercycles/README.md b/supercycles/README.md
new file mode 100644
index 0000000..4706dc6
--- /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).
--
GitLab