fixing documentation and syntax suggestions

open-ideas · Jan 2, 2025 · 1e37f37 · 1e37f37
1 parent 65fab4c
commit 1e37f37
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 25 deletions.
diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse10.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse10.mo
@@ -50,10 +50,10 @@ record HeavyWall "BESTEST heavy wall with idealized wood layer"
 
 end HeavyWall;
   annotation (
-	__Dymola_Commands(file=
+ __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/DetailedHouse/DetailedHouse10.mos"
         "Simulate and plot"),
-	experiment(
+ experiment(
       StartTime=10000000,
       StopTime=11000000,
       __Dymola_NumberOfIntervals=5000,

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse2.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse2.mo
@@ -1,7 +1,6 @@
 within IDEAS.Examples.Tutorial.DetailedHouse;
 model DetailedHouse2 "Adding closed screens"
-  extends DetailedHouse1(
-                   window(redeclare Buildings.Components.Shading.Screen shaType));
+  extends DetailedHouse1(window(redeclare Buildings.Components.Shading.Screen shaType));
   Modelica.Blocks.Sources.Constant const(k=1)
     annotation (Placement(transformation(extent={{-100,-60},{-80,-40}})));
 equation

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse4.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse4.mo
@@ -29,7 +29,7 @@ First implementation for the IDEAS crash course.
 </html>", info="<html>
 <p>
 This example extends the third example by adding a
-custom occupancy model that uses an occupancy schedule e that returns an
+custom occupancy model that uses an occupancy schedule that returns an
 occupancy of two during office hours and zero otherwise.
 </p>
 <h4>Required models</h4>

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse5.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse5.mo
@@ -98,11 +98,11 @@ Construction and glazing records from <a href=\"modelica://IDEAS.Examples.Tutori
 IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse1</a>
 </li>
 </ul>
-</html>"), 
+</html>"),
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/DetailedHouse/DetailedHouse5.mos"
         "Simulate and plot"),
-	experiment(
+ experiment(
       StartTime=10000000,
       StopTime=11000000,
       __Dymola_NumberOfIntervals=5000,

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse6.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse6.mo
@@ -122,9 +122,9 @@ equation
   connect(heaPum.port_a2, pumpPrim.port_b)
     annotation (Line(points={{196,20},{196,60},{220,60}}, color={0,127,255}));
   connect(heaPum.port_b2, bou.ports[1]) annotation (Line(points={{196,0},{196,
-          -30},{248,-30},{248,8},{260,8}},        color={0,127,255}));
+          -30},{248,-30},{248,11},{260,11}},      color={0,127,255}));
   connect(pumpPrim.port_a, bou.ports[2]) annotation (Line(points={{240,60},{248,
-          60},{248,12},{260,12}}, color={0,127,255}));
+          60},{248,9},{260,9}},   color={0,127,255}));
   connect(rad.heatPortCon, rectangularZoneTemplate.gainCon) annotation (Line(
         points={{42.8,-8},{20,-8},{20,27},{10,27}}, color={191,0,0}));
   connect(rad.heatPortRad, rectangularZoneTemplate.gainRad) annotation (Line(
@@ -147,9 +147,10 @@ equation
   connect(senTemSup.port_b, pumpSec.port_a)
     annotation (Line(points={{126,60},{120,60}}, color={0,127,255}));
   connect(senTemSup.port_a, tan.port_b)
-    annotation (Line(points={{146,60},{158,60}}, color={0,127,255}));
+    annotation (Line(points={{146,60},{158,60},{158,50},{168,50}},
+                                                 color={0,127,255}));
   connect(tan.port_a, heaPum.port_b1)
-    annotation (Line(points={{178,60},{184,60},{184,20}}, color={0,127,255}));
+    annotation (Line(points={{168,70},{184,70},{184,20}}, color={0,127,255}));
   connect(rad1.port_b, heaPum.port_a1) annotation (Line(points={{90,-20},{90,
           -30},{184,-30},{184,0}}, color={0,127,255}));
   connect(rad.port_b, heaPum.port_a1) annotation (Line(points={{50,-20},{50,-30},

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse7.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse7.mo
@@ -1,7 +1,6 @@
 within IDEAS.Examples.Tutorial.DetailedHouse;
 model DetailedHouse7 "Adding a controller"
-  extends DetailedHouse6(
-                   heaPum(enable_variable_speed=true));
+  extends DetailedHouse6(heaPum(enable_variable_speed=true));
   Modelica.Blocks.Logical.Hysteresis hys(uLow=273.15 + 40, uHigh=273.15 + 45)
     "Hysteresis controller"
     annotation (Placement(transformation(extent={{60,-80},{80,-60}})));

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse8.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse8.mo
@@ -8,8 +8,8 @@ model DetailedHouse8 "JSOn writer"
     outputTime=IDEAS.Utilities.IO.Files.BaseClasses.OutputTime.Terminal)
     annotation (Placement(transformation(extent={{280,-42},{260,-22}})));
 equation
-  connect(jsonWri.u[1], EEl.y) annotation (Line(points={{280,-32},{286,-32},{
-          286,50},{281,50}}, color={0,0,127}));
+  connect(jsonWri.u[1], EEl.y) annotation (Line(points={{280,-32},{286,-32},{286,
+          50},{301,50}},     color={0,0,127}));
   annotation (Documentation(revisions="<html>
 <ul>
 <li>
@@ -28,11 +28,11 @@ This model outputs the main model result to a json file.
 IDEAS.Utilities.IO.Files.JSONWriter</a>
 </li>
 </ul>
-</html>"), 
+</html>"),
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/DetailedHouse/DetailedHouse8.mos"
-        "Simulate and plot"),	
-	experiment(
+        "Simulate and plot"),
+ experiment(
       StartTime=10000000,
       StopTime=11000000,
       __Dymola_NumberOfIntervals=5000,

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse9.mo b/IDEAS/Examples/Tutorial/DetailedHouse/DetailedHouse9.mo
@@ -122,10 +122,10 @@ equation
     annotation (Line(points={{19,90},{-38,90}}, color={0,0,127}));
   connect(ppmSet.y, conPID1.u_s) annotation (Line(points={{19,90},{-20,90},{-20,
           10},{-38,10}}, color={0,0,127}));
-  connect(outsideAir.ports[1], hex.port_b2) annotation (Line(points={{-260,-2},
-          {-250,-2},{-250,-6}}, color={0,127,255}));
-  connect(outsideAir.ports[2], hex.port_a1) annotation (Line(points={{-260,2},{
-          -252,2},{-252,6},{-250,6}}, color={0,127,255}));
+  connect(outsideAir.ports[1], hex.port_b2) annotation (Line(points={{-260,1},{-250,
+          1},{-250,-6}},        color={0,127,255}));
+  connect(outsideAir.ports[2], hex.port_a1) annotation (Line(points={{-260,-1},{
+          -252,-1},{-252,6},{-250,6}},color={0,127,255}));
   connect(vavSup.port_b, rectangularZoneTemplate.ports[1]) annotation (Line(
         points={{-100,60},{-2,60},{-2,40},{0,40}}, color={0,127,255}));
   connect(vavRet.port_a, rectangularZoneTemplate.ports[2]) annotation (Line(
@@ -168,7 +168,7 @@ from <a href=\"modelica://IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse4\"
 IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse4</a> is added to one zone and a 
 fixed occupancy of 1 person to the other zone. The ventilation system
 consists of two fans, two supply and two return air VAVs (Variable Air Volume), a heat recovery unit and an
-outdoor air source. The control consists of PI controllers with a set point of 1000 ppm.
+outdoor air source. The control consists of PI controllers with a setpoint of 1000 ppm.
 </p>
 <h4>Required models</h4>
 <ul>

diff --git a/IDEAS/Examples/Tutorial/DetailedHouse/package.mo b/IDEAS/Examples/Tutorial/DetailedHouse/package.mo
@@ -79,12 +79,12 @@ adds a CO2-controlled ventilaation system. The occupancy model from <a href=\"mo
 IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse4</a> is added to one zone and a 
 fixed occupancy of 1 person to the other zone. The ventilation system
 consists of two fans, two supply and two return air VAVs (Variable Air Volume), a heat recovery unit and an
-outdoor air source. The control consists of PI controllers with a set point of 1000 ppm.
+outdoor air source. The control consists of PI controllers with a setpoint of 1000 ppm.
 </li>
 <li>
 <a href=\"modelica://IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse10\">
 IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse10</a>
-removes small time constants from the problem to decrease computation time.
+removes small time constants from the model to decrease computation time.
 </li>
 </ol>
 <p>