Skip to content

Commit 56a2ed6

Browse files
committed
Updates README with library details
Updates the README file to provide a comprehensive description of the OpenHPL library, including its capabilities, components, and integration with other tools. The update offers more detailed information about the library's features and its intended use for modeling hydropower systems.
1 parent 2daef87 commit 56a2ed6

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
# OpenHPL
22

3-
OpenHPL is an open-source hydropower library that consists of hydropower unit models and is modelled using Modelica.
3+
OpenHPL is an open-source **Modelica hydropower library** for modelling hydropower systems of varying complexity, from simple single-component tests to complete hydropower plants with integrated power system controls.
44

55
## Library description
66

7-
The OpenHPL makes it possible to model hydropower systems of different complexity and connect them
8-
with models from other libraries, e.g., with models of the power system or other power generating
9-
sources.
7+
The OpenHPL library provides comprehensive models for:
108

11-
More information about the library can be found in the [User's Guide](OpenHPL/Resources/Documents/UsersGuide.pdf) and the following [PhD Thesis](http://hdl.handle.net/11250/2608105).
9+
- **Hydraulic Components** (`Waterway` package): Penstocks, pipes, reservoirs, surge tanks, open channels, gates, and valves
10+
- **Turbines**: Simple turbine models, Francis turbines, and Pelton turbines with realistic performance characteristics
11+
- **Generators**: Simple generators and synchronous generators for power output modelling
12+
- **Power System Integration**: Grid models with frequency-droop control, seamlessly integrated via OpenIPSL
13+
- **Controllers**: Governor and hydraulic control systems for load governing and system stability
14+
- **Advanced Features**: Elastic penstock modelling using the KP method for pressure transients, discretised flow components for detailed hydraulics
15+
16+
OpenHPL makes it possible to model hydropower systems of different complexity and connect them with models from other libraries, e.g., with models of the power system or other power generating sources. The library is built on Modelica 4.0.0 and integrates with OpenIPSL for power system analysis.
1217

1318
## Current release
1419

1520
Download [OpenHPL v3.0.1 (2026-02-05)](../../releases/tag/v3.0.1)
1621

22+
### Acknowledgements
23+
24+
The very first version 1.0.0 of this library was created as part of the PhD thesis [Vytvytskyi2019](http://hdl.handle.net/11250/2608105), which was supported by the Norwegian Research Council under the project "Hydropower Systems Design and Analysis" (HydroCen Grant No. 257588).
25+
1726
## License
1827

1928
Copyright © 2019-2026

0 commit comments

Comments
 (0)