Skip to content

Commit ceb54d0

Browse files
committed
Added v3.0.1 Release notes and url fixes
1 parent ae90db6 commit ceb54d0

4 files changed

Lines changed: 37 additions & 14 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Project Overview
44
OpenHPL is an open-source **Modelica hydropower library** for modeling hydropower systems of varying complexity. Models range from simple single-component tests to complete hydropower plants with turbines, generators, controllers, and integration with power systems (via OpenIPSL).
55

6-
**Key Repository:** [GitHub - OpenHPL](https://github.com/USN-OpenHPL/OpenHPL)
6+
**Key Repository:** [GitHub - OpenHPL](https://github.com/OpenSimHub/OpenHPL)
77
**Documentation:** User's Guide at `OpenHPL/Resources/Documents/UsersGuide.pdf`
88

99
## Modelica-Specific Conventions

OpenHPL/UsersGuide/ReleaseNotes/package.order

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
v301
12
v300
23
v201
34
v200

OpenHPL/UsersGuide/ReleaseNotes/v300.mo

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,30 @@ Users will have to manually edit their existing models that were based on older
1616
</p>
1717
<h5>💥 Breaking Changes</h5>
1818
<ul>
19-
<li>Merge or consolidate TurbineContact and TurbineContacts2 <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/54\">#54</a></li>
20-
<li>Remove calculated values from Interfaces <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/66\">#66</a></li>
21-
<li>Correct the speed in and outputs of the base class for turbine, generator and grid <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/71\">#71</a></li>
19+
<li>Merge or consolidate TurbineContact and TurbineContacts2 <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/54\">#54</a></li>
20+
<li>Remove calculated values from Interfaces <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/66\">#66</a></li>
21+
<li>Correct the speed in and outputs of the base class for turbine, generator and grid <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/71\">#71</a></li>
2222
</ul>
2323
<h5>🚀 Features</h5>
2424
<ul>
25-
<li>Replaces image with improved SVG version <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/65\">#65</a></li>
26-
<li>Add a valve model <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/59\">#59</a></li>
27-
<li>Implementation of a Tainter Gate <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/60\">#60</a></li>
28-
<li>BaseValve and Turbine update to avoid p_a=0 issues and non-linear closing law <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/70\">#70</a></li>
29-
<li>Change to new defaults for more practical use <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/68\">#68</a></li>
30-
<li>Update handling of diverging or converging pipe <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/69\">#69</a></li>
25+
<li>Replaces image with improved SVG version <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/65\">#65</a></li>
26+
<li>Add a valve model <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/59\">#59</a></li>
27+
<li>Implementation of a Tainter Gate <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/60\">#60</a></li>
28+
<li>BaseValve and Turbine update to avoid p_a=0 issues and non-linear closing law <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/70\">#70</a></li>
29+
<li>Change to new defaults for more practical use <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/68\">#68</a></li>
30+
<li>Update handling of diverging or converging pipe <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/69\">#69</a></li>
3131
</ul>
3232
3333
<h5>🐛 Bug Fixes</h5>
3434
<ul>
35-
<li>Protect Turbine control signal against division by zero error <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/56\">#56</a></li>
35+
<li>Protect Turbine control signal against division by zero error <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/56\">#56</a></li>
3636
</ul>
3737
3838
<h5>New Contributors</h5>
3939
<ul>
40-
<li><a href=\"https://github.com/boerrebj\">@boerrebj</a> in <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/54\">#54</a></li>
41-
<li><a href=\"https://github.com/pandeysudan1\">@pandeysudan1</a> in <a href=\"https://github.com/USN-OpenHPL/OpenHPL/pull/66\">#66</a></li>
40+
<li><a href=\"https://github.com/boerrebj\">@boerrebj</a> in <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/54\">#54</a></li>
41+
<li><a href=\"https://github.com/pandeysudan1\">@pandeysudan1</a> in <a href=\"https://github.com/OpenSimHub/OpenHPL/pull/66\">#66</a></li>
4242
</ul>
43-
<p><strong>Full Changelog:</strong> <a href=\"https://github.com/USN-OpenHPL/OpenHPL/compare/v2.0.1...v3.0.0\">v2.0.1...v3.0.0</a></p>
43+
<p><strong>Full Changelog:</strong> <a href=\"https://github.com/OpenSimHub/OpenHPL/compare/v2.0.1...v3.0.0\">v2.0.1...v3.0.0</a></p>
4444
</html>"));
4545
end v300;
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
within OpenHPL.UsersGuide.ReleaseNotes;
2+
class v301 "Version 3.0.1 (2026-02-05)"
3+
extends Modelica.Icons.ReleaseNotes;
4+
annotation (Documentation(info="<html>
5+
<h4>What&apos;s Changed</h4>
6+
<p>
7+
This version of <code><strong>OpenHPL</strong></code> is
8+
<strong>backwards compatible</strong> with
9+
<a href=\"modelica://OpenHPL.UsersGuide.ReleaseNotes.300\">Version 3.0.0</a>
10+
which contains a series of bug fixes to help with initialisation.
11+
</p>
12+
<h5>🐛 Bug Fixes</h5>
13+
<ul>
14+
<li>Fix for <a href=\"https://github.com/OpenSimHub/OpenHPL/issues/72\">#72</a>: Surgetank allows for negative water levels causing unrealistic results</li>
15+
<li>Fix for <a href=\"https://github.com/OpenSimHub/OpenHPL/issues/73\">#73</a>: Rigid (mechanically) connected turbine and generator will not initialise</li>
16+
<li>Fix for <a href=\"https://github.com/OpenSimHub/OpenHPL/issues/74\">#74</a>: Nominal speed is not linked in turbine and generator model </li>
17+
<li>Update of GitHub links.</li>
18+
</ul>
19+
<h5>Full Changelog</h5>
20+
<p><code><a href=\"https://github.com/OpenSimHub/OpenHPL/compare/v3.0.0...v3.0.1\">v3.0.0...v3.0.1</a></code></p>
21+
</html>"));
22+
end v301;

0 commit comments

Comments
 (0)