Fix UsersGuide package

The UsersGuide package had some classes stored in folders and some in a single-file format. This has been fixed. Release notes for 0.6.1 have also been added, in preparation for release.
raulrpearson · Apr 19, 2017 · 370b866 · 370b866
1 parent 1cb7da9
commit 370b866
Show file tree

Hide file tree

Showing 9 changed files with 164 additions and 67 deletions.
diff --git a/PVSystems/UsersGuide/Contact.mo b/PVSystems/UsersGuide/Contact.mo
@@ -0,0 +1,35 @@
+within PVSystems.UsersGuide;
+class Contact "Contact"
+  extends Modelica.Icons.Contact;
+  annotation (Documentation(info="<html>
+      <p>
+        Copyright (c) 2016-2017 Raúl Rodríguez Pearson
+      </p>
+    
+      <p>
+        If you have any <b><b>questions, comments, suggestions, ideas or
+            feature requests</b></b>, please do share those as well as
+            any <b><b>mistakes or bugs</b></b> you might discover. You can
+            open an issue in
+            the <a href=\"https://github.com/raulrpearson/PVSystems/issues\">Issues</a>
+            section of the repository or, if you prefer, contact the
+            author
+            by <a href=\"mailto:[email protected]\">email</a>. Contributions
+            in the form
+            of <a href=\"https://github.com/raulrpearson/PVSystems/pulls\">Pull
+            Requests</a> are always welcome.
+      </p>
+    
+      <p>
+        The library is the result of a research project carried out in the
+        form of a master's degree thesis under the supervision
+        of <a href=\"http://www.euclides.dia.uned.es/aurquia/index.html\">Dr. Alfonso
+        Urquía</a> from
+        the <a href=\"http://www.euclides.dia.uned.es/\">Research group on
+        Modelling &amp; Simulation in Control Engineering</a>, part of
+        the <a href=\"http://www.dia.uned.es/\">Department of Computer
+        Science &amp; Automatic Control</a>
+        at <a href=\"http://www.uned.es/webuned/home.htm\">Universidad
+        Nacional de Educación a Distancia</a>.</p>
+    </html>"));
+end Contact;
diff --git a/PVSystems/UsersGuide/License.mo b/PVSystems/UsersGuide/License.mo
@@ -1,6 +1,5 @@
 within PVSystems.UsersGuide;
 class License "License"
-  extends Modelica.Icons.Information;
   annotation (Documentation(info="<html>
       <p>
         MIT License
@@ -35,5 +34,29 @@ class License "License"
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
         DEALINGS IN THE SOFTWARE.
       </p>
-    </html>"));
+    </html>"), Icon(graphics={
+        Line(points={{-60,60},{60,60}}, color={95,95,95}),
+        Line(points={{0,60},{0,-60}}, color={95,95,95}),
+        Line(points={{-60,-60},{60,-60}}, color={95,95,95}),
+        Ellipse(
+          extent={{-10,70},{10,50}},
+          lineColor={95,95,95},
+          fillColor={175,175,175},
+          fillPattern=FillPattern.Solid),
+        Ellipse(
+          extent={{-90,-10},{-30,-50}},
+          lineColor={95,95,95},
+          fillColor={175,175,175},
+          fillPattern=FillPattern.Solid,
+          startAngle=0,
+          endAngle=180),
+        Ellipse(
+          extent={{30,-10},{90,-50}},
+          lineColor={95,95,95},
+          fillColor={175,175,175},
+          fillPattern=FillPattern.Solid,
+          startAngle=0,
+          endAngle=180),
+        Line(points={{-90,-10},{-60,60},{-30,-10}}, color={95,95,95}),
+        Line(points={{30,-10},{60,60},{90,-10}}, color={95,95,95})}));
 end License;
diff --git a/PVSystems/UsersGuide/References/EMA16.mo b/PVSystems/UsersGuide/References/EMA16.mo
@@ -1,7 +1,7 @@
 within PVSystems.UsersGuide.References;
 class EMA16 "<html>R. W. Erickson, D. Maksimović and K. Afridi,
   <a href=\"https://www.coursera.org/specializations/power-electronics\">
-  <i>Power Electronics Specialization<\\i></a> at Coursera.
+  <i>Power Electronics Specialization</i></a> at Coursera.
   University of Colorado Boulder, 2016.</html>"
   extends Modelica.Icons.References;
   annotation (preferredView="info", DocumentationClass=false);

diff --git a/PVSystems/UsersGuide/ReleaseNotes/Version_0_6_0.mo b/PVSystems/UsersGuide/ReleaseNotes/Version_0_6_0.mo
@@ -0,0 +1,28 @@
+within PVSystems.UsersGuide.ReleaseNotes;
+class Version_0_6_0 "Version 0.6.0 (April 3, 2017)"
+  extends Modelica.Icons.ReleaseNotes;
+  annotation (Documentation(info="<html>
+      <p>
+        <b>Changes</b>:
+      </p>
+      <ul class=\"org-ul\">
+        <li>The main change in this release is a very heavy refactoring of
+          files. Functionality wise, the library hasn't changed that much,
+          but every model has been split into it's own file.
+        </li>
+        <li>Updated the info text for the root class PVSystems with the
+          contents of the README.md file.
+        </li>
+      </ul>
+      <p>
+        <b>Additions</b>:
+      </p>
+      <ul class=\"org-ul\">
+        <li>Added battery model together with a validation example model.
+        </li>
+        <li>Added User's Guide package with References, Release Notes,
+          Contact and License information.
+        </li>
+      </ul>
+    </html>"));
+end Version_0_6_0;
diff --git a/PVSystems/UsersGuide/ReleaseNotes/Version_0_6_1.mo b/PVSystems/UsersGuide/ReleaseNotes/Version_0_6_1.mo
@@ -0,0 +1,67 @@
+within PVSystems.UsersGuide.ReleaseNotes;
+class Version_0_6_1 "Version 0.6.1 (April 19, 2017)"
+  extends Modelica.Icons.ReleaseNotes;
+  annotation (Documentation(info="<html>
+  <p>
+    <strong>Modifications</strong>:
+  </p>
+  <ul class=\"org-ul\">
+    <li>The averaged switch models have been expanded. As a start, a
+      partial
+      model <a href=\"modelica://PVSystems.Electrical.Interfaces.SwitchNetworkInterface\">SwitchNetworkInterface</a>
+      has been added to provide the common interface.
+    </li>
+    <li>Many models and blocks (especially blocks) with no icons have
+      been given an icon. Things look much better.
+    </li>
+    <li>The controller assemblies have been moved to
+      an <a href=\"modelica://PVSystems.Control.Assemblies\">Assemblies</a>
+      package and have been reviewed, cleaned up and some bugs have
+      been resolved (in the previous commit, none of them really
+      worked).
+    </li>
+  </ul>
+  <p>
+    <strong>Additions</strong>:
+  </p>
+  <ul class=\"org-ul\">
+    <li>An <a href=\"modelica://PVSystems.Icons\">Icons</a> package
+      has been added to hold icons that can be reused.
+    </li>
+    <li>Interfaces and Assemblies packages have been added
+      to <a href=\"modelica://PVSystems.Electrical\">Electrical</a>
+      and <a href=\"modelica://PVSystems.Control\">Control</a> to hold
+      partial models and models, respectively, that can be reused.
+    </li>
+    <li>All of the averaged switch variants
+      in <a href=\"modelica://PVSystems.UsersGuide.References.EM01\">EM01</a>
+      and <a href=\"modelica://PVSystems.UsersGuide.References.EMA16\">EMA16</a>
+      have been added
+      (<a href=\"modelica://PVSystems.Electrical.CCM1\">CCM1</a>, <a href=\"modelica://PVSystems.Electrical.CCM2\">CCM2</a>, <a href=\"modelica://PVSystems.Electrical.CCM3\">CCM3</a>, <a href=\"modelica://PVSystems.Electrical.CCM4\">CCM4</a>, <a href=\"modelica://PVSystems.Electrical.CCM5\">CCM5</a>, <a href=\"modelica://PVSystems.Electrical.CCM_DCM1\">CCM-DCM1</a>
+      and <a href=\"modelica://PVSystems.Electrical.CCM_DCM2\">CCM-DCM2</a>).
+    </li>
+    <li>Additionally some averaged and switched control blocks also
+      in <a href=\"modelica://PVSystems.UsersGuide.References.EM01\">EM01</a>
+      and <a href=\"modelica://PVSystems.UsersGuide.References.EMA16\">EMA16</a>
+      have also been added
+      (<a href=\"modelica://PVSystems.Control.SwitchingCPM\">SwitchingCPM</a>, <a href=\"modelica://PVSystems.Control.CPM_CCM\">CPM-CCM</a>, <a href=\"modelica://PVSystems.Control.CPM\">CPM</a>).
+    </li>
+    <li>A <a href=\"modelica://PVSystems.Control.DeadTime\">DeadTime</a>
+      block has been added to be used in conjunction with any of the
+      blocks producing switching signals
+      (currently <a href=\"modelica://PVSystems.Control.SignalPWM\">SignalPWM</a>
+      and <a href=\"modelica://PVSystems.Control.SwitchingCPM\">SwitchingCPM</a>),
+      to create a complement switching signal with an optional dead
+      time value.
+    </li>
+  </ul>
+  <p>
+    <strong>Deletions</strong>:
+  </p>
+  <ul class=\"org-ul\">
+    <li>The model Ideal2LevelLeg has been removed since it added
+      complexity and didn't seem to be that useful.
+    </li>
+  </ul>
+</html>"));
+end Version_0_6_1;
diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.mo b/PVSystems/UsersGuide/ReleaseNotes/package.mo
@@ -3,33 +3,6 @@ package ReleaseNotes "Release notes"
 extends Modelica.Icons.ReleaseNotes;
 
 
-class Version_0_6_0 "Version 0.6.0 (April 3, 2017)"
-  extends Modelica.Icons.ReleaseNotes;
-  annotation (Documentation(info="<html>
-      <p>
-        <b>Changes</b>:
-      </p>
-      <ul class=\"org-ul\">
-        <li>The main change in this release is a very heavy refactoring of
-          files. Functionality wise, the library hasn't changed that much,
-          but every model has been split into it's own file.
-        </li>
-        <li>Updated the info text for the root class PVSystems with the
-          contents of the README.md file.
-        </li>
-      </ul>
-      <p>
-        <b>Additions</b>:
-      </p>
-      <ul class=\"org-ul\">
-        <li>Added battery model together with a validation example model.
-        </li>
-        <li>Added User's Guide package with References, Release Notes,
-          Contact and License information.
-        </li>
-      </ul>
-    </html>"));
-  end Version_0_6_0;
 
 annotation (Documentation(info="<html>
       <p>

diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.order b/PVSystems/UsersGuide/ReleaseNotes/package.order
@@ -1 +1,2 @@
+Version_0_6_1
 Version_0_6_0
diff --git a/PVSystems/UsersGuide/package.mo b/PVSystems/UsersGuide/package.mo
@@ -1,44 +1,10 @@
-within PVSystems;
+within PVSystems;
 package UsersGuide "User's Guide"
 extends Modelica.Icons.Information;
 
 
 
 
-class Contact "Contact"
-  extends Modelica.Icons.Contact;
-  annotation (Documentation(info="<html>
-      <p>
-        Copyright (c) 2016-2017 Raúl Rodríguez Pearson
-      </p>
-    
-      <p>
-        If you have any <b><b>questions, comments, suggestions, ideas or
-            feature requests</b></b>, please do share those as well as
-            any <b><b>mistakes or bugs</b></b> you might discover. You can
-            open an issue in
-            the <a href=\"https://github.com/raulrpearson/PVSystems/issues\">Issues</a>
-            section of the repository or, if you prefer, contact the
-            author
-            by <a href=\"mailto:[email protected]\">email</a>. Contributions
-            in the form
-            of <a href=\"https://github.com/raulrpearson/PVSystems/pulls\">Pull
-            Requests</a> are always welcome.
-      </p>
-    
-      <p>
-        The library is the result of a research project carried out in the
-        form of a master's degree thesis under the supervision
-        of <a href=\"http://www.euclides.dia.uned.es/aurquia/index.html\">Dr. Alfonso
-        Urquía</a> from
-        the <a href=\"http://www.euclides.dia.uned.es/\">Research group on
-        Modelling &amp; Simulation in Control Engineering</a>, part of
-        the <a href=\"http://www.dia.uned.es/\">Department of Computer
-        Science &amp; Automatic Control</a>
-        at <a href=\"http://www.uned.es/webuned/home.htm\">Universidad
-        Nacional de Educación a Distancia</a>.</p>
-    </html>"));
-  end Contact;
 
 annotation (DocumentationClass=true);
 end UsersGuide;
diff --git a/PVSystems/package.mo b/PVSystems/package.mo
@@ -3,11 +3,15 @@ extends Modelica.Icons.Package;
 
 
 
+
+
+
+
 annotation (
   uses(Modelica(version="3.2.2")),
   preferredView="info",
-  version="0.6.0",
-  versionDate="2017-04-03",
+  version="0.6.1",
+  versionDate="2017-04-19",
   Documentation(info="<html>
         <p>
           <b>Overview</b>