From d829c5dcb280f56db5b1bbe849bc72c0e6d24239 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Rodr=C3=ADguez=20Pearson?= Date: Sun, 2 Apr 2017 20:08:44 +0200 Subject: [PATCH] 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. --- PVSystems/UsersGuide/License.mo | 39 ++++++++++++ PVSystems/UsersGuide/References.mo | 21 +++++++ PVSystems/UsersGuide/ReleaseNotes/package.mo | 61 +++++++++++++++++++ .../UsersGuide/ReleaseNotes/package.order | 1 + PVSystems/UsersGuide/package.mo | 44 +++++++++++++ PVSystems/UsersGuide/package.order | 4 ++ PVSystems/package.mo | 4 +- 7 files changed, 172 insertions(+), 2 deletions(-) create mode 100644 PVSystems/UsersGuide/License.mo create mode 100644 PVSystems/UsersGuide/References.mo create mode 100644 PVSystems/UsersGuide/ReleaseNotes/package.mo create mode 100644 PVSystems/UsersGuide/ReleaseNotes/package.order create mode 100644 PVSystems/UsersGuide/package.mo create mode 100644 PVSystems/UsersGuide/package.order diff --git a/PVSystems/UsersGuide/License.mo b/PVSystems/UsersGuide/License.mo new file mode 100644 index 0000000..2d5e57d --- /dev/null +++ b/PVSystems/UsersGuide/License.mo @@ -0,0 +1,39 @@ +within PVSystems.UsersGuide; +class License "License" + extends Modelica.Icons.Information; + annotation (Documentation(info=" +

+ MIT License +

+ +

+ Copyright (c) 2016-2017 Raúl Rodríguez Pearson +

+ +

+ 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: +

+ +

+ The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. +

+ +

+ 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. +

+ ")); +end License; diff --git a/PVSystems/UsersGuide/References.mo b/PVSystems/UsersGuide/References.mo new file mode 100644 index 0000000..c00aa84 --- /dev/null +++ b/PVSystems/UsersGuide/References.mo @@ -0,0 +1,21 @@ +within PVSystems.UsersGuide; +class References "References" + extends Modelica.Icons.References; + annotation (Documentation(info=" +
    +
  1. 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. +
    2. +
  2. R. W. Erickson and D. Maksimović, Fundamentals of Power + Electronics. Springer Science & Business Media, 2001. +
    3. +
  3. 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. +
    4. +
+ ")); +end References; diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.mo b/PVSystems/UsersGuide/ReleaseNotes/package.mo new file mode 100644 index 0000000..5290751 --- /dev/null +++ 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=" +

+ Changes: +

+ +

+ Additions: +

+ + ")); + end Version_0_6_0; + +annotation (Documentation(info=" +

+ This section includes an item per release, indicating version + number and release date. Release notes are included under each + corresponding item. +

+ +

+ Semantic Versioning is followed + to establish version numbers. Given a version number + MAJOR.MINOR.PATCH, an increment in the: +

+ + +

+ 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.

+ ")); +end ReleaseNotes; diff --git a/PVSystems/UsersGuide/ReleaseNotes/package.order b/PVSystems/UsersGuide/ReleaseNotes/package.order new file mode 100644 index 0000000..5d48c7e --- /dev/null +++ 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 new file mode 100644 index 0000000..c35e4c7 --- /dev/null +++ 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=" +

+ Copyright (c) 2016-2017 Raúl Rodríguez Pearson +

+ +

+ If you have any questions, comments, suggestions, ideas or + feature requests, please do share those as well as + any mistakes or bugs you might discover. You can + open an issue in + the Issues + section of the repository or, if you prefer, contact the + author + by email. Contributions + in the form + of Pull + Requests are always welcome. +

+ +

+ The library is the result of a research project carried out in the + form of a master's degree thesis under the supervision + of Dr. Alfonso + Urquía from + the Research group on + Modelling & Simulation in Control Engineering, part of + the Department of Computer + Science & Automatic Control + at Universidad + Nacional de Educación a Distancia.

+ ")); + end Contact; + +annotation (DocumentationClass=true); +end UsersGuide; diff --git a/PVSystems/UsersGuide/package.order b/PVSystems/UsersGuide/package.order new file mode 100644 index 0000000..6dbf4aa --- /dev/null +++ b/PVSystems/UsersGuide/package.order @@ -0,0 +1,4 @@ +References +ReleaseNotes +Contact +License diff --git a/PVSystems/package.mo b/PVSystems/package.mo index fff1d2d..1ba264f 100644 --- 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="

Overview