From 50c745a69b59636f1cc5b81540ff9bd1536705df Mon Sep 17 00:00:00 2001
From: Argentina Ortega Sainz <argentina.ortega@h-brs.de>
Date: Tue, 28 Nov 2017 16:17:02 +0100
Subject: [PATCH] Add comments to config files

Add further explanations and to-dos
Removed some inconsistent comments
Removed unused parameters
---
 config/customers.yaml |  6 +++---
 config/products.yaml  |  2 ++
 config/scenarios.yaml | 24 +++++++++++-------------
 3 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/config/customers.yaml b/config/customers.yaml
index c086360..47c6a36 100644
--- a/config/customers.yaml
+++ b/config/customers.yaml
@@ -1,4 +1,4 @@
-1:
+1: # Clients who order some one day in advance and/or same day delivery
   - King's Landing Shop
   - Dorne Supermarket
   - Braavos Cafe
@@ -18,7 +18,7 @@
   # - Bake Shop
   # - Patisserie
   # - Pastry Shop
-2:
+2: # Clients who order once a day, one day in advance
   - Winterfell Retirement Home
   - Old Town Hospital
   - Sunspear Canteen
@@ -29,7 +29,7 @@
   - Castle Black Pub
   - Direwolf Tavern
   - Dragon Bar
-3:
+3: # Clients who order more than one day in advance
   - Westeros Catering
   - Lannisport Club
   - Eyrie Verein
diff --git a/config/products.yaml b/config/products.yaml
index 63b6215..884bfd8 100644
--- a/config/products.yaml
+++ b/config/products.yaml
@@ -1,3 +1,5 @@
+# The product list will be shuffled randomly for the bakeries
+# TODO shuffle the products when ordering
 - Bagel
 - Bread
 - Donut
diff --git a/config/scenarios.yaml b/config/scenarios.yaml
index fb31830..c12b10f 100644
--- a/config/scenarios.yaml
+++ b/config/scenarios.yaml
@@ -1,7 +1,7 @@
 # The scenarios are created randomly. This config file specifies the parameters used by the random generator.
 random: # Scenario name
   meta:
-    days: 10 # Orders spanning 50 days
+    days: 10 # Orders spanning X days
     customers: # Amount of customers generated
       1: 10
       2: 10
@@ -21,25 +21,23 @@ random: # Scenario name
       heating_rate: # chosen at random between max and min
         max: 5
         min: 1
-  products: # chosen at random. Time values are given in seconds for the time being
+  products: # chosen at random.
+    # Time values are given in seconds (at least right now)
     # TODO define if time is real seconds or simulated minutes
-    dough_prep_time: [5, 15] # between .25 and 0.5
-    resting_time: [20, 75] # to 1.25
-    item_prep_time: [2, 5] # per item
-    breads_per_oven: 16 # Multiples of 2
-    baking_time: [12, 25] 
-    baking_temp: [180, 200]
+    dough_prep_time: [5, 15]
+    resting_time: [20, 75]
+    item_prep_time: [2, 5] # time per item
+    breads_per_oven: 16 # Max value, multiples of 2. Min is 4
+    baking_time: [12, 25]
+    baking_temp: [180, 200] # Multiples of 5
     cooling_rate: [5, 20]
-    boxing_temp: [40,60] # <40
-    breads_per_box: 15 # Multiples of 5
+    boxing_temp: [40,60] # <40 Multiples of 5
+    breads_per_box: 15 # Max value, multiples of 5. Min is 5
     production_cost: [0.3, 2]
     sales_price: [2.8, 5.0]
   trucks:
     max: 3
     capacity: 50 # Will always be a multiple of 5
-  grid_size: # The grid is an x * y area, starting in (0, 0)
-    x: 5
-    y: 5
   street_network:
     grid_size: 10 # Squared grid size of x by x
     directed: true # If false, edges are equidistant