From 921f2fd0423bc82c071f90fb38122e1118461984 Mon Sep 17 00:00:00 2001 From: Vincenzo Maffione Date: Sun, 19 Mar 2017 17:37:05 +0100 Subject: README: add sketch of the high level design --- README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'README') diff --git a/README b/README index 04b2623..cb29f09 100644 --- a/README +++ b/README @@ -1,2 +1,30 @@ # measurement-framework Part of ARCFIRE 2020, WP3 work package. + +Workflow, both external and internal: + + (1) user defines the network graph, creating instances of model.Node + and model.DIF classes + + (2) user creates an instance of a Testbed class + + (3) user creates an instance of prototype.Experiment class, passing + the testbed instance and a list of Node instances + - at the endo of the base Experiment constructor, the + generate function is called to generate information about + per-node IPCPs, registrations and enrollment, ready to be + used by the plugins + + (4) user calls run() on the prototype.Experiment instance: + - First, run() calls Experiment.swap_in(), which + in turns calls Testbed.create_experiment(), passing the + nodes and links (?) + TODO: fix this interface: what should swap_in(), and + so create_experiment() return exactly? Current interface + seems broken + + - Second, run() calls a prototype-specific setup function, + to create the required IPCPs, perform registrations, + enrollments, etc. + + - Third, perform tests (TODO) -- cgit v1.2.3