From bbce4c208cc89c3fef936328f7ce4b3cc940ac48 Mon Sep 17 00:00:00 2001 From: Kinesin Data Technologies Incorporated <93931750+kinesintech@users.noreply.github.com> Date: Wed, 5 Oct 2022 12:51:07 -0300 Subject: [PATCH] Adding documentation --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7975629 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +Waterfall +========= + +Waterfall is a declarative task execution framework. +Why Another Execution Framework +=============================== + +There are many, many execution frameworks out there that support defining +tasks with inter-task dependencies. Most of them only partially include +scheduling in their design. + +Overview +-------- + +Resources +========= + +Resources are at the heart of Waterfall. They are simple things: labels +with an associated set of time intervals. Tasks produce resources for +given intervals. + +Tasks +===== + +Tasks are commands that run on a set schedule. Each task produces one or +more `Resource`. The run schedule naturally breaks up the timeline into +intervals. When a task runs at time $T_n$, it will make make each resource +it provides available over the interval $(T_{n-1},T]$.