Release 3.0.0 (AMIT-HSBI#80)

* Update RevisionHistory
* Removing broken Dymola Test scripts
* Adding documentation to root package.mo
* Updating README

---------

Co-authored-by: AnHeuermann <38031952+AnHeuermann@users.noreply.github.com>

PNlib/UsersGuide/Contact.mo

@@ -32,20 +32,20 @@ model Contact
      <tr>
        <td valign=top>
        <a>S. Proß</a><br>
-       <a>mailto: sabrina.pross@fh-bielefeld.de</a><br>
-       <td valign=top>University of Applied Sciences Bielefeld<br>
-         <a>Department of engineering and mathematics</a><br>
-         33609 Bielefeld<br>
+       <a>mailto: sabrina.pross@hsbi.de</a><br>
+       <td valign=top>Hochschule Bielefeld University of Applied Sciences and Arts (HSBI)<br>
+         <a>Faculty of Engineering and Mathematics</a><br>
+         33619 Bielefeld<br>
          Germany
        </td>
      </tr>
      <tr>
        <td valign=top>
        <a>B. Bachmann</a><br>
-       <a>mailto: bernhard.bachmann@fh-bielefeld.de</a><br>
-       <td valign=top>University of Applied Sciences Bielefeld<br>
-         <a>Department of engineering and mathematics</a><br>
-         33609 Bielefeld<br>
+       <a>mailto: bernhard.bachmann@hsbi.de</a><br>
+       <td valign=top>Hochschule Bielefeld University of Applied Sciences and Arts (HSBI)<br>
+         <a>Faculty of Engineering and Mathematics</a><br>
+         33619 Bielefeld<br>
          Germany
        </td>
      </tr>

PNlib/UsersGuide/RevisionHistory.mo

@@ -93,6 +93,19 @@ model RevisionHistory
       <li>Minor bug fixes</li>
     </ul></td>
   </tr>
+
+  <tr>
+    <td valign=\"top\">3.0.0</td>
+    <td valign=\"top\">2024-02-03</td>
+    <td valign=\"top\">Philip Hannebohm, Andreas Heuermann</td>
+    <td valign=\"top\"><ul>
+      <li>Updated to use Modelica 4.0.0</li>
+      <li>Removed unused functions</li>
+      <li>Updated Contact information</li>
+      <li>Changed to 3-Clause BSD license</li>
+      <li>Added Continuous Integration GitHub workflow</li>
+    </ul></td>
+  </tr>
 </table>
 </html>"));
 end RevisionHistory;

PNlib/UsersGuide/UserGuide.mo

@@ -148,8 +148,8 @@ This conflict can be solved by prioritization of the transitions. If T1 takes pr
 <h1> PNlib: A Modelica Library for Modeling xHPN </h1>
 <p>Compatibility</p>
 <ul>
-<li>PNlib works with OpenModelica 1.9.4</li>
-<li>PNlib works with OpenModelica Dymola 2016</li>
+<li>PNlib works with OpenModelica 1.22</li>
+<li>PNlib works with Dymola 2017/2019/2020</li>
 </ul>
 <p>The advanced Petri Net library, called PNlib, enables the modeling of extended hybrid Petri Nets (xHPN).
 It comprises</p>
@@ -311,8 +311,8 @@ enablingProbOut={0.3, 0.25, 0.45}.</p>
 a connected transition. In the case of the discrete place model, this is realized by the
 discrete equation</p>
 <pre>
-<b>when</b> tokeninout <b>or<\b>  <b>pre</b>(reStart) <b>then</b>
-  t = <b>if</b> tokeninout <b>then</b> <b>pre</b>(t) + firingSumIn - firingSumOut <b>else<\b> reStartTokens;
+<b>when</b> tokeninout <b>or</b> <b>pre</b>(reStart) <b>then</b>
+  t = <b>if</b> tokeninout <b>then</b> <b>pre</b>(t) + firingSumIn - firingSumOut <b>else</b> reStartTokens;
 <b>end when</b>;
 </pre>
 <p>
@@ -325,9 +325,9 @@ The marking of continuous places can change continuously as well as discretely.
 This is implemented by the following construct
 </p>
 <pre>
-der(t) = conMarkChange;
+<b>der</b>(t) = conMarkChange;
 <b>when</b> disMarksInOut <b>then</b>
-  <b>reinit</b>(t, t+disMarkChange);
+  <b>reinit</b>(t, t + disMarkChange);
 <b>end when</b>;
 <b>when</b> reStart <b>then</b>
   <b>reinit</b>(t, reStartMarks);
@@ -421,7 +421,7 @@ arcWeightIn = {2*P1.t, 4} and arcWeightOut = {2, 1, 5*P1.t},
 whereby the expression P1.t accesses the current token number of P1. Thus, the weights of the arcs (P1-T1) and (T1-P5) are functions which depend on the token number of P1.
 Transitions can also be provided with additional conditions that have to be satisfied to permit the activation. The condition</p>
 <p>
-firingCon = time>9.7
+firingCon = time > 9.7
 </p>
 <p>
 causes that the transition cannot be activated as long as time is less than 9.7.

PNlib/package.mo

@@ -1,5 +1,43 @@
 package PNlib
   annotation(
     uses(Modelica(version = "4.0.0")),
-    version = "2.2");
+    version = "3.0.0",
+    Documentation(info = "<html>
+    <p>Free Modelica library for modelling xHPN.</p>
+    <h2 id=\"library-description\">Library description</h2>
+    <p>The advanced Petri Net library, called PNlib, enables the modeling of extended
+      hybrid Petri Nets (xHPN). It comprises</p>
+    <ul>
+      <li>discrete (PD) and continuous places (PC),</li>
+      <li>discrete (TD), stochastic (TS), and continuous transitions (TC), and</li>
+      <li>test (TA), inhibitor (IA), and read arcs (RA).</li>
+    </ul>
+    <p><img src=\"modelica://PNlib/Resources/Images/iconsxHPN.png\" alt=\"iconsxHPN\" title=\"xHPN: Extended Hybrid PetriNets\"></p>
+    <p>The main package PNlib is divided into the following sub-packages:</p>
+    <ul>
+      <li><em>Interfaces</em>: contains the connectors of the Petri net component models.</li>
+      <li><em>Blocks</em>: contains blocks with specific procedures that are used in the Petri
+        net component models.</li>
+      <li><em>Functions</em>: contains functions with specific algorithmic procedures which
+        are used in the Petri net component models.</li>
+      <li><em>Constants</em>: contains constants which are used in the Petri net component
+        models.</li>
+      <li><em>Examples</em>: contains several examples and unit tests.</li>
+    </ul>
+    <h2 id=\"license\">License</h2>
+    <p>This package is licensed with the <a href=\"https://github.com/AMIT-HSBI/PNlib/blob/v3.0.0/LICENSE\">3-Clause BSD License</a>.</p>
+    <h2 id=\"development-and-contribution\">Development and contribution</h2>
+    Hochschule Bielefeld - University of Applied Sciences and Arts<br>
+    Faculty of Engineering and Mathematics
+    <ul>
+      <li>Sabrina Proß</li>
+      <li>Lennart Ochel</li>
+      <li>Timo Lask</li>
+      <li>Bernhard Bachmann</li>
+    </ul>
+    <p>You may report feedback, issues or feature-requests using
+      <a href=\"https://github.com/AMIT-HSBI/PNlib/issues\">GitHub Issues</a>.
+    </p>
+    </html>")
+  );
 end PNlib;

README.md

@@ -54,7 +54,7 @@ Hochschule Bielefeld – University of Applied Sciences and Arts
 Faculty of Engineering and Mathematics
 ```
 
-  * Sabrina Proß
+  * Sabrina Proß
   * Lennart Ochel
   * Timo Lask
   * Bernhard Bachmann