https://github.com/hydro-python/hydropowerlib

https://github.com/hydro-python/hydropowerlib

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hydro-python/hydropowerlib
• Owner: hydro-python
• License: gpl-3.0
• Created: 2017-04-10T11:18:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-11T13:26:29.000Z (over 5 years ago)
• Last Synced: 2024-04-14T06:09:14.885Z (7 months ago)
• Language: Python
• Size: 137 KB
• Stars: 11
• Watchers: 4
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - hydropowerlib - Designed to calculate feed-in time series of run-of-the-river hydropower plants. (Renewable Energy / Hydro Energy)

README

        
hydropowerlib

==============

The hydropowerlib is designed to calculate feedin time series of run-of-the-river hydropower plants. The hydropowerlib is an out-take from the 

`feedinlib `_ (hydropower, windpower and pv) to build up a community concentrating on hydropower models.

.. contents:: `Table of contents`

    :depth: 1

    :local:

    :backlinks: top

Introduction

============

Having water flow data sets you can use the hydropowerlib to calculate the electrical output of common hydropower turbines. 

Basic parameters for different types of turbine are provided with the library so that you can start directly using one of these parameter sets. Of course you are free to add your own parameter set.

For a quick start download the example water flow data and basic example file and execute it:

https://github.com/hydro-python/hydropowerlib/tree/master/example

Documentation

==============

Full documentation can be found at `readthedocs `_. Use the project site of readthedocs to choose the version of the documentation. 

Contributing

==============

Clone/Fork: https://github.com/hydro-python/hydropowerlib

If you are interested in hydropower models and want to help improve the existing model do not hesitate to contact us.

As the hydropowerlib started with contributors from the `oemof developer group `_ we use the same 

`developer rules `_.

Installation

============

Install the hydropowerlib using pip3.

::

    pip3 install hydropowerlib

So far, the hydropowerlib is mainly tested on python 3.4 but seems to work down to 2.7.

Please see the `installation page `_ of the oemof documentation for complete instructions on how to install python on your operating system.

  

Optional Packages

~~~~~~~~~~~~~~~~~

To see the plots of the example file you should install the matplotlib package.

Matplotlib can be installed using pip3 but some Linux users reported that it is easier and more stable to use the pre-built packages of your Linux distribution.

http://matplotlib.org/users/installing.html