Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.84 KB

README.md

File metadata and controls

64 lines (42 loc) · 2.84 KB

CI general checks Coverage Documentation Status Binder DOI

Logo

pvpumpingsystem

pvpumpingsystem is a package providing tools for modeling and sizing photovoltaic water pumping systems.

Schema of a PV pumping system

It can model the whole functioning of such pumping system on an hourly basis and eventually provide key financial and technical findings on a year. Conversely it can help choose some elements of the pumping station depending on output values wanted (like daily water consumption and acceptable risk of water shortage). Further details are provided on the scope page of the documentation.

Documentation

The full package documentation is available on readthedocs:

pvpumpingsystem docs

Installation

pvpumpingsystem works with Python 3.5 and superior only.

With pip

For a rapid installation with pip, type in a command line interface:

python -m pip install pvpumpingsystem

Consult the docs for more information on installation: https://pvpumpingsystem.readthedocs.io/en/latest/installation.html

Hands-on start

Three examples of how the software can be used are in the folder 'docs/examples'.

For a given system, the first two show how to obtain the outflows, probability of water shortage, life cycle cost and many other results:

Basic usage example

More advanced usage example

The third shows how to optimize the selection of one or more component on the pumping station based on user requirements:

Sizing example

Contributions

All kind of contributions (documentation, testing, bug reports, new features, suggestions...) are highly appreciated. They can be reported as issues, pull requests, or simple message via Github (prefered) or via mail of the maintainer.