update doc

doc/teaser.Examples.rst

@@ -68,7 +68,14 @@ TEASER'S Output folder::
         internal_id=None,
         path=None)
 
-We could also use Annex60 models with same calculation method::
+For OpenModelica you need to exclude the centralAHU (because it uses state machines). Therefore use the building_model "Multizone"::
+    prj.export_aixlib(building_model="Multizone",
+        zone_model="ThermalZoneEquipped",
+        corG=True,
+        internal_id=None,
+        path=None)
+
+We could also use Annex60 models with same calculation method, which exports one model per zone::
 
     prj.used_library_calc = "Annex60"
     prj.calc_all_buildings()
@@ -82,6 +89,9 @@ insulation layer and new windows. The name is changed to Retrofit::
 
     prj.name = "Project_Retrofit"
     prj.retrofit_all_buildings(2015)
+
+Again, we need to export the model, ou could also change the exports here as seen above::
+
     prj.export_record(
         building_model="MultizoneEquipped",
         zone_model="ThermalZoneEquipped",
@@ -128,7 +138,7 @@ Set some building parameters::
     bldg.city = "46325 Fantastic Town"
     bldg.year_of_construction = 1988
 
-Instantiate a ThermalZone class, with building as parent and set 
+Instantiate a ThermalZone class, with building as parent and set
 some parameters of the thermal zone::
 
     tz = ThermalZone(parent=bldg)
@@ -141,7 +151,7 @@ Instantiate UseConditionsOffice18599 class with thermal zone as parent, and load
 
     tz.use_conditions = BoundaryConditions(parent=tz)
     tz.use_conditions.load_use_conditions("Living")
-    
+
 Define two elements representing a pitched roof and define Layers and
 Materials explicitly::
 
@@ -164,11 +174,11 @@ Set coefficient of heat transfer::
     roof_south.inner_radiation = 20.0
     roof_south.outer_radiation = 5.0
 
-    
+
 Set layer and material. The id indicates the position
 of the layer from inside to outside::
 
-    layer_1s = Layer(parent=roof_south, id=0) 
+    layer_1s = Layer(parent=roof_south, id=0)
     layer_1s.thickness = 0.15
 
     material_1_2 = Material(layer_1s)
@@ -219,12 +229,12 @@ Set layer and material::
     material_1_1.density = 1400.0
     material_1_1.heat_capac = 0.6
     material_1_1.thermal_conduc = 2.5
-    
-    
+
+
 For the remaining Outer and Inner walls as well as Windows, we save the information
 in python dicitonaries, iterate them and instantiate the corresponding classes. In addition we
 are using the load_type_element function to determine the building physics from statistical data
-The key of the dict is the walls's name, while the value is a list with parameters the 
+The key of the dict is the walls's name, while the value is a list with parameters the
 [year of construciton, construction type, area, tilt,orientation]::
 
     out_wall_dict = {"Outer Wall 1": [bldg.year_of_construction, 'heavy',
@@ -299,7 +309,7 @@ The key of the dict is the walls's name, while the value is a list with paramete
         win_material.name = "GlasWindow"
         win_material.thermal_conduc = 0.067
         win_material.transmittance = 0.9
-        
+
 For a GroundFloor we are using the load_type_element function explicitly,
 which needs the year of construction and the construction type ('heavy'
 or 'light')::
@@ -309,32 +319,51 @@ or 'light')::
     ground.load_type_element(year=1988, construction='heavy')
     ground.area = 140.0
 
-We calculate the RC Values according to AixLib procedure::
+
+We need to set the projects calculation method. The library we want to
+use is AixLib, we are using a two element model and want an extra resistance
+for the windows. To export the parameters to a Modelica record, we use
+the export_aixlib function. path = None indicates, that we want to store
+the records in TEASER'S Output folder::
 
     prj.used_library_calc = 'AixLib'
     prj.number_of_elements_calc = 2
     prj.merge_windows_calc = False
 
     prj.calc_all_buildings()
 
-Export the Modelica model::
 
-    prj.export_aixlib(
-        building_model="MultizoneEquipped",
-        zone_model="ThermalZoneEquipped",
-        corG=True,
-        internal_id=None,
-        path=None)
+Export the Modelica Record. If you have a Dymola License you can  export
+the model with a central AHU (MultizoneEquipped) (only default for office
+and institute buildings)::
 
-Or we use Annex60 method with for elements::
+  prj.export_aixlib(building_model="MultizoneEquipped",
+      zone_model="ThermalZoneEquipped",
+      corG=True,
+      internal_id=None,
+      path=None)
 
-    prj.used_library_calc = 'Annex60'
 
+For OpenModelica you need to exclude the centralAHU (because it is using
+state machines). Therefore use the building_model "Multizone"
 
-    prj.calc_all_buildings()
-    prj.export_annex(number_of_elements=2,
-                     merge_windows=False,
-                     used_library='Annex60')
+
+  prj.export_aixlib(building_model="Multizone",
+      zone_model="ThermalZoneEquipped",
+      corG=True,
+      internal_id=None,
+      path=None)
+
+
+'''Or we use Annex60 method (e.g with four elements). Which exports one
+Model per zone'''
+
+  prj.used_library_calc = 'Annex60'
+  prj.number_of_elements_calc = 4
+  prj.merge_windows_calc = False
+
+  prj.calc_all_buildings()
+  prj.export_annex()
 
 
 Save teaserXML and CityGML::