Merge pull request OpenIPSL#259 from marcelofcastro/Update-Docs

Update Documentation in User's Guide
tinrabuzin · Dec 10, 2020 · 0f88fa6 · 0f88fa6
2 parents 023ac6d + d03c838
commit 0f88fa6
Show file tree

Hide file tree

Showing 152 changed files with 955 additions and 2,176 deletions.
diff --git a/OpenIPSL/Copyright.mo b/OpenIPSL/Copyright.mo
@@ -1,7 +1,11 @@
 within OpenIPSL;
 class Copyright "Disclaimer<html>
+<p>&nbsp;</p>
 <p>OpenIPSL:</p>
-<p>Copyright August 2017 - Prof. Luigi Vanfretti, Rensselaer Polytechnic Institute, Troy, NY.</p>
+<p>Copyright August 2017 Prof. Luigi Vanfretti and AlsetLab, Rensselaer Polytechnic Institute (RPI), Troy, NY.</p>
+<ul>
+<li>AlsetLab, research group at RPI: <a href=\"https://alsetlab.github.io/\">https://alsetlab.github.io/</a></li>
+</ul>
 <p>Copyright April 2016 - July 2017 SmarTS Lab (Sweden)</p>
 <ul>
 <li>SmarTS Lab, research group at KTH: <a href=\"https://www.kth.se/en\">https://www.kth.se/en</a></li>
@@ -10,6 +14,7 @@ class Copyright "Disclaimer<html>
 <p>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. </p>
 <p>If a copy of the MPL was not distributed with this file, You can obtain one at <a href=\"http://mozilla.org/MPL/2.0/\"> http://mozilla.org/MPL/2.0</a>.</p>
 <p>&nbsp;</p>
+<p>&nbsp;</p>
 <p>iPSL:</p>
 <p>Copyright 2015-2016 RTE (France), SmarTS Lab (Sweden), AIA (Spain) and DTU (Denmark)</p>
 <ul>

diff --git a/OpenIPSL/Electrical/Banks/PSSE/CSVGN1.mo b/OpenIPSL/Electrical/Banks/PSSE/CSVGN1.mo
@@ -1,5 +1,5 @@
 within OpenIPSL.Electrical.Banks.PSSE;
-model CSVGN1 "STATC SHUNT COMPENSATOR MODEL"
+model CSVGN1 "STATIC SHUNT COMPENSATOR MODEL"
   extends Icons.VerifiedModel;
   outer OpenIPSL.Electrical.SystemBase SysData
     "Must add this line in all models";
@@ -13,7 +13,7 @@ model CSVGN1 "STATC SHUNT COMPENSATOR MODEL"
     annotation (Dialog(group="Power flow data"));
   parameter Types.Angle angle_0=0 "Initial voltage angle"
     annotation (Dialog(group="Power flow data"));
-  parameter Types.PerUnit ra=0 "amature resistance" annotation (Dialog(group="Plant parameters", enable = false));
+  parameter Types.PerUnit ra=0 "Armature resistance" annotation (Dialog(group="Plant parameters", enable = false));
   parameter Types.PerUnit x1d=9999 "d-axis transient reactance, should be set to 9999" annotation (Dialog(group="Plant parameters", enable = false));
   parameter Real K=1 annotation (Dialog(group="Device parameters"));
   parameter Types.Time T1=0 annotation (Dialog(group="Device parameters"));
@@ -157,25 +157,24 @@ equation
           textString="CSVGN1"),Text(
           extent={{-100,-100},{100,-140}},
           lineColor={0,0,255},
-          textString="%name")}), Documentation(info="<html>
+          textString="%name")}), Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
-<td>PSS/E Manual</td>
+<td><p>PSS&reg;E Manual</p></td>
 </tr>
 <tr>
 <td><p>Last update</p></td>
-<td>September 2020</td>
+<td>2020-09</td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>ALSETLab, Rensselaer Polytechnic Insitute</p></td>
+<td><p>ALSETLab, Rensselaer Polytechnic Institute</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
-<p> This model has been verified against PSS/E.</p>
 </html>"));
 end CSVGN1;
diff --git a/OpenIPSL/Electrical/Banks/Simulink/Shunt.mo b/OpenIPSL/Electrical/Banks/Simulink/Shunt.mo
@@ -31,7 +31,7 @@ equation
           color={0,0,255},
           origin={-6,-77},
           rotation=-90),Line(points={{0,100},{0,20}}, color={0,0,255}),Line(
-          points={{0,-40},{0,-72}}, color={0,0,255})}), Documentation(info="<html>
+          points={{0,-40},{0,-72}}, color={0,0,255})}), Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -43,11 +43,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/PSAT/ThreeWindingTransformer.mo b/OpenIPSL/Electrical/Branches/PSAT/ThreeWindingTransformer.mo
@@ -101,22 +101,22 @@ equation
           extent={{-100,140},{100,80}},
           lineColor={0,0,255},
           textString="%name")}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
 <td><p>Reference</p></td>
 <td><p>PSAT Manual 2.1.8</p></td>
 </tr>
 <tr>
 <td><p>Last update</p></td>
-<td><p>15/07/2015</p></td>
+<td><p>2015-07-15</p></td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>MAA Murad, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>MAA Murad, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/PSAT/TwoWindingTransformer.mo b/OpenIPSL/Electrical/Branches/PSAT/TwoWindingTransformer.mo
@@ -139,22 +139,22 @@ equation
           lineColor={0,255,0},
           fillColor={0,255,0},
           fillPattern=FillPattern.Solid)}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
 <td><p>Reference</p></td>
 <td><p>PSAT Manual 2.1.8</p></td>
 </tr>
 <tr>
 <td><p>Last update</p></td>
-<td><p>29/09/2015</p></td>
+<td><p>2015-09-29</p></td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>MAA Murad, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>MAA Murad, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/PSAT/ULTC_VoltageControl.mo b/OpenIPSL/Electrical/Branches/PSAT/ULTC_VoltageControl.mo
@@ -104,22 +104,22 @@ equation
           extent={{-100,100},{100,40}},
           lineColor={0,0,255},
           textString="%name")}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
 <td><p>Reference</p></td>
 <td><p>PSAT Manual 2.1.8</p></td>
 </tr>
 <tr>
 <td><p>Last update</p></td>
-<td><p>15/07/2015</p></td>
+<td><p>2015-07-15</p></td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>MAA Murad, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>MAA Murad, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC.mo b/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC.mo
@@ -83,7 +83,7 @@ equation
           fillPattern=FillPattern.Solid,
           textString="LTC
     ")}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -95,11 +95,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_deadband.mo b/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_deadband.mo
@@ -26,7 +26,7 @@ equation
           fillColor={255,255,255},
           fillPattern=FillPattern.Solid,
           textString="deadband")}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -38,11 +38,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_lookup.mo b/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_lookup.mo
@@ -37,7 +37,7 @@ equation
           points={{12,20},{34,20},{52,20}},
           color={0,0,255},
           smooth=Smooth.None)}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -49,11 +49,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_quantizer.mo b/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_quantizer.mo
@@ -86,7 +86,7 @@ equation
             26},{34,32},{42,32},{42,38},{50,38},{50,44},{60,44}},
           color={0,0,255},
           smooth=Smooth.None)}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -98,11 +98,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_switch.mo b/OpenIPSL/Electrical/Branches/Simulink/LTC/LTC_switch.mo
@@ -32,7 +32,7 @@ equation
           color={0,0,255},
           smooth=Smooth.None,
           thickness=1)}),
-    Documentation(info="<html>
+    Documentation(revisions="<html>
 <table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Reference</p></td>
@@ -44,11 +44,11 @@ equation
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Le Qi, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p>Le Qi, KTH Royal Institute of Technology</p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Buses/BusExt.mo b/OpenIPSL/Electrical/Buses/BusExt.mo
@@ -64,22 +64,21 @@ equation
           lineColor={0,0,255},
           fillColor={85,170,255},
           fillPattern=FillPattern.Solid)}),
-    Documentation(info="<html>
-<table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
-<td><p>Reference</p></td>
-<td><p>None</p></td>
-</tr>
+    Documentation(revisions="<html>
+<table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Last update</p></td>
 <td><p>2017-07-07</p></td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Jan Lavenius, Giuseppe Laera, KTH Royal Institute of Technology; <a href=\"https://github.com/tbeu\">tbeu</a> </p></td>
+<td><p><a href=\"https://github.com/GiuseppeLaera\">@GiuseppeLaera</a></p>
+    <p><a href=\"https://github.com/janlav\">@janlav</a></p>
+    <p><a href=\"https://github.com/tbeu\">@tbeu</a></p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Buses/InfiniteBus.mo b/OpenIPSL/Electrical/Buses/InfiniteBus.mo
@@ -55,22 +55,19 @@ equation
           extent={{-100,160},{100,120}},
           lineColor={0,0,255},
           textString="%name")}),
-    Documentation(info="<html>
-<table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
-<td><p>Reference</p></td>
-<td><p>None</p></td>
-</tr>
+    Documentation(revisions="<html>
+<table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
 <tr>
 <td><p>Last update</p></td>
 <td><p>2015-12-14</p></td>
 </tr>
 <tr>
 <td><p>Author</p></td>
-<td><p>Maxime Baudette, SmarTS Lab, KTH Royal Institute of Technology</p></td>
+<td><p><a href=\"https://github.com/MaximeBaudette\">@MaximeBaudette</a></p></td>
 </tr>
 <tr>
 <td><p>Contact</p></td>
-<td><p><a href=\"mailto:[email protected]\">[email protected]</a></p></td>
+<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
 </tr>
 </table>
 </html>"));

diff --git a/OpenIPSL/Electrical/Controls/CGMES/TG/package.mo b/OpenIPSL/Electrical/Controls/CGMES/TG/package.mo
@@ -1,30 +1,4 @@
 within OpenIPSL.Electrical.Controls.CGMES;
 package TG 
-annotation (Documentation(revisions="<html>
-<!--DISCLAIMER-->
-<p>OpenIPSL:</p>
-<p>Copyright 2016 SmarTS Lab (Sweden)</p>
-<ul>
-<li>SmarTS Lab, research group at KTH: <a href=\"https://www.kth.se/en\">https://www.kth.se/en</a></li>
-</ul>
-<p>The authors can be contacted by email: <a href=\"mailto:[email protected]\">[email protected]</a></p>
-
-<p>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. </p>
-<p>If a copy of the MPL was not distributed with this file, You can obtain one at <a href=\"http://mozilla.org/MPL/2.0/\"> http://mozilla.org/MPL/2.0</a>.</p>
-
-<p></p>
-<p>iPSL:</p>
-<p>Copyright 2015-2016 RTE (France), SmarTS Lab (Sweden), AIA (Spain) and DTU (Denmark)</p>
-<ul>
-<li>RTE: <a href=\"http://www.rte-france.com\">http://www.rte-france.com</a></li>
-<li>SmarTS Lab, research group at KTH: <a href=\"https://www.kth.se/en\">https://www.kth.se/en</a></li>
-<li>AIA: <a href=\"http://www.aia.es/en/energy\"> http://www.aia.es/en/energy</a></li>
-<li>DTU: <a href=\"http://www.dtu.dk/english\"> http://www.dtu.dk/english</a></li>
-</ul>
-<p>The authors can be contacted by email: <a href=\"mailto:[email protected]\">[email protected]</a></p>
-
-<p>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. </p>
-<p>If a copy of the MPL was not distributed with this file, You can obtain one at <a href=\"http://mozilla.org/MPL/2.0/\"> http://mozilla.org/MPL/2.0</a>.</p>
-</html>
-"));
+  extends Modelica.Icons.Package;
 end TG;