Add User's Guide and bump to version 0.6.0

The contents of the User's Guide package is still very basic, but includes the typical classes and will be able to accommodate more comprehensive documentation in the future.
raulrpearson · Apr 2, 2017 · d829c5d · d829c5d
1 parent 5ae5dea
commit d829c5d
Show file tree

Hide file tree

Showing 7 changed files with 172 additions and 2 deletions.
diff --git a/PVSystems/UsersGuide/License.mo b/PVSystems/UsersGuide/License.mo
@@ -0,0 +1,39 @@
+within PVSystems.UsersGuide;
+class License "License"
+  extends Modelica.Icons.Information;
+  annotation (Documentation(info="<html>
+      <p>
+        MIT License
+      </p>
+    
+      <p>
+        Copyright (c) 2016-2017 Raúl Rodríguez Pearson
+      </p>
+    
+      <p>
+        Permission is hereby granted, free of charge, to any person
+        obtaining a copy of this software and associated documentation
+        files (the \"Software\"), to deal in the Software without
+        restriction, including without limitation the rights to use, copy,
+        modify, merge, publish, distribute, sublicense, and/or sell copies
+        of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+      </p>
+    
+      <p>
+        The above copyright notice and this permission notice shall be
+        included in all copies or substantial portions of the Software.
+      </p>
+    
+      <p>
+        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+        DEALINGS IN THE SOFTWARE.
+      </p>
+    </html>"));
+end License;
diff --git a/PVSystems/UsersGuide/References.mo b/PVSystems/UsersGuide/References.mo
@@ -0,0 +1,21 @@
+within PVSystems.UsersGuide;
+class References "References"
+  extends Modelica.Icons.References;
+  annotation (Documentation(info="<html>
+      <ol>
+        <li>O. Tremblay, L. A. Dessaint, and A. I. Dekkiche, “A Generic
+          Battery Model for the Dynamic Simulation of Hybrid Electric
+          Vehicles,” in 2007 IEEE Vehicle Power and Propulsion Conference,
+          2007, pp. 284–289.
+        </li>
+        <li>R. W. Erickson and D. Maksimović, Fundamentals of Power
+          Electronics. Springer Science &amp; Business Media, 2001.
+        </li>
+        <li>M. G. Villalva, J. R. Gazoli, and E. R. Filho, “Comprehensive
+          Approach to Modeling and Simulation of Photovoltaic Arrays,”
+          IEEE Transactions on Power Electronics, vol. 24, no. 5,
+          pp. 1198–1208, May 2009.
+        </li>
+      </ol>
+    </html>"));
+end References;
diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.mo b/PVSystems/UsersGuide/ReleaseNotes/package.mo
@@ -0,0 +1,61 @@
+within PVSystems.UsersGuide;
+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>
+        This section includes an item per release, indicating version
+        number and release date. Release notes are included under each
+        corresponding item.
+      </p>
+    
+      <p>
+        <a href=\"http://semver.org/\">Semantic Versioning</a> is followed
+        to establish version numbers. Given a version number
+        MAJOR.MINOR.PATCH, an increment in the:
+      </p>
+      <ul class=\"org-ul\">
+        <li>MAJOR version indicates incompatible API changes.
+        </li>
+        <li>MINOR version indicates new functionality in a
+          backwards-compatible manner.
+        </li>
+        <li>PATCH version indicates backwards-compatible bug fixes.
+        </li>
+      </ul>
+    
+      <p>
+        Notice, though, that major version zero (0.y.z) is for initial
+        development - anything may change at any time and the public API
+        should not be considered stable.</p>
+    </html>"));
+end ReleaseNotes;
diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.order b/PVSystems/UsersGuide/ReleaseNotes/package.order
@@ -0,0 +1 @@
+Version_0_6_0
diff --git a/PVSystems/UsersGuide/package.mo b/PVSystems/UsersGuide/package.mo
@@ -0,0 +1,44 @@
+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/UsersGuide/package.order b/PVSystems/UsersGuide/package.order
@@ -0,0 +1,4 @@
+References
+ReleaseNotes
+Contact
+License
diff --git a/PVSystems/package.mo b/PVSystems/package.mo
@@ -6,8 +6,8 @@ extends Modelica.Icons.Package;
 annotation (
   uses(Modelica(version="3.2.2")),
   preferredView="info",
-  version="0.5.1",
-  versionDate="2016-12-13",
+  version="0.6.0",
+  versionDate="2017-04-03",
   Documentation(info="<html>
         <p>
           <b>Overview</b>