Merge pull request #53 from manuGil/clean-up

Clean up

examples/builder_model_example.py

@@ -3,7 +3,7 @@
 """
 from illuminator.builder import IlluminatorModel, ModelConstructor
 
-# step 1: defin model properties
+# step 1: define model properties
 battery = IlluminatorModel(
     parameters={"material": "lithium"},
     inputs={"voltage": 60},

examples/mosaik_sim_config.py

@@ -0,0 +1,16 @@
+"""
+Clonfigurations for the mosaik simulations that use models 
+from the illuminator package, can be defined as below.
+
+Pre-requisites:
+1. Install the illuminator as a Python package
+2. The simulation should be run in the same environment where
+the illuminator is installed
+"""
+
+# Configuration for collector, 
+sim_config={
+    'Collector':{'python':'illuminator.models.collector:Collector'},
+    'CSVB':{'python':'illuminator.models.mosaik_csv:CSV'},
+    'PV':{'python':'illuminator.models.PV.pv_mosaik:PvAdapter'},
+}

src/illuminator/builder/scenario.example.yaml → examples/simulation.example.yaml

@@ -4,9 +4,11 @@ scenario:
   end_time: '2012-01-02 00:00:10' # duration in seconds 
 models: # list of models for the energy network
 - name: Battery1 # name for the model (must be unique)
-  type: Battery # name of the model registered in the Illuminato
+  type: BatteryModel # name of the model registered in the Illuminator
+  inputs: 
+    input1: 0  # input-name: initial value, default value will be used if not defined
   outputs: 
-    output1: 1 
+    output1: 0 
     output2: null
   parameters: 
     charge_power_max: 100
@@ -19,15 +21,14 @@ models: # list of models for the energy network
   triggers:   # list of triggers for the of another model??. It must be an input, output or state of the model
     - capacity
     - soc_min
-  scenario_data: 'path/to/file' #path to the scenario data file for the model. This should be optional
+  scenario_data: './src/illuminator/schemas/scenario_data.csv' #path to the scenario data file for the model. This should be optional
   connect: # this is optional. If not defined, the model will be assumed to be local
-    ip:  
-    port:  # optional, if not defined, the default port will be used
+    ip: 127.0.0.1 # Ip version 4 or 6
+    port: 5000 # optional, if not defined, the default port will be used
 - name: Battery2
   type: BatteryModel # models can reuse the same type
   inputs: 
     input1: 0  # input-name: initial value, default value will be used if not defined
-    input2: None #  
   outputs: 
     output1: 0 
     output2: null
@@ -51,7 +52,7 @@ connections:
   to: PV1.input1 # end model
 - from: Battery2.output
   to: PV1.input2
-monitor:  # a list of models, its inputs, output and states to be monitored and logged. 'To the collector by default'
+monitor:  # a list of models, its inputs, output and states to be monitored and logged
 - Battery1.input1 # pattern model_name.state_name
 - Battery2.output1  # no duplicates allowed
 - PV1.soc # pattern model_name.state_name