Updated the labspec structure

vlead · Feb 20, 2017 · 1ede5eb · 1ede5eb
1 parent 80680b5
commit 1ede5eb
Showing 1 changed file with 66 additions and 0 deletions.
diff --git a/src/design/index.org b/src/design/index.org
@@ -971,6 +971,72 @@ Not yet implemented
 
 
 
+* Specification
+  Every experiment and a lab has a specification. The specification provides a
+  unique ID, name, contents of an experiment and other meta information of
+  either a lab or experiment. This information includes: developer details, the
+  organization a lab belongs to, discipline details, hosting information
+  i.e. on which platform the lab/experiments are hosted, integration status of
+  labs and the assets associated with a lab/experiment. This specification is
+  different from the deployment specification of an experiment.
+
+** Experiment Specification
+   An experiment is a basic functional unit of virtual labs. An experiment is a
+   combination of static content and simulation. Each experiment is identified
+   by a unique id, name, institute, discipline, developer, hosting information,
+   integration status, assets etc.
+
+#+begin_src 
+{"experiment": {"id": "e99847", 
+                "name": "Parallel and distributed processing",
+                "discipline": "Computer Science and Engineering",
+                "institute": "IIIT-Hyderabad",
+                "developers": [{"Dinesh Malviya", "xyz@gmail.com"},
+                               {"Ashish Ahuja", "abc@gmail.com"}],
+                "hostinginfos": [{"hosted", "cloud", "http://cse14-iiith.vlabs.ac.in"},
+                                 {"hosted", "college-cloud", "http://cse14-iiith.ac.in"}],
+                "integrationstatus": "4",
+                "assets": [{"Images", "vlabs.ac.in/images/static/logo.png"},
+                           {"Videos", "vlabs.ac.in/video/abc.mkv"}],
+                "overview": "This deals with eliciting how parallel and distributed processing is done", 
+                "sections" : ["Introduction", 
+                              "Objective",
+                              "Tutorial", 
+                              "Illustration", 
+                              "Procedure", 
+                              "Experiment",
+                              "Observations", 
+                              "Assignment", 
+                              "References"]
+}
+#+end_src 
+
+** Lab Specification
+   A lab is collation of experiments. A lab is identified by a unique id. The
+   lab specification contains this identifier along with name, name of the
+   organization, discipline, developer, hosting information, integration
+   status, assets etc. The experiments in a lab are specified by including
+   their respective ids.
+#+begin_src
+{"lab": {"id": "cse02", 
+                "name": "Computer Programming",
+                "discipline": "Computer Science and Engineering",
+                "institute": "IIIT-Hyderabad",
+                "developers": [{"Dinesh Malviya", "xyz@gmail.com"},
+                               {"Ashish Ahuja", "abc@gmail.com"}],
+                "hostinginfos": [{"hosted", "cloud", "http://cse14-iiith.vlabs.ac.in"},
+                                 {"hosted", "college-cloud", "http://cse14-iiith.ac.in"}],
+                "integrationstatus": "4",
+                "assets": [{"Images", "vlabs.ac.in/images/static/logo.png"},
+                           {"Videos", "vlabs.ac.in/video/abc.mkv"}],
+                "overview": "This lab deals with computer programming",
+                "sections" : [{"name": "Introduction"},
+                              {"experiments": [e100, e200, ....]}]
+              }
+}
+
+#+end_src
+
 * Design diagram
   :PROPERTIES:
   :CUSTOM_ID: design_diagram