Finalizing release

- Removing broken Dymola Test scripts - Adding documentation to root package.mo - Updating README
AMIT-HSBI · Feb 13, 2024 · 58f031a · 58f031a
1 parent f77314b
commit 58f031a
Show file tree

Hide file tree

Showing 58 changed files with 47 additions and 2,101 deletions.
diff --git a/PNlib/UsersGuide/UserGuide.mo b/PNlib/UsersGuide/UserGuide.mo
@@ -148,7 +148,7 @@ 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.21.0</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).

diff --git a/PNlib/package.mo b/PNlib/package.mo
@@ -1,6 +1,43 @@
 package PNlib
   annotation(
     uses(Modelica(version = "4.0.0")),
-    version = "3.0.0"
+    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;
diff --git a/README.md b/README.md
@@ -26,6 +26,10 @@ The main package PNlib is divided into the following sub-packages:
     models.
   * _Examples_: contains several examples and unit tests.
 
+## Current release
+
+Download [PNlib v2.2 (2019-10-24)][release-v-2-2]
+
 ## Compatibility
 
   * Coverage with OpenModelica master and latest PNlib release:
@@ -41,12 +45,12 @@ The main package PNlib is divided into the following sub-packages:
 
 ## License
 
-This package is licensed with the [3-Clause BSD License][license-link].
+This package is licensed with the [3-Clause BSD License](./LICENSE).
 
 ## Development and contribution
 
 ```
-Hochschule Bielefeld – University of Applied Sciences and Arts (HSBI)
+Hochschule Bielefeld – University of Applied Sciences and Arts
 Faculty of Engineering and Mathematics
 ```
 
@@ -61,7 +65,8 @@ You may report feedback, issues or feature-requests using
 [test-badge]: https://github.com/AMIT-HSBI/PNlib/actions/workflows/Test.yml/badge.svg
 [test-link]: https://github.com/AMIT-HSBI/PNlib/actions/workflows/Test.yml
 [pnlib-img]: PNlib/Resources/Images/iconsxHPN.png "xHPN: Extended Hybrid PetriNets"
+[release-v-2-2]: https://github.com/AMIT-HSBI/PNlib/releases/tag/v2.2
 [coverage-link]: http://libraries.openmodelica.org/branches/master/PNlib/PNlib.html
-[license-link]: https://github.com/AMIT-HSBI/PNlib/blob/v3.0.0/LICENSE
+[license-link]: https://modelica.org/licenses/ModelicaLicense2
 [issues]: https://github.com/AMIT-HSBI/PNlib/issues
 [gh-pages-link]: https://amit-hsbi.github.io/PNlib/stable/PNlib_master/PNlib_master.html
diff --git a/Testing/Dymola/Makefile b/Testing/Dymola/Makefile
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.Conflict.mos b/Testing/Dymola/PNlib.Examples.ConTest.Conflict.mos
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.ConflictLoop.mos b/Testing/Dymola/PNlib.Examples.ConTest.ConflictLoop.mos
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.LoopAndArcweight.mos b/Testing/Dymola/PNlib.Examples.ConTest.LoopAndArcweight.mos
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.PCtoTC.mos b/Testing/Dymola/PNlib.Examples.ConTest.PCtoTC.mos
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.SinglePC.mos b/Testing/Dymola/PNlib.Examples.ConTest.SinglePC.mos
diff --git a/Testing/Dymola/PNlib.Examples.ConTest.SingleTC.mos b/Testing/Dymola/PNlib.Examples.ConTest.SingleTC.mos